springboot整合之统一异常处理

特别说明：本次项目整合基于idea进行的，如果使用Eclipse可能操作会略有不同，不过总的来说不影响。

springboot整合之如何选择版本及项目搭建

springboot整合之版本号统一管理 

springboot整合mybatis-plus+durid数据库连接池

springboot整合swagger

springboot整合mybatis代码快速生成

springboot整合之统一结果返回

springboot整合之统一异常处理

springboot整合之Validated参数校验 

springboot整合之logback日志配置

springboot整合pagehelper分页

springboot整合本地缓存

springboot整合redis + redisson

springboot整合elasticsearch

springboot整合rabbitMq

springboot整合canal实现缓存一致性

springboot整合springSecurity(前后端不分离版本)

一、为什么要进行统一异常处理

首先我们来看一下，如果不对异常进行处理会发生什么问题，我们来修改一下测试接口。我们假设运行过程中接口发生了异常，来看一下接口调用会发生什么问题。

 启动后测试返回结果如下：？？？这是啥？我们的统一结果返回呢？

 所以这就是为什么我们要对异常进行统一处理的原因了。如果发生了异常我们应该让接口也返回统一的结果。有好的展示给接口调用方。

除了上面的接口统一返回其实异常的拦截也方便我们对异常进行记录，和错误排查。

还有就是有时候我们可能对某些异常比较关注，比如说我们监控某个IP或者用户一天发送短信的数量，当超出一定数量后我们就不再发送然后抛出异常。这个时候我们通过统一异常处理进行全局拦截，然后记录日志甚至是数据库，并且发送短信通知相关负责人。

二、springboot如何处理异常

通过第一步我们可以看出来，我们需要对系统中一些未知的异常进行处理。达到给接口调用方展示有好返回结果的目的，也就是按照我们定义好的返回结果统一的返回。那么在springboot中是如何对异常进行处理的呢？

在springboot中处理异常可以有多种方式，我们这里选择使用相对比较优雅切简单的一种来实现。那就是使用@ControllerAdvice + @ExceptionHandler来进行异常处理。我们先看一下怎么实现以及实现的效果，最后再来说它实现的原理。

首先定义一个全局异常处理类，在类上加上@ControllerAdvice，然后在类里面通过@ExceptionHandler来对异常进行处理。

package com.example.springbootdemo.common.advice;


import com.example.springbootdemo.common.response.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;


/**
 * description: BasicExceptionHandler 对系统报错进行统一处理。<br>
 * @date: 2022/12/27 0027 下午 3:27 <br>
 * @author: William <br>
 * @version: 1.0 <br>
 */
@Slf4j
@ControllerAdvice
public class BasicExceptionHandler {


    /**
     * description: errorHandler 处理全局异常<br>
     * @version: 1.0
     * @date: 2022/12/27 0027 下午 3:37
     * @author: William
     * @param exception   异常
     * @return java.util.Map<java.lang.String,java.lang.Object>
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Result errorHandler(Exception exception) {
        return Result.build(500, exception.getMessage());
    }

}

当前代码拦截了所有的异常，然后定义了异常状态为500，返回的消息是异常提示。我们先来看一下效果。

 可以看到已经按照我们统一返回结果的样式进行返回了。但是这样处理异常，范围有点太大了。如果我们想某种异常进行单独的处理我们可以再添加这种异常处理的方法就好了，也很简单，我们来举个例子说明一下。就拿当前的0不能做除数这种异常来举例。

package com.example.springbootdemo.common.advice;

import com.example.springbootdemo.common.exception.MyException;
import com.example.springbootdemo.common.response.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;


/**
 * description: BasicExceptionHandler 对系统报错进行统一处理。<br>
 * @date: 2022/12/27 0027 下午 3:27 <br>
 * @author: William <br>
 * @version: 1.0 <br>
 */
@Slf4j
@ControllerAdvice
public class BasicExceptionHandler {


    /**
     * description: errorHandler <br>
     * @version: 1.0
     * @date: 2022/12/27 0027 下午 4:44
     * @author: William
     * @param exception 异常
     * @return com.example.springbootdemo.common.response.Result
     */
    @ResponseBody
    @ExceptionHandler(value = ArithmeticException.class)
    public Result errorHandler(ArithmeticException exception) {
        return Result.build(500, "算数运算异常");
    }

    

    /**
     * description: errorHandler 处理全局异常<br>
     * @version: 1.0
     * @date: 2022/12/27 0027 下午 3:37
     * @author: William
     * @param exception   异常
     * @return java.util.Map<java.lang.String,java.lang.Object>
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Result errorHandler(Exception exception) {
        return Result.build(500, exception.getMessage());
    }

}

 按照我们上面的处理结果，如果说发生了0是除数的异常，提示消息应该是：“算数运算异常”。那我们重新启动在来运行一次，看一下效果。

 可以看到，已经变成了我们预期的样子。说明我们的处理生效了。

那么这究竟是怎么实现的呢？其实也非常简单，我们来看一下@ControllerAdvice的注释文档，这里面已经说的非常清楚了。

Specialization of @Component for classes that declare @ExceptionHandler, @InitBinder, or @ModelAttribute methods to be shared across multiple @Controller classes.

这个类是为那些声明了（@ExceptionHandler、@InitBinder 或 @ModelAttribute注解修饰的）方法的类而提供的专业化的@Component , 以供多个 Controller类所共享。

其实说白了，就是aop思想的一种实现，你告诉我需要拦截规则，我帮你把他们拦下来，具体你想做更细致的拦截筛选和拦截之后的处理，你自己通过@ExceptionHandler、@InitBinder 或 @ModelAttribute这三个注解以及被其注解的方法来自定义。还有一点需要说明一下，就是@ControllerAdvice可以通过 @Order / @Priority 来设置优先级。

三、自定义异常

那么我们该如何定义一个自己的异常类呢？其实非常简单，我们只要使用继承就好了。

package com.example.springbootdemo.common.exception;


import com.example.springbootdemo.common.enums.ErrorCodeEnum;
import lombok.Getter;

/**
 *@ClassName MyException
 *@Description 异常处理类，将运行异常交给MyException,将异常信息统一返回
 *@Author William
 *@date: 2022/12/27 0027 下午 3:26
 *@Version 1.0
 */
@Getter
public class MyException extends RuntimeException{

    private ErrorCodeEnum errorCodeEnum;

    public MyException(ErrorCodeEnum errorCodeEnum) {
        this.errorCodeEnum = errorCodeEnum;
    }
}

这样我们就通过继承RuntimeException实现了自己的自定义异常了。通过继承RuntimeException，那么它也就是异常的一种了，我们就能够在抛出异常时使用自己定义的异常了。使用方法如下：在参数校验时，如果发生了参数非法，那我们就抛出参数非法的异常。使用非常的简单。

四、自定义异常处理

对于自定义异常的处理也非常简单，跟我们上面处理算数运算异常时是一样的，我们只要把异常类型换成我们自己定义的异常类型就好了。具体代码如下：

package com.example.springbootdemo.common.advice;

import com.example.springbootdemo.common.exception.MyException;
import com.example.springbootdemo.common.response.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;


/**
 * description: BasicExceptionHandler 对系统报错进行统一处理。<br>
 * @date: 2022/12/27 0027 下午 3:27 <br>
 * @author: William <br>
 * @version: 1.0 <br>
 */
@Slf4j
@ControllerAdvice
public class BasicExceptionHandler {



    /**
     * description: errorHandler 处理算数运算异常<br>
     * @version: 1.0
     * @date: 2022/12/27 0027 下午 4:44
     * @author: William
     * @param exception 异常
     * @return com.example.springbootdemo.common.response.Result
     */
    @ResponseBody
    @ExceptionHandler(value = ArithmeticException.class)
    public Result errorHandler(ArithmeticException exception) {
        return Result.build(500, "算数运算异常");
    }

    /**
     * description: errorHandler 处理自定义异常<br>
     * @version: 1.0
     * @date: 2022/12/27 0027 下午 3:32
     * @author: William
     * @param exception  自定义异常
     * @return java.util.Map<java.lang.String,java.lang.Object>
     */
    @ResponseBody
    @ExceptionHandler(value = MyException.class)
    public Result errorHandler(MyException exception) {
        return Result.error(exception.getErrorCodeEnum());
    }


    /**
     * description: errorHandler 处理全局异常<br>
     * @version: 1.0
     * @date: 2022/12/27 0027 下午 3:37
     * @author: William
     * @param exception   异常
     * @return java.util.Map<java.lang.String,java.lang.Object>
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Result errorHandler(Exception exception) {
        return Result.build(500, exception.getMessage());
    }



}

五、测试统一异常处理

到了这里我们就能够启动项目来测试一下我们的统一异常处理了。

 启动成功，我们访问swagger接口来测试一下：

 可以看到我们抛出的异常也被统一处理了。好了，到这里我们的统一异常处理就完成了。如果文章对你有所帮助的话，可以点赞关注一下~