我們一起聊聊 Spring 統一處理異常與響應
作者：了不起
定義統一的異常處理流程，通過@RestControllerAdvice與@ExceptionHandler注解可以對Controller中的異常統一處理。
在web開發中，規范所有請求響應類型，不管是對前端數據處理，還是后端統一數據解析都是非常重要的。今天我們簡單的方式實現如何實現這一效果。
實現方式
- 定義響應類型
public class ResponseResult<T> {
private static final String SUCCESS_CODE = "000";
private static final String FAILURE_CODE = "999";
private String code;
private String message;
private T data;
public static <T> ResponseResult<T> ok(T data){
ResponseResult responseResult = new ResponseResult();
responseResult.setCode(SUCCESS_CODE);
responseResult.setData(data);
return responseResult;
}
public static ResponseResult fail(String code, String message){
if( code == null ){
code = FAILURE_CODE;
}
ResponseResult responseResult = new ResponseResult();
responseResult.setCode(code);
responseResult.setMessage(message);
return responseResult;
}
public static ResponseResult fail(String message){
return fail(FAILURE_CODE, message);
}
}- 定義統一的異常處理流程，通過@RestControllerAdvice與@ExceptionHandler注解可以對Controller中的異常統一處理。
@RestControllerAdvice
public class ControllerAdviceHandle {
@ExceptionHandler(Exception.class)
public ResponseResult handleException(Exception exception) {
BusException busException;
if (exception instanceof BusException asException) {
busException = asException;
} else {
busException = convertException(exception);
}
return ResponseResult.fail(busException.getCode(), busException.getMessage());
}
}- 定義統一響應攔截，通過是實現接口ResponseBodyAdvice，這里可以和上面的異常一起處理。
public class ControllerAdviceHandle implements ResponseBodyAdvice {
@Override
public boolean supports(MethodParameter returnType, Class converterType) {
return true;
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType,
ServerHttpRequest request, ServerHttpResponse response) {
if( body instanceof ResponseResult){
return body;
}
return ResponseResult.ok(body);
}
}- 定義spring配置，實現自動裝配
在resource目錄添加自動注入配置META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports，這樣通過引入jar就可以自動使用該配置。
cn.cycad.web.response.ResponseConfig應用示例
- 比如現在有一個User實體，我們通過繼承基類。
@RestController
@RequestMapping("/test")
public class TestController {
@GetMapping("/{val}")
public Object get(@PathVariable("val") String val) throws BusException {
if( "1".equals(val) ){
throw new BusException("參數錯誤");
}
return Map.of("val",val);
}
}- 通過調用請求，可以看到不管是否異常，結果都是下面的格式。
{
"code": "999",
"message": null,
"data": null
}責任編輯：武曉燕
來源：
Java技術指北
