SpringMVC统一异常处理介绍及应用

骑猪看日落 2024-03-24 14:05 41阅读 0赞

#### 3.1 问题描述 ####

在讲解这一部分知识点之前，我们先来演示个效果，修改BookController类的`getById`方法

@GetMapping("/{id}")
    public Result getById(@PathVariable Integer id) {
        
        //手动添加一个错误信息
        if(id==1){
        
            int i = 1/0;
        }
        Book book = bookService.getById(id);
        Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
        String msg = book != null ? "" : "数据查询失败，请重试！";
        return new Result(code,book,msg);
    }

重新启动运行项目，使用PostMan发送请求，当传入的id为1，则会出现如下效果：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-k8Yzybyb-1680512564098)(assets/1630656982337.png)\]][img-k8Yzybyb-1680512564098_assets_1630656982337.png]

前端接收到这个信息后和之前我们约定的格式不一致，这个问题该如何解决?

在解决问题之前，我们先来看下异常的种类及出现异常的原因:

*  框架内部抛出的异常：因使用不合规导致
 *  数据层抛出的异常：因外部服务器故障导致（例如：服务器访问超时）
 *  业务层抛出的异常：因业务逻辑书写错误导致（例如：遍历业务书写操作，导致索引异常等）
 *  表现层抛出的异常：因数据收集、校验等规则导致（例如：不匹配的数据类型间导致异常）
 *  工具类抛出的异常：因工具类书写不严谨不够健壮导致（例如：必要释放的连接长期未释放等）

看完上面这些出现异常的位置，你会发现，在我们开发的任何一个位置都有可能出现异常，而且这些异常是不能避免的。所以我们就得将异常进行处理。

**思考**

1.  各个层级均出现异常，异常处理代码书写在哪一层?
    
    所有的异常均抛出到表现层进行处理
2.  异常的种类很多，表现层如何将所有的异常都处理到呢?
    
    异常分类
3.  表现层处理异常，每个方法中单独书写，代码书写量巨大且意义不强，如何解决?
    
    AOP

对于上面这些问题及解决方案，SpringMVC已经为我们提供了一套解决方案:

*  异常处理器:
    
     *  集中的、统一的处理项目中出现的异常。
        
        ![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3cMBpCGE-1680512564100)(assets/1630657791653.png)\]][img-3cMBpCGE-1680512564100_assets_1630657791653.png]

#### 3.2 异常处理器的使用 ####

##### 3.2.1 环境准备 #####

*  创建一个Web的Maven项目
 *  pom.xml添加SSM整合所需jar包
 *  创建对应的配置类
 *  编写Controller、Service接口、Service实现类、Dao接口和模型类
 *  resources下提供jdbc.properties配置文件

内容参考前面的项目或者直接使用前面的项目进行本节内容的学习。

最终创建好的项目结构如下:

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-dtCsseFB-1680512564101)(assets/1630657972564.png)\]][img-dtCsseFB-1680512564101_assets_1630657972564.png]

##### 3.2.2 使用步骤 #####

###### 步骤1:创建异常处理器类 ######

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
    @RestControllerAdvice
    public class ProjectExceptionAdvice {
        
        //除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
        @ExceptionHandler(Exception.class)
        public void doException(Exception ex){
        
          	System.out.println("嘿嘿,异常你哪里跑！")
        }
    }

确保SpringMvcConfig能够扫描到异常处理器类

###### 步骤2:让程序抛出异常 ######

修改`BookController`的getById方法，添加`int i = 1/0`.

@GetMapping("/{id}")
    public Result getById(@PathVariable Integer id) {
        
      	int i = 1/0;
        Book book = bookService.getById(id);
        Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
        String msg = book != null ? "" : "数据查询失败，请重试！";
        return new Result(code,book,msg);
    }

###### 步骤3:运行程序，测试 ######

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WRiHiZjr-1680512564102)(assets/1630658350945.png)\]][img-WRiHiZjr-1680512564102_assets_1630658350945.png]

说明异常已经被拦截并执行了`doException`方法。

###### 异常处理器类返回结果给前端 ######

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
    @RestControllerAdvice
    public class ProjectExceptionAdvice {
        
        //除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
        @ExceptionHandler(Exception.class)
        public Result doException(Exception ex){
        
          	System.out.println("嘿嘿,异常你哪里跑！")
            return new Result(666,null,"嘿嘿,异常你哪里跑！");
        }
    }

启动运行程序，测试

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5ztV1nGx-1680512564103)(assets/1630658606549.png)\]][img-5ztV1nGx-1680512564103_assets_1630658606549.png]

至此，就算后台执行的过程中抛出异常，最终也能按照我们和前端约定好的格式返回给前端。

##### 知识点1：@RestControllerAdvice #####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@RestControllerAdvice</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>Rest风格开发的控制器增强类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>为Rest风格开发的控制器类做增强</td> 
  </tr> 
 </tbody> 
</table>

\*\*说明:\*\*此注解自带@ResponseBody注解与@Component注解，具备对应的功能

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wrXJIg7i-1680512564104)(assets/1630659060451.png)\]][img-wrXJIg7i-1680512564104_assets_1630659060451.png]

##### 知识点2：@ExceptionHandler #####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@ExceptionHandler</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>专用于异常处理的控制器方法上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置指定异常的处理方案，功能等同于控制器方法，<br>出现异常后终止原始控制器执行,并转入当前方法执行</td> 
  </tr> 
 </tbody> 
</table>

\*\*说明：\*\*此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常

#### 3.3 项目异常处理方案 ####

##### 3.3.1 异常分类 #####

异常处理器我们已经能够使用了，那么在咱们的项目中该如何来处理异常呢?

因为异常的种类有很多，如果每一个异常都对应一个@ExceptionHandler，那得写多少个方法来处理各自的异常，所以我们在处理异常之前，需要对异常进行一个分类:

*  业务异常（BusinessException）
    
     *  规范的用户行为产生的异常
        
         *  用户在页面输入内容的时候未按照指定格式进行数据填写，如在年龄框输入的是字符串
            
            ![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OYkR7rMp-1680512564105)(assets/1630659599983.png)\]][img-OYkR7rMp-1680512564105_assets_1630659599983.png]
     *  不规范的用户行为操作产生的异常
        
         *  如用户故意传递错误数据
            
            ![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-R5LHgNSw-1680512564105)(assets/1630659622958.png)\]][img-R5LHgNSw-1680512564105_assets_1630659622958.png]
 *  系统异常（SystemException）
    
     *  项目运行过程中可预计但无法避免的异常
        
         *  比如数据库或服务器宕机
 *  其他异常（Exception）
    
     *  编程人员未预期到的异常，如:用到的文件不存在
        
        ![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-mtp3ztFA-1680512564106)(assets/1630659690341.png)\]][img-mtp3ztFA-1680512564106_assets_1630659690341.png]

将异常分类以后，针对不同类型的异常，要提供具体的解决方案:

##### 3.3.2 异常解决方案 #####

*  业务异常（BusinessException）
    
     *  发送对应消息传递给用户，提醒规范操作
        
         *  大家常见的就是提示用户名已存在或密码格式不正确等
 *  系统异常（SystemException）
    
     *  发送固定消息传递给用户，安抚用户
        
         *  系统繁忙，请稍后再试
         *  系统正在维护升级，请稍后再试
         *  系统出问题，请联系系统管理员等
     *  发送特定消息给运维人员，提醒维护
        
         *  可以发送短信、邮箱或者是公司内部通信软件
     *  记录日志
        
         *  发消息和记录日志对用户来说是不可见的，属于后台程序
 *  其他异常（Exception）
    
     *  发送固定消息传递给用户，安抚用户
     *  发送特定消息给编程人员，提醒维护（纳入预期范围内）
        
         *  一般是程序没有考虑全，比如未做非空校验等
     *  记录日志

##### 3.3.3 异常解决方案的具体实现 #####

> 思路:
> 
> 1.先通过自定义异常，完成BusinessException和SystemException的定义
> 
> 2.将其他异常包装成自定义异常类型
> 
> 3.在异常处理器类中对不同的异常进行处理

###### 步骤1:自定义异常类 ######

//自定义异常处理器，用于封装异常信息，对异常进行分类
    public class SystemException extends RuntimeException{
        
        private Integer code;
    
        public Integer getCode() {
        
            return code;
        }
    
        public void setCode(Integer code) {
        
            this.code = code;
        }
    
        public SystemException(Integer code, String message) {
        
            super(message);
            this.code = code;
        }
    
        public SystemException(Integer code, String message, Throwable cause) {
        
            super(message, cause);
            this.code = code;
        }
    
    }
    
    //自定义异常处理器，用于封装异常信息，对异常进行分类
    public class BusinessException extends RuntimeException{
        
        private Integer code;
    
        public Integer getCode() {
        
            return code;
        }
    
        public void setCode(Integer code) {
        
            this.code = code;
        }
    
        public BusinessException(Integer code, String message) {
        
            super(message);
            this.code = code;
        }
    
        public BusinessException(Integer code, String message, Throwable cause) {
        
            super(message, cause);
            this.code = code;
        }
    
    }

**说明:**

*  让自定义异常类继承`RuntimeException`的好处是，后期在抛出这两个异常的时候，就不用在try…catch…或throws了
 *  自定义异常类中添加`code`属性的原因是为了更好的区分异常是来自哪个业务的

###### 步骤2:将其他异常包成自定义异常 ######

假如在BookServiceImpl的getById方法抛异常了，该如何来包装呢?

public Book getById(Integer id) {
        
        //模拟业务异常，包装成自定义异常
        if(id == 1){
        
            throw new BusinessException(Code.BUSINESS_ERR,"请不要使用你的技术挑战我的耐性!");
        }
        //模拟系统异常，将可能出现的异常进行包装，转换成自定义异常
        try{
        
            int i = 1/0;
        }catch (Exception e){
        
            throw new SystemException(Code.SYSTEM_TIMEOUT_ERR,"服务器访问超时，请重试!",e);
        }
        return bookDao.getById(id);
    }

具体的包装方式有：

*  方式一:`try{}catch(){}`在catch中重新throw我们自定义异常即可。
 *  方式二:直接throw自定义异常即可

上面为了使`code`看着更专业些，我们在Code类中再新增需要的属性

//状态码
    public class Code {
        
        public static final Integer SAVE_OK = 20011;
        public static final Integer DELETE_OK = 20021;
        public static final Integer UPDATE_OK = 20031;
        public static final Integer GET_OK = 20041;
    
        public static final Integer SAVE_ERR = 20010;
        public static final Integer DELETE_ERR = 20020;
        public static final Integer UPDATE_ERR = 20030;
        public static final Integer GET_ERR = 20040;
        public static final Integer SYSTEM_ERR = 50001;
        public static final Integer SYSTEM_TIMEOUT_ERR = 50002;
        public static final Integer SYSTEM_UNKNOW_ERR = 59999;
    
        public static final Integer BUSINESS_ERR = 60002;
    }

###### 步骤3:处理器类中处理自定义异常 ######

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
    @RestControllerAdvice
    public class ProjectExceptionAdvice {
        
        //@ExceptionHandler用于设置当前处理器类对应的异常类型
        @ExceptionHandler(SystemException.class)
        public Result doSystemException(SystemException ex){
        
            //记录日志
            //发送消息给运维
            //发送邮件给开发人员,ex对象发送给开发人员
            return new Result(ex.getCode(),null,ex.getMessage());
        }
    
        @ExceptionHandler(BusinessException.class)
        public Result doBusinessException(BusinessException ex){
        
            return new Result(ex.getCode(),null,ex.getMessage());
        }
    
        //除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
        @ExceptionHandler(Exception.class)
        public Result doOtherException(Exception ex){
        
            //记录日志
            //发送消息给运维
            //发送邮件给开发人员,ex对象发送给开发人员
            return new Result(Code.SYSTEM_UNKNOW_ERR,null,"系统繁忙，请稍后再试！");
        }
    }

###### 步骤4:运行程序 ######

根据ID查询，

如果传入的参数为1，会报`BusinessException`

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vm59SY6k-1680512564108)(assets/1630661162758.png)\]][img-vm59SY6k-1680512564108_assets_1630661162758.png]

如果传入的是其他参数，会报`SystemException`

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-em0D4BXc-1680512564109)(assets/1630661192383.png)\]][img-em0D4BXc-1680512564109_assets_1630661192383.png]

对于异常我们就已经处理完成了，不管后台哪一层抛出异常，都会以我们与前端约定好的方式进行返回，前端只需要把信息获取到，根据返回的正确与否来展示不同的内容即可。

**小结**

以后项目中的异常处理方式为:

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fdc2V9Yi-1680512564110)(assets/1630658821746.png)\]][img-fdc2V9Yi-1680512564110_assets_1630658821746.png]

[img-k8Yzybyb-1680512564098_assets_1630656982337.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/4ef8a2c03eb04dd68d8f237f54820024.png
[img-3cMBpCGE-1680512564100_assets_1630657791653.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/7b78bd4b68d84d69a243bbd5c59aa95d.png
[img-dtCsseFB-1680512564101_assets_1630657972564.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/b27199ed2e594b5084bf28310716363e.png
[img-WRiHiZjr-1680512564102_assets_1630658350945.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/8d3f5107cac14cb08e03e7fb32b590b6.png
[img-5ztV1nGx-1680512564103_assets_1630658606549.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/d5b157c12a2444a9b52d5ebaf0e20c55.png
[img-wrXJIg7i-1680512564104_assets_1630659060451.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/20a9e7f4df05427981b7abcc043a48eb.png
[img-OYkR7rMp-1680512564105_assets_1630659599983.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/11da8d05ffca4f00a41e805f643a1a79.png
[img-R5LHgNSw-1680512564105_assets_1630659622958.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/94387aebfd23422a9f34525a06759851.png
[img-mtp3ztFA-1680512564106_assets_1630659690341.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/e688ca4a8d974ede8ebdd594728e210c.png
[img-vm59SY6k-1680512564108_assets_1630661162758.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/f501248427f5491fa9427b6c40b234ac.png
[img-em0D4BXc-1680512564109_assets_1630661192383.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/45b7dce6fbd44e6ba969c9a892341f43.png
[img-fdc2V9Yi-1680512564110_assets_1630658821746.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/37afd3a03b9a466f80aae951aa577b09.png