一、統一異常處理
1、統一異常處理的 2 個注解
系統有一個統一異常處理的功能，可減少重復代碼，又便於維護。用@ControllerAdvice和@ExceptionHandler兩個注解來做異常的統一處理。
@ControllerAdvice：作用於所有@Controller標注的Controller類
@ExceptionHandler：作用於所有@RequestMapping標注的方法拋出的指定類型的異常
2、統一異常處理代碼示例
@Slf4j @ControllerAdvice public class TipControllerAdvice { // 全局異常處理
@ResponseBody @ExceptionHandler(value = Exception.class) public ResponseVo<String> handler(Exception e) { String msg = "系統內部出錯"; log.error(msg, e); return ResponseVo.failure(msg); } // 參數校驗異常異常處理
@ResponseBody @ExceptionHandler(value = ConstraintViolationException.class) public ResponseVo<String> handlerConstraintViolationException(Exception e) { ConstraintViolationException constraintViolationException = (ConstraintViolationException) e; String msg = StringUtils.collectionToCommaDelimitedString( constraintViolationException.getConstraintViolations() .stream() .map(ConstraintViolation::getMessage) .collect(Collectors.toList())); return ResponseVo.failure(msg); } ...... }
二、統一返回值處理
1、@responseBodyAdvice 注解
在大部分前后端分離項目中，后端的返回值基本都需要包裝成一個ResponseVo，其中屬性有code、message、data等，來供前端使用區分。這樣就導致大部分controller寫完后都需要手動構建一個responseVo對象並填充屬性返回，也就造成了大量的重復代碼。
這類代碼其實有很方便的處理方式，就是使用spring提供的注解 responseBodyAdvice，同樣有 responseBodyAdvice，就有 requestBodyAdvice。
requestBodyAdvice —— 請求體的統一處理器，一般用來對請求參數做一些統一的解密等。
responseBodyAdvice —— 響應體的統一處理器，一般用來統一返回值使用。
這里我使用 responseBodyAdvice 這個注解后，在每一個 controller 只需要返回需要的 data 或者 true/false 等，交由spring為我封裝好統一返回值返回給前端。另外還判斷了404的情況，針對前端訪問了一個后端不存在的接口地址，返回提示信息而不是404狀態碼。
2、示例代碼：
/** * 統一響應處理器 * 1 在每個responseBody的響應返回之前進行處理 * 2 全局異常捕捉 統一返回格式 **/ @Slf4j @ControllerAdvice public class TipControllerAdvice implements ResponseBodyAdvice<Object> { private static final Integer STATUS_404 = 404; public static final String ERROR_MSG_404 = "接口地址不存在"; // 決定是否執行beforeBodyWrite()方法 @Override public boolean supports(MethodParameter methodParameter, Class aClass) { return true; } @SneakyThrows @Override public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) { if (o == null) { return ResponseVo.failure(); } //String類型需要特殊處理 手動轉為json字符串
if (o instanceof String) { return JsonUtil.toJson(ResponseVo.success(o)); } if (o instanceof ResponseVo) { return o; } //boolean類型 返回對應的成功或失敗
if (o instanceof Boolean) { return ResponseVo.builder((Boolean) o); } //404時 返回特定信息
if (is404(o)) { return ResponseVo.failure(ERROR_MSG_404); } return ResponseVo.success(o); } // 全局異常處理 @ResponseBody @ExceptionHandler(value = Exception.class) public ResponseVo<String> handler(Exception e) { //default error message
String msg = "系統內部出錯"; log.error(msg, e); return ResponseVo.failure(msg); } // 參數校驗異常異常處理 @ResponseBody @ExceptionHandler(value = ConstraintViolationException.class) public ResponseVo<String> handlerConstraintViolationException(Exception e) { ConstraintViolationException constraintViolationException = (ConstraintViolationException) e; String msg = StringUtils.collectionToCommaDelimitedString( constraintViolationException.getConstraintViolations() .stream() .map(ConstraintViolation::getMessage) .collect(Collectors.toList())); return ResponseVo.failure(msg); } @ResponseBody @ExceptionHandler(value = MethodArgumentNotValidException.class) public ResponseVo<String> handlerMethodArgumentNotValidException(Exception e) { StringBuilder message = new StringBuilder(); MethodArgumentNotValidException exception = (MethodArgumentNotValidException) e; List<ObjectError> errors = exception.getBindingResult().getAllErrors(); for (ObjectError objectError : errors) { if (objectError instanceof FieldError) { FieldError fieldError = (FieldError) objectError; message.append(StrUtil.toUnderlineCase(fieldError.getField())).append(":").append(fieldError.getDefaultMessage()).append(","); } else { message.append(objectError.getDefaultMessage()).append(","); } } return ResponseVo.failure(message.toString()); } @ResponseBody @ExceptionHandler(value = BindException.class) public ResponseVo<String> handlerBindException(Exception e) { BindException bindException = (BindException) e; String msg = StringUtils.collectionToCommaDelimitedString( bindException.getAllErrors() .stream() .map(DefaultMessageSourceResolvable::getDefaultMessage) .collect(Collectors.toList())); return ResponseVo.failure(msg); } @ResponseBody @ExceptionHandler(value = MissingServletRequestParameterException.class) public ResponseVo<String> handlerMissingServletRequestParameterException(Exception e) { return ResponseVo.failure("缺少必填參數"); } @ResponseBody @ExceptionHandler(value = HttpMessageNotReadableException.class) public ResponseVo<String> handlerHttpMessageNotReadableException(Exception e) { return ResponseVo.failure("請求參數異常"); } @ResponseBody @ExceptionHandler(value = ParamErrorException.class) public ResponseVo<String> handlerParamError(Exception e) { if (StrUtil.isBlank(e.getMessage())) { return ResponseVo.failure("參數錯誤"); } else { return ResponseVo.failure(e); } } @ResponseBody @ExceptionHandler(value = TipException.class) public ResponseVo<String> handlerTip(Exception e) { return ResponseVo.failure(e); } private boolean is404(Object o) { if (o instanceof Map) { Map<String, Object> map = Convert.toMap(String.class, Object.class, o); Integer status = Convert.toInt(map.get("status")); return STATUS_404.equals(status); } return false; } }
（1）根據supports方法可以動態決定是否需要執行下面的beforeBodyWrite方法，返回false就不會執行了。
（2）為了滿足有些接口還是會返回responseVo的情況，加了層判斷，若返回的類已經是responseVo了就直接返回，不進行任何包裝。
（3）這里為string類型做了特殊處理，需要手動轉一下json，不然會報錯。
這個情況具體可以看這篇博客：實現ResponseBodyAdvice接口，統一攔截接口返回數據時，controller返回值是String 類型時異常 —— https://blog.csdn.net/lrt890424/article/details/83627554
這里摘錄一下：
3.1、報錯信息：java.lang.ClassCastException: com.lk.face.common.model.ResponseDataVo cannot be cast to java.lang.String
3.2、解決辦法：在ResponseBodyAdvice中對String 類型做單獨判斷
（4）若返回結果為boolean 則交由responseVo的構造方法，可根據業務需要隨意擴展即可。
以上來源於這篇文章的學習：https://cloud.tencent.com/developer/article/1769559