SpringBoot异常统一处理
本文基于SpringBoot使用@RestControllerAdvice无侵入返回统一结果包装ResultJson.java对象在上文中已经创建，这里不再赘述。
上面我们我们介绍了统一返回格式，如果程序抛异常了，我们是否也可以返回统一的格式呢？
答案是，当然可以的，不光可以抛出我们想要的格式，还可以对指定的异常类型进行特殊处理
例如使用@Validated对入参校验的异常，我们自定义的异常等等
未处理的返回情况
首先我们模拟一个异常的场景，代码如下：
package com.maple.controller; import lombok.Data; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; /** * @author 笑小枫 * @date 2021/12/7 */ @RestController @RequiredArgsConstructor @RequestMapping("/example") public class TestErrorResultController { @GetMapping("/testResultError") public Test testResultError() { Test test = null; test.setName("简单点，抛个空指针吧"); return test; } @Data static class Test { private String name; private Integer age; private String remark; } }
我们先看看这是调用返回的结果，可以看到，由于我们对结果进行了统一封装，将错误信息放到了data里面。 但显然，status显示true，后台都空指针了，这显然不是我们想要的结果。
{ "status": true, "code": "0000", "msg": "", "data": { "timestamp": "2021-12-22T06:24:19.332+00:00", "status": 500, "error": "Internal Server Error", "message": "", "path": "/testResultError" } }
贴一下控制台错误信息
笑小枫控制台- 2021-12-22 14:25:38 [http-nio-6666-exec-1] ERROR org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/].[dispatcherServlet] - Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.NullPointerException] with root cause java.lang.NullPointerException: null at com.maple.controller.TestResultController.testResultError(TestResultController.java:19) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:498) ...
统一异常处理配置
接下来我们开始表演，创建一个配置类，配置一下对异常拦截处理，代码如下：
package com.maple.config; import com.maple.config.exception.ErrorCode; import com.maple.model.ResultJson; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; /** * 异常信息统一处理 * * @author 笑小枫 * @date 2021/12/20 */ @Slf4j @RestControllerAdvice public class ExceptionAdvice { /** * 系统异常. * * @param e 异常信息 * @return R */ @ExceptionHandler(Exception.class) public ResultJson exception(Exception e) { log.error("系统异常信息 ex={}", e.getMessage(), e); // 未知异常统一抛出9999 return new ResultJson(ErrorCode.OTHER_ERROR.getCode(), ErrorCode.OTHER_ERROR.getMsg()); } }
这里使用了一个异常编码的枚举类ErrorCode.java，代码如下：
package com.maple.config.exception; import lombok.AllArgsConstructor; import lombok.Getter; /** * 统一异常信息枚举类 * * @author 笑小枫 * @date 2021/12/9 */ @AllArgsConstructor @Getter public enum ErrorCode { /** * 异常信息 */ PARAM_ERROR("9001", "请求参数有误，请重试"), /** * 抛出此异常码，请重新在ErrorMsg定义msg */ COMMON_ERROR("9998", "笑小枫太懒，居然没有定义异常原因"), OTHER_ERROR("9999", "未知异常，请联系笑小枫"); private final String code; private final String msg; }
我们再看一下这个时候返回的结果，显然，这个结果我们就可以接受了。程序中尽量避免出现空指针哈，这里只是模拟>_<…
{ "status": false, "code": "9999", "msg": "未知异常，请联系笑小枫", "data": null }
自定义异常的处理
刚刚对统一异常做了处理，那像我们自定义的异常怎么处理呢
首先我们创建一个自定义异常，这里建议先创建一个BaseException的自定义异常，然后不同的小类的异常再继承BaseException异常。 这样我们可以直接拦截BaseException异常就可以了。
BaseException异常这里取名为MapleBaseException.java，代码如下：
package com.maple.config.exception; import lombok.Data; import lombok.EqualsAndHashCode; /** * 自定义异常-Base父类，细化的自定义异常，应该继承此类 * 统一异常处理时，会根据此异常类型做判断，返回结果时，如果是自定义异常自动解析code和errorMsg返回 * * @author 笑小枫 * @date 2021/12/8 */ @EqualsAndHashCode(callSuper = true) @Data public class MapleBaseException extends RuntimeException { private final String code; private final String errorMsg; public MapleBaseException(String code, String errorMsg) { super(errorMsg); this.code = code; this.errorMsg = errorMsg; } public MapleBaseException(ErrorCode code) { super(code.getMsg()); this.code = code.getCode(); this.errorMsg = code.getMsg(); } public MapleBaseException(ErrorCode code, String errorMsg) { super(errorMsg); this.code = code.getCode(); this.errorMsg = errorMsg; } }
然后再定义一个校验的自定义异常，代码如下：
package com.maple.config.exception; /** * 检测结果不一致时，抛出此异常 * * @author 笑小枫 * @date 2021/12/8 */ public class MapleCheckException extends MapleBaseException { public MapleCheckException(String code, String errorMsg) { super(code, errorMsg); } public MapleCheckException(ErrorCode code) { super(code); } public MapleCheckException(ErrorCode code, String errorMsg) { super(code, errorMsg); } }
调整一下我们的异常拦截配置类，代码如下：
注意Exception异常拦截上面的@Order(99)，因为我们自定义异常也属于Exception异常，所以使用Order执行时往后排。
package com.maple.config; import com.maple.config.exception.ErrorCode; import com.maple.config.exception.MapleBaseException; import com.maple.model.ResultJson; import lombok.extern.slf4j.Slf4j; import org.springframework.core.annotation.Order; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; /** * 异常信息统一处理 * * @author 笑小枫 * @date 2021/12/20 */ @Slf4j @RestControllerAdvice public class ExceptionAdvice { /** * 自定义异常处理 * * @param e 异常信息 * @return 返回结果 */ @ExceptionHandler(MapleBaseException.class) public ResultJson mapleBaseException(MapleBaseException e) { log.error("自定义异常信息 ex={}", e.getMessage(), e); return new ResultJson(e.getCode(), e.getErrorMsg()); } /** * 系统异常. * * @param e 异常信息 * @return R */ @ExceptionHandler(Exception.class) @Order(99) public ResultJson exception(Exception e) { log.error("系统异常信息 ex={}", e.getMessage(), e); // 未知异常统一抛出9999 return new ResultJson(ErrorCode.OTHER_ERROR.getCode(), ErrorCode.OTHER_ERROR.getMsg()); } }
我们再模拟一下抛出自定义异常，代码如下：
package com.maple.controller; import com.maple.config.exception.ErrorCode; import com.maple.config.exception.MapleCheckException; import lombok.Data; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; /** * @author 笑小枫 * @date 2021/12/7 */ @RestController @RequiredArgsConstructor @RequestMapping("/example") public class TestResultController { @GetMapping("/testMapleError") public Test testMapleError() { Test test = new Test(); test.setName("笑小枫"); if (test.getAge() == null) { throw new MapleCheckException(ErrorCode.COMMON_ERROR); } return test; } @Data static class Test { private String name; private Integer age; private String remark; } }
最后，我们来看一下结果
{ "status": false, "code": "9998", "msg": "笑小枫太懒，居然没有定义异常原因", "data": null }
贴一下控制台异常信息
笑小枫控制台- 2021-12-22 14:38:26 [http-nio-6666-exec-2] ERROR com.maple.config.ExceptionAdvice - 自定义异常信息 ex=笑小枫太懒，居然没有定义异常原因 com.maple.config.exception.MapleCheckException: 笑小枫太懒，居然没有定义异常原因 at com.maple.controller.TestResultController.testResultError(TestResultController.java:23) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:498) ...
@Validated对入参校验的异常处理
上面的说的@Validated对入参校验的异常处理，这里简单贴一下代码，不做详细概述。系统抛出异常格式太丑，这里做了简单优化.
package com.maple.config; import com.maple.config.exception.ErrorCode; import com.maple.config.exception.MapleBaseException; import com.maple.model.ResultJson; import lombok.extern.slf4j.Slf4j; import org.springframework.core.annotation.Order; import org.springframework.validation.BindException; import org.springframework.validation.BindingResult; import org.springframework.validation.FieldError; import org.springframework.validation.ObjectError; import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; import java.util.List; /** * 异常信息统一处理 * * @author 笑小枫 * @date 2021/12/20 */ @Slf4j @RestControllerAdvice public class ExceptionAdvice { /** * 自定义异常处理 * * @param e 异常信息 * @return 返回结果 */ @ExceptionHandler(MapleBaseException.class) public ResultJson mapleBaseException(MapleBaseException e) { log.error("自定义异常信息 ex={}", e.getMessage(), e); return new ResultJson(e.getCode(), e.getErrorMsg()); } /** * 参数校验异常处理 * * @param e 异常信息 * @return 返回结果 */ @ExceptionHandler(value = {BindException.class, MethodArgumentNotValidException.class}) public ResultJson validException(MethodArgumentNotValidException e) { log.error("参数校验异常信息 ex={}", e.getMessage(), e); BindingResult result = e.getBindingResult(); StringBuilder stringBuilder = new StringBuilder(); if (result.hasErrors()) { List<ObjectError> errors = result.getAllErrors(); errors.forEach(p -> { FieldError fieldError = (FieldError) p; stringBuilder.append(fieldError.getDefaultMessage()); }); } return new ResultJson(ErrorCode.PARAM_ERROR.getCode(), stringBuilder.toString()); } /** * 系统异常. * * @param e 异常信息 * @return R */ @ExceptionHandler(Exception.class) @Order(99) public ResultJson exception(Exception e) { log.error("系统异常信息 ex={}", e.getMessage(), e); // 未知异常统一抛出9999 return new ResultJson(ErrorCode.OTHER_ERROR.getCode(), ErrorCode.OTHER_ERROR.getMsg()); } }
关于笑小枫
本章到这里结束了，喜欢的朋友关注一下我呦，大伙的支持，就是我坚持写下去的动力。
老规矩，懂了就点赞收藏；不懂就问，日常在线，我会就会回复哈~
后续文章会陆续更新，文档会同步在CSDN和GitHub保持同步更新。
