SpringBoot实现统一异常处理

目录

• 前言
  
• 实现步骤
  
  
  
  • 定义统一响应对象类
    
  • 定义业务异常枚举接口和实现
    
  • 定义业务异常基类
    
  • 定义全局异常处理切面
    
  • 测试和验证
    
  
  
• 总结
  

前言

近日心血来潮想做一个开源项目，目标是做一款可以适配多端、功能完备的模板工程，包含后台管理系统和前台系统，开发者基于此项目进行裁剪和扩展来完成自己的功能开发。本项目为前后端分离开发，后端基于Java21和SpringBoot3开发，后端使用Spring Security、JWT、Spring Data JPA等技术栈，前端提供了vue、angular、react、uniapp、微信小程序等多种脚手架工程。
项目地址：https://gitee.com/breezefaith/fast-alden
在前后端分离的项目开发过程中，我们通常会对数据返回格式进行统一的处理，这样可以方便前端人员取数据，后端发生异常时同样会使用此格式将异常信息返回给前端。本文将介绍在SpringBoot项目中如何实现统一异常处理。
实现步骤

定义统一响应对象类

1. /**
2. * 响应结果类
3. *
4. * @param <T> 任意类型
5. */
6. @Data
7. public class ResponseResult<T> {
8.     /**
9.      * 响应状态码，200是正常，非200表示异常
10.      */
11.     private int status;
12.     /**
13.      * 异常编号
14.      */
15.     private String errorCode;
16.     /**
17.      * 异常信息
18.      */
19.     private String message;
20.     /**
21.      * 响应数据
22.      */
23.     private T data;
25.     public static <T> ResponseResult<T> success() {
26.         return success(HttpServletResponse.SC_OK, null, null);
27.     }
29.     public static <T> ResponseResult<T> success(T data) {
30.         return success(HttpServletResponse.SC_OK, null, data);
31.     }
33.     public static <T> ResponseResult<T> fail(String message) {
34.         return fail(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, null, message, null);
35.     }
37.     public static <T> ResponseResult<T> fail(String errorCode, String message) {
38.         return fail(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, errorCode, message, null);
39.     }
41.     public static <T> ResponseResult<T> success(int status, String message, T data) {
42.         ResponseResult<T> r = new ResponseResult<>();
43.         r.setStatus(status);
44.         r.setMessage(message);
45.         r.setData(data);
47.         return r;
48.     }
50.     public static <T> ResponseResult<T> fail(int status, String errorCode, String message) {
51.         return fail(status, errorCode, message, null);
52.     }
54.     public static <T> ResponseResult<T> fail(int status, String errorCode, String message, T data) {
55.         ResponseResult<T> r = new ResponseResult<>();
56.         r.setStatus(status);
57.         r.setErrorCode(errorCode);
58.         r.setMessage(message);
59.         r.setData(data);
60.         return r;
61.     }
63. }

复制代码

定义业务异常枚举接口和实现

通常一个系统中的自定义业务异常是可穷举的，可以考虑通过定义枚举的方式来列举所有的业务异常。
首先我们来定义一个异常信息枚举的基类接口。

1. public interface IBizExceptionEnum {
2.     String getCode();
4.     String getMessage();
5. }

复制代码

再给出一个常用的异常信息的枚举类，如果有其他业务模块的异常信息，同样可以通过实现IBizExceptionEnum接口来进行定义。

1. @Getter
2. public enum BizExceptionEnum implements IBizExceptionEnum {
3.     ENTITY_IS_NULL("Base_Entity_Exception_0001", "实体为空"),
4.     ENTITY_ID_IS_NULL("Base_Entity_Exception_0002", "实体id字段为空"),
5.     ENTITY_ID_IS_DUPLCATED("Base_Entity_Exception_0003", "实体id字段%s重复");
7.     private final String code;
8.     private final String message;
10.     BizExceptionEnum(String code, String message) {
11.         this.code = code;
12.         this.message = message;
13.     }
14. }

复制代码

定义业务异常基类

业务异常基类BizException继承自RuntimeException，代码中主动抛出的异常建议都包装为该类的实例。

1. /**
2. * 业务异常基类，支持参数化的异常信息
3. */
4. @Getter
5. @Setter
6. public class BizException extends RuntimeException {
7.     private String code;
8.     private Object[] args;
10.     public BizException() {
11.         super();
12.     }
14.     public BizException(String message) {
15.         super(message);
16.     }
18.     public BizException(Throwable cause) {
19.         super(cause);
20.     }
22.     public BizException(String message, Throwable cause) {
23.         super(message, cause);
24.     }
26.     public BizException(Throwable cause, String code, String message, Object... args) {
27.         super(message, cause);
28.         this.code = code;
29.         this.args = args;
30.     }
32.     public BizException(String code, String message, Object... args) {
33.         super(message);
34.         this.code = code;
35.         this.args = args;
36.     }
38.     public BizException(IBizExceptionEnum exceptionEnum, Object... args) {
39.         this(exceptionEnum.getCode(), exceptionEnum.getMessage(), args);
40.     }
42.     public BizException(Throwable cause, IBizExceptionEnum exceptionEnum, Object... args) {
43.         this(cause, exceptionEnum.getCode(), exceptionEnum.getMessage(), args);
44.     }
46.     @Override
47.     public String getMessage() {
48.         if (code != null) {
49.             if (args != null && args.length > 0) {
50.                 return String.format(super.getMessage(), args);
51.             }
52.         }
53.         return super.getMessage();
54.     }
55. }

复制代码

定义全局异常处理切面

本步骤需要使用@RestControllerAdvice注解，它是一个组合注解，由@ControllerAdvice、@ResponseBody组成，而@ControllerAdvice继承了@Component，因此@RestControllerAdvice本质上是个Component，用于定义@ExceptionHandler，@InitBinder和@ModelAttribute方法，适用于所有使用@RequestMapping方法。
还要用到@ExceptionHandler注解，可以认为它是一个异常拦截器，它采用“就近原则”，存在多个满足条件的异常处理器时会选择最接近的一个来使用。它本质上就是使用Spring AOP定义的一个切面，在系统抛出异常后执行。
具体实现代码如下：

1. /**
2. * 全局异常处理切面
3. */
4. @RestControllerAdvice
5. public class GlobalExceptionHandlerAdvice {
6.     private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandlerAdvice.class);
8.     @ExceptionHandler({BizException.class})
9.     public ResponseResult<Object> handleBizException(BizException e, HttpServletRequest request, HttpServletResponse response) {
10.         log.error(e.getCode() + ": " + e.getMessage(), e);
11.         response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
12.         return ResponseResult.fail(e.getCode(), e.getMessage());
13.     }
15.     @ExceptionHandler({RuntimeException.class, Exception.class})
16.     public ResponseResult<Object> handleRuntimeException(Exception e, HttpServletRequest request, HttpServletResponse response) {
17.         log.error(e.getMessage(), e);
18.         response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
19.         return ResponseResult.fail(e.getMessage());
20.     }
21. }

复制代码

上述代码会对系统中抛出的BizException、RuntimeException和Exception对象进行处理，把异常包装为ResponseResult对象后将异常编号和异常信息返回给前端。
测试和验证

下面我们就可以定义一个Controller类来进行简单的测试。

1. @RestController
2. @RequestMapping("/demo")
3. public class DemoController {
4.     @GetMapping("/method1")
5.     public ResponseResult<Integer> method1() {
6.         throw new BizException(BizExceptionEnum.ENTITY_IS_NULL);
7.     }
9.     @GetMapping("/method2")
10.     public void method2() {
11.         throw new BizException(BizExceptionEnum.ENTITY_ID_IS_NULL);
12.     }
14.     @GetMapping(value = "/method3")
15.     public String method3() {
16.         throw new BizException(BizExceptionEnum.ENTITY_ID_IS_DUPLCATED, "1");
17.     }
19.     @GetMapping(value = "/method4")
20.     public String method4() {
21.         // 抛出ArithmeticException异常
22.         return String.valueOf(1 / 0);
23.     }
24. }

复制代码

总结

本文介绍了如何在SpringBoot项目中实现统一异常处理，如有错误，还望批评指正。
在后续实践中我也是及时更新自己的学习心得和经验总结，希望与诸位看官一起进步。
出处：https://www.cnblogs.com/breezefaith/p/18006315本文版权归作者和博客园共有，欢迎转载，但必须给出原文链接，并保留此段声明，否则保留追究法律责任的权利。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！