場(chǎng)景
在編寫(xiě)Controller接口時(shí)，為避免接口因?yàn)槲粗漠惓?dǎo)致返回不友好的結(jié)果和提示。
如果不進(jìn)行全局異常捕獲則需要對(duì)每個(gè)接口進(jìn)行try-catch或其他操作。
?
可以對(duì)Controller進(jìn)行全局的異常捕獲和處理，一旦發(fā)生異常，則返回通用的500響應(yīng)碼與通用錯(cuò)誤提示。
并將異常發(fā)生的具體的文件、類、方法、行數(shù)信息記錄到日志。
@ControllerAdvice，是Spring3.2提供的新注解,它是一個(gè)Controller增強(qiáng)器,
可對(duì)controller中被 @RequestMapping注解的方法加一些邏輯處理。最常用的就是異常處理。
需要配合@ExceptionHandler使用。當(dāng)將異常拋到controller時(shí),可以對(duì)異常進(jìn)行統(tǒng)一處理。
注：
博客：
霸道流氓氣質(zhì)的博客_CSDN博客-C#,架構(gòu)之路,SpringBoot領(lǐng)域博主
實(shí)現(xiàn)
1、@RestControlAdvice是組合注解，由@ControllerAdvice和@ResponseBody組成。
?
@ControllerAdvice 提供了多種指定Advice規(guī)則的定義方式，默認(rèn)什么都不寫(xiě)，則是Advice所有Controller，
?文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-445640.html
當(dāng)然你也可以通過(guò)下列的方式指定規(guī)則。
通過(guò)basePackages指定只對(duì)哪些包路徑下生效。
也可以通過(guò)指定注解來(lái)匹配，比如我自定了一個(gè) @CustomAnnotation 注解，
我想匹配所有被這個(gè)注解修飾的 Controller, 可以這么寫(xiě)：@ControllerAdvice（annotations= {CustomAnnotation.class})
這里不做任何規(guī)則限制，對(duì)所有的controller生效。
2、新建全局異常捕獲類，注意與啟動(dòng)類在同包路徑下，不然不生效需要在啟動(dòng)類中指定包路徑。
import com.badao.demo.common.AjaxResult;
import com.badao.demo.constant.Constants;
import com.badao.demo.constant.HttpStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//注意引入包的路徑
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler
{
??? private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
??? @ExceptionHandler(Exception.class)
??? public AjaxResult handleException(Exception e)
??? {
??????? StackTraceElement stackTrace = e.getStackTrace()[0];
??????? String methodName = stackTrace.getMethodName();
??????? String fileName = stackTrace.getFileName();
??????? String className = stackTrace.getClassName();
??????? int lineNumber = stackTrace.getLineNumber();
??????? log.error("異常發(fā)生在文件{}的類{}中的方法{}的第{}行'，異常信息:{}", fileName,className,methodName,lineNumber,e.getMessage());
??????? return AjaxResult.error(HttpStatus.ERROR, Constants.SERVER_ERROR);
??? }
}這里使用@ExceptionHandler(Exception.class)
對(duì)所有的Exception進(jìn)行捕獲，然后統(tǒng)一返回封裝的AjaxResult結(jié)果類
import com.badao.demo.constant.HttpStatus;
import com.badao.demo.utils.StringUtils;
import java.util.HashMap;
/**
?* 操作消息提醒
?*
?*/
public class AjaxResult extends HashMap<String, Object>
{
??? private static final long serialVersionUID = 1L;
??? /** 狀態(tài)碼 */
??? public static final String CODE_TAG = "code";
??? /** 返回內(nèi)容 */
??? public static final String MSG_TAG = "msg";
??? /** 數(shù)據(jù)對(duì)象 */
??? public static final String DATA_TAG = "data";
??? /**
???? * 初始化一個(gè)新創(chuàng)建的 AjaxResult 對(duì)象，使其表示一個(gè)空消息。
???? */
??? public AjaxResult()
??? {
??? }
??? /**
???? * 初始化一個(gè)新創(chuàng)建的 AjaxResult 對(duì)象
???? *
???? * @param code 狀態(tài)碼
???? * @param msg 返回內(nèi)容
???? */
??? public AjaxResult(int code, String msg)
??? {
??????? super.put(CODE_TAG, code);
??????? super.put(MSG_TAG, msg);
??? }
??? /**
???? * 初始化一個(gè)新創(chuàng)建的 AjaxResult 對(duì)象
???? *
???? * @param code 狀態(tài)碼
???? * @param msg 返回內(nèi)容
???? * @param data 數(shù)據(jù)對(duì)象
???? */
??? public AjaxResult(int code, String msg, Object data)
??? {
??????? super.put(CODE_TAG, code);
??????? super.put(MSG_TAG, msg);
??????? if (StringUtils.isNotNull(data))
??????? {
??????????? super.put(DATA_TAG, data);
??????? }
??? }
??? /**
???? * 返回成功消息
???? *
???? * @return 成功消息
???? */
??? public static AjaxResult success()
??? {
??????? return AjaxResult.success("操作成功");
??? }
??? /**
???? * 返回成功數(shù)據(jù)
???? *
???? * @return 成功消息
???? */
??? public static AjaxResult success(Object data)
??? {
??????? return AjaxResult.success("操作成功", data);
??? }
??? /**
???? * 返回成功消息
???? *
???? * @param msg 返回內(nèi)容
???? * @return 成功消息
???? */
??? public static AjaxResult success(String msg)
??? {
??????? return AjaxResult.success(msg, null);
??? }
??? /**
???? * 返回成功消息
???? *
???? * @param msg 返回內(nèi)容
???? * @param data 數(shù)據(jù)對(duì)象
???? * @return 成功消息
???? */
??? public static AjaxResult success(String msg, Object data)
??? {
??????? return new AjaxResult(HttpStatus.SUCCESS, msg, data);
??? }
??? /**
???? * 返回錯(cuò)誤消息
???? *
???? * @return
???? */
??? public static AjaxResult error()
??? {
??????? return AjaxResult.error("操作失敗");
??? }
??? /**
???? * 返回錯(cuò)誤消息
???? *
???? * @param msg 返回內(nèi)容
???? * @return 警告消息
???? */
??? public static AjaxResult error(String msg)
??? {
??????? return AjaxResult.error(msg, null);
??? }
??? /**
???? * 返回錯(cuò)誤消息
???? *
???? * @param msg 返回內(nèi)容
???? * @param data 數(shù)據(jù)對(duì)象
???? * @return 警告消息
???? */
??? public static AjaxResult error(String msg, Object data)
??? {
??????? return new AjaxResult(HttpStatus.ERROR, msg, data);
??? }
??? /**
???? * 返回錯(cuò)誤消息
???? *
???? * @param code 狀態(tài)碼
???? * @param msg 返回內(nèi)容
???? * @return 警告消息
???? */
??? public static AjaxResult error(int code, String msg)
??? {
??????? return new AjaxResult(code, msg, null);
??? }
}然后狀態(tài)碼和提示消息是封裝的常量類
狀態(tài)碼常量類
public class HttpStatus
{
??? /**
???? * 操作成功
???? */
??? public static final int SUCCESS = 200;
??? /**
???? * 對(duì)象創(chuàng)建成功
???? */
??? public static final int CREATED = 201;
??? /**
???? * 請(qǐng)求已經(jīng)被接受
???? */
??? public static final int ACCEPTED = 202;
??? /**
???? * 操作已經(jīng)執(zhí)行成功，但是沒(méi)有返回?cái)?shù)據(jù)
???? */
??? public static final int NO_CONTENT = 204;
??? /**
???? * 資源已被移除
???? */
??? public static final int MOVED_PERM = 301;
??? /**
???? * 重定向
???? */
??? public static final int SEE_OTHER = 303;
??? /**
???? * 資源沒(méi)有被修改
???? */
??? public static final int NOT_MODIFIED = 304;
??? /**
???? * 參數(shù)列表錯(cuò)誤（缺少，格式不匹配）
???? */
??? public static final int BAD_REQUEST = 400;
??? /**
???? * 未授權(quán)
???? */
??? public static final int UNAUTHORIZED = 401;
??? /**
???? * 訪問(wèn)受限，授權(quán)過(guò)期
???? */
??? public static final int FORBIDDEN = 403;
??? /**
???? * 資源，服務(wù)未找到
???? */
??? public static final int NOT_FOUND = 404;
??? /**
???? * 不允許的http方法
???? */
??? public static final int BAD_METHOD = 405;
??? /**
???? * 資源沖突，或者資源被鎖
???? */
??? public static final int CONFLICT = 409;
??? /**
???? * 不支持的數(shù)據(jù)，媒體類型
???? */
??? public static final int UNSUPPORTED_TYPE = 415;
??? /**
???? * 系統(tǒng)內(nèi)部錯(cuò)誤
???? */
??? public static final int ERROR = 500;
??? /**
???? * 接口未實(shí)現(xiàn)
???? */
??? public static final int NOT_IMPLEMENTED = 501;
}消息常量類
public class Constants {
??? //請(qǐng)求響應(yīng)常量
??? public static final String NO_API_CODE = "請(qǐng)求碼不能為空";
??? public static final String ILLEGAL_API_CODE = "請(qǐng)求碼不存在";
??? public static final String SERVER_ERROR = "服務(wù)器內(nèi)部錯(cuò)誤，請(qǐng)聯(lián)系管理員!";
??? public static final String CALL_TOO_OFEN = "請(qǐng)求太頻繁";
}然后將異常發(fā)生的具體信息記錄到日志中，異常的信息來(lái)源可以打斷點(diǎn)獲取和自定義需要獲取的內(nèi)容
?
2、這里是對(duì)Exception類型進(jìn)行通配，如果需要對(duì)指定的異常類型或者自定義類型就行捕獲，還可以
import com.badao.demo.common.AjaxResult;
import com.badao.demo.constant.Constants;
import com.badao.demo.constant.HttpStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//注意引入包的路徑
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler
{
??? private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
??? @ExceptionHandler(Exception.class)
??? public AjaxResult handleException(Exception e)
??? {
??????? StackTraceElement stackTrace = e.getStackTrace()[0];
??????? String methodName = stackTrace.getMethodName();
??????? String fileName = stackTrace.getFileName();
??????? String className = stackTrace.getClassName();
??????? int lineNumber = stackTrace.getLineNumber();
??????? log.error("異常發(fā)生在文件{}的類{}中的方法{}的第{}行'，異常信息:{}", fileName,className,methodName,lineNumber,e.getMessage());
??????? return AjaxResult.error(HttpStatus.ERROR, Constants.SERVER_ERROR);
??? }
??? /**
???? * 自定義驗(yàn)證異常
???? */
??? @ExceptionHandler(BindException.class)
??? public AjaxResult handleBindException(BindException e) {
??????? log.error(e.getMessage(), e);
??????? String message = e.getAllErrors().get(0).getDefaultMessage();
??????? return AjaxResult.error(HttpStatus.BAD_REQUEST, message);
??? }
??? /**
???? * 自定義驗(yàn)證異常
???? */
??? @ExceptionHandler(MethodArgumentNotValidException.class)
??? public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
??? {
??????? log.error(e.getMessage(), e);
??????? String message = e.getBindingResult().getFieldError().getDefaultMessage();
??????? return AjaxResult.error(message);
??? }
}這里注意引入包的路徑，不然會(huì)出現(xiàn)不生效的情況。
這塊還可參考
SpringBoot+@Validate+全局異常攔截實(shí)現(xiàn)自定義規(guī)則參數(shù)校驗(yàn)(校驗(yàn)get請(qǐng)求參數(shù)不能為空且在指定枚舉類型中)：
SpringBoot+@Validate+全局異常攔截實(shí)現(xiàn)自定義規(guī)則參數(shù)校驗(yàn)(校驗(yàn)get請(qǐng)求參數(shù)不能為空且在指定枚舉類型中)_霸道流氓氣質(zhì)的博客-CSDN博客
3、測(cè)試效果
手動(dòng)編寫(xiě)一個(gè)除零異常并將controller中的try-catch去掉
?
接口統(tǒng)一響應(yīng)，在日志中記錄到具體信息
文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-445640.html
?
到了這里，關(guān)于SpringBoot中@ControllerAdvice/@RestControlAdvice+@ExceptionHandler實(shí)現(xiàn)全局異常捕獲與處理的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
