统一异常处理介绍及实战

男娘i 2021-12-15 05:33 232阅读 0赞

**背景**

软件开发过程中，不可避免的是需要处理各种异常，就我自己来说，至少有一半以上的时间都是在处理各种异常情况，所以代码中就会出现大量的try \{...\} catch \{...\} finally \{...\} 代码块，不仅有大量的冗余代码，而且还影响代码的可读性。比较下面两张图，看看您现在编写的代码属于哪一种风格？然后哪种编码风格您更喜欢？

![format_png][]

丑陋的 try catch 代码块

![format_png 1][]

优雅的Controller

上面的示例，还只是在Controller层，如果是在Service层，可能会有更多的try catch代码块。这将会严重影响代码的可读性、“美观性”。

所以如果是我的话，我肯定偏向于第二种，我可以把更多的精力放在业务代码的开发，同时代码也会变得更加简洁。

既然业务代码不显式地对异常进行捕获、处理，而异常肯定还是处理的，不然系统岂不是动不动就崩溃了，所以必须得有其他地方捕获并处理这些异常。

那么问题来了，如何优雅的处理各种异常？

**什么是统一异常处理**

Spring在3.2版本增加了一个注解@ControllerAdvice，可以与@ExceptionHandler、@InitBinder、@ModelAttribute 等注解注解配套使用，对于这几个注解的作用，这里不做过多赘述。

不过跟异常处理相关的只有注解@ExceptionHandler，从字面上看，就是 异常处理器 的意思，其实际作用也是：若在某个Controller类定义一个异常处理方法，并在方法上添加该注解，那么当出现指定的异常时，会执行该处理异常的方法，其可以使用springmvc提供的数据绑定，比如注入HttpServletRequest等，还可以接受一个当前抛出的Throwable对象。

但是，这样一来，就必须在每一个Controller类都定义一套这样的异常处理方法，因为异常可以是各种各样。这样一来，就会造成大量的冗余代码，而且若需要新增一种异常的处理逻辑，就必须修改所有Controller类了，很不优雅。

当然你可能会说，那就定义个类似BaseController的基类，这样总行了吧。

这种做法虽然没错，但仍不尽善尽美，因为这样的代码有一定的侵入性和耦合性。简简单单的Controller，我为啥非得继承这样一个类呢，万一已经继承其他基类了呢。大家都知道Java只能继承一个类。

那有没有一种方案，既不需要跟Controller耦合，也可以将定义的 **异常处理器** 应用到所有控制器呢？所以注解@ControllerAdvice出现了，简单的说，该注解可以把异常处理器应用到所有控制器，而不是单个控制器。借助该注解，我们可以实现：在独立的某个地方，比如单独一个类，定义一套对各种异常的处理机制，然后在类的签名加上注解@ControllerAdvice，统一对 **不同阶段的、不同异常 **进行处理。这就是统一异常处理的原理。

注意到上面对异常按阶段进行分类，大体可以分成：进入Controller前的异常 和 Service 层异常，具体可以参考下图：

![format_png 2][]

不同阶段的异常

**目标**

消灭95%以上的 try catch 代码块，以优雅的 Assert(断言) 方式来校验业务的异常情况，只关注业务逻辑，而不用花费大量精力写冗余的 try catch 代码块。

**统一异常处理实战**

> 注：因为整个统一异常处理方案涉及的代码比较多，这里不方便贴出所有代码，只会贴出关键部分，所以建议将源码clone到本地方便查看。源码地址：https://github.com/sprainkle/spring-cloud-advance，涉及到的项目包括：spring-cloud-advance-common、unified-exception-handling。

在定义统一异常处理类之前，先来介绍一下如何优雅的判定异常情况并抛异常。

**用 Assert(断言) 替换 throw exception**

想必 Assert(断言) 大家都很熟悉，比如 Spring 家族的 org.springframework.util.Assert，在我们写测试用例的时候经常会用到，使用断言能让我们编码的时候有一种非一般丝滑的感觉，比如：

@Test
        public void test1() {
            ...
            User user = userDao.selectById(userId);
            Assert.notNull(user, "用户不存在.");
            ...
        }
    
        @Test
        public void test2() {
            // 另一种写法
            User user = userDao.selectById(userId);
            if (user == null) {
                throw new IllegalArgumentException("用户不存在.");
            }
        }

有没有感觉第一种判定非空的写法很优雅，第二种写法则是相对丑陋的 if \{...\} 代码块。那么

神奇的 Assert.notNull() 背后到底做了什么呢？下面是 Assert 的部分源码：

public abstract class Assert {
        public Assert() {
        }
    
        public static void notNull(@Nullable Object object, String message) {
            if (object == null) {
                throw new IllegalArgumentException(message);
            }
        }
    }

可以看到，Assert 其实就是帮我们把 if \{...\} 封装了一下，是不是很神奇。虽然很简单，但不可否认的是编码体验至少提升了一个档次。那么我们能不能模仿org.springframework.util.Assert，也写一个断言类，不过断言失败后抛出的异常不是IllegalArgumentException 这些内置异常，而是我们自己定义的异常。下面让我们来尝试一下。

**Assert**

public interface Assert {
 /**
 * 创建异常
 * @param args
 * @return
 */
 BaseException newException(Object... args);
 
 /**
 * 创建异常
 * @param t
 * @param args
 * @return
 */
 BaseException newException(Throwable t, Object... args);
 
 /**
 * 断言对象<code>obj</code>非空。如果对象<code>obj</code>为空，则抛出异常
 *
 * @param obj 待判断对象
 */
 default void assertNotNull(Object obj) {
 if (obj == null) {
 throw newException(obj);
 }
 }
 
 /**
 * 断言对象<code>obj</code>非空。如果对象<code>obj</code>为空，则抛出异常
 * 异常信息<code>message</code>支持传递参数方式，避免在判断之前进行字符串拼接操作
 *
 * @param obj 待判断对象
 * @param args message占位符对应的参数列表
 */
 default void assertNotNull(Object obj, Object... args) {
 if (obj == null) {
 throw newException(args);
 }
 }
 }

> 注： 
> 
> 1.  这里只给出Assert接口的部分源码，更多断言方法请参考源码。 
> 2.  BaseException 是所有自定义异常的基类。 
> 3.  在接口中定义默认方法是Java8的新语法。

上面的Assert断言方法是使用接口的默认方法定义的，然后有没有发现当断言失败后，抛出的异常不是具体的某个异常，而是交由2个newException接口方法提供。因为业务逻辑中出现的异常基本都是对应特定的场景，比如根据用户id获取用户信息，查询结果为null，此时抛出的异常可能为UserNotFoundException，并且有特定的异常码（比如7001）和异常信息“用户不存在”。所以具体抛出什么异常，有Assert的实现类决定。

看到这里，您可能会有这样的疑问，按照上面的说法，那岂不是有多少异常情况，就得有定义等量的断言类和异常类，这显然是反人类的，这也没想象中高明嘛。别急，且听我细细道来。

**善解人意的Enum**

自定义异常BaseException有2个属性，即code、message，这样一对属性，有没有想到什么类一般也会定义这2个属性？没错，就是枚举类。且看我如何将 Enum 和 Assert 结合起来，相信我一定会让你眼前一亮。如下：

public interface IResponseEnum {
        int getCode();
        String getMessage();
    }

/**
 * 业务异常
 * 业务处理时，出现异常，可以抛出该异常
 */
 public class BusinessException extends BaseException {
 
 private static final long serialVersionUID = 1L;
 
 public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {
 super(responseEnum, args, message);
 }
 
 public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
 super(responseEnum, args, message, cause);
 }
 }

public interface BusinessExceptionAssert extends IResponseEnum, Assert {
    
        @Override
        default BaseException newException(Object... args) {
            String msg = MessageFormat.format(this.getMessage(), args);
    
            return new BusinessException(this, args, msg);
        }
    
        @Override
        default BaseException newException(Throwable t, Object... args) {
            String msg = MessageFormat.format(this.getMessage(), args);
    
            return new BusinessException(this, args, msg, t);
        }
    
    }

@Getter
    @AllArgsConstructor
    public enum ResponseEnum implements BusinessExceptionAssert {
    
        /**
         * Bad licence type
         */
        BAD_LICENCE_TYPE(7001, "Bad licence type."),
        /**
         * Licence not found
         */
        LICENCE_NOT_FOUND(7002, "Licence not found.")
        ;
    
        /**
         * 返回码
         */
        private int code;
        /**
         * 返回消息
         */
        private String message;
    }

看到这里，有没有眼前一亮的感觉，代码示例中定义了两个枚举实例：BAD\_LICENCE\_TYPE、LICENCE\_NOT\_FOUND，分别对应了BadLicenceTypeException、LicenceNotFoundException两种异常。以后每增加一种异常情况，只需增加一个枚举实例即可，再也不用每一种异常都定义一个异常类了。然后再来看下如何使用，假设LicenceService有校验Licence是否存在的方法，如下：

/**
         * 校验{@link Licence}存在
         * @param licence
         */
        private void checkNotNull(Licence licence) {
            ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);
        }

若不使用断言，代码可能如下：

private void checkNotNull(Licence licence) {
            if (licence == null) {
                throw new LicenceNotFoundException();
                // 或者这样
                throw new BusinessException(7001, "Bad licence type.");
            }
        }

使用枚举类结合(继承)Assert，只需根据特定的异常情况定义不同的枚举实例，如上面的BAD\_LICENCE\_TYPE、LICENCE\_NOT\_FOUND，就能够针对不同情况抛出特定的异常（这里指携带特定的异常码和异常消息），这样既不用定义大量的异常类，同时还具备了断言的良好可读性，当然这种方案的好处远不止这些，请继续阅读后文，慢慢体会。

> 注：上面举的例子是针对特定的业务，而有部分异常情况是通用的，比如：服务器繁忙、网络异常、服务器异常、参数校验异常、404等，所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum，其中 ServletResponseEnum 会在后文详细说明。

**定义统一异常处理器类**

@Slf4j
    @Component
    @ControllerAdvice
    @ConditionalOnWebApplication
    @ConditionalOnMissingBean(UnifiedExceptionHandler.class)
    public class UnifiedExceptionHandler {
        /**
         * 生产环境
         */
        private final static String ENV_PROD = "prod";
    
        @Autowired
        private UnifiedMessageSource unifiedMessageSource;
    
        /**
         * 当前环境
         */
        @Value("${spring.profiles.active}")
        private String profile;
        
        /**
         * 获取国际化消息
         *
         * @param e 异常
         * @return
         */
        public String getMessage(BaseException e) {
            String code = "response." + e.getResponseEnum().toString();
            String message = unifiedMessageSource.getMessage(code, e.getArgs());
    
            if (message == null || message.isEmpty()) {
                return e.getMessage();
            }
    
            return message;
        }
    
        /**
         * 业务异常
         *
         * @param e 异常
         * @return 异常结果
         */
        @ExceptionHandler(value = BusinessException.class)
        @ResponseBody
        public ErrorResponse handleBusinessException(BaseException e) {
            log.error(e.getMessage(), e);
    
            return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
        }
    
        /**
         * 自定义异常
         *
         * @param e 异常
         * @return 异常结果
         */
        @ExceptionHandler(value = BaseException.class)
        @ResponseBody
        public ErrorResponse handleBaseException(BaseException e) {
            log.error(e.getMessage(), e);
    
            return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
        }
    
        /**
         * Controller上一层相关异常
         *
         * @param e 异常
         * @return 异常结果
         */
        @ExceptionHandler({
                NoHandlerFoundException.class,
                HttpRequestMethodNotSupportedException.class,
                HttpMediaTypeNotSupportedException.class,
                MissingPathVariableException.class,
                MissingServletRequestParameterException.class,
                TypeMismatchException.class,
                HttpMessageNotReadableException.class,
                HttpMessageNotWritableException.class,
                // BindException.class,
                // MethodArgumentNotValidException.class
                HttpMediaTypeNotAcceptableException.class,
                ServletRequestBindingException.class,
                ConversionNotSupportedException.class,
                MissingServletRequestPartException.class,
                AsyncRequestTimeoutException.class
        })
        @ResponseBody
        public ErrorResponse handleServletException(Exception e) {
            log.error(e.getMessage(), e);
            int code = CommonResponseEnum.SERVER_ERROR.getCode();
            try {
                ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());
                code = servletExceptionEnum.getCode();
            } catch (IllegalArgumentException e1) {
                log.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());
            }
    
            if (ENV_PROD.equals(profile)) {
                // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如404.
                code = CommonResponseEnum.SERVER_ERROR.getCode();
                BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
                String message = getMessage(baseException);
                return new ErrorResponse(code, message);
            }
    
            return new ErrorResponse(code, e.getMessage());
        }
    
    
        /**
         * 参数绑定异常
         *
         * @param e 异常
         * @return 异常结果
         */
        @ExceptionHandler(value = BindException.class)
        @ResponseBody
        public ErrorResponse handleBindException(BindException e) {
            log.error("参数绑定校验异常", e);
    
            return wrapperBindingResult(e.getBindingResult());
        }
    
        /**
         * 参数校验异常，将校验失败的所有异常组合成一条错误信息
         *
         * @param e 异常
         * @return 异常结果
         */
        @ExceptionHandler(value = MethodArgumentNotValidException.class)
        @ResponseBody
        public ErrorResponse handleValidException(MethodArgumentNotValidException e) {
            log.error("参数绑定校验异常", e);
    
            return wrapperBindingResult(e.getBindingResult());
        }
    
        /**
         * 包装绑定异常结果
         *
         * @param bindingResult 绑定结果
         * @return 异常结果
         */
        private ErrorResponse wrapperBindingResult(BindingResult bindingResult) {
            StringBuilder msg = new StringBuilder();
    
            for (ObjectError error : bindingResult.getAllErrors()) {
                msg.append(", ");
                if (error instanceof FieldError) {
                    msg.append(((FieldError) error).getField()).append(": ");
                }
                msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());
    
            }
    
            return new ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2));
        }
    
        /**
         * 未定义异常
         *
         * @param e 异常
         * @return 异常结果
         */
        @ExceptionHandler(value = Exception.class)
        @ResponseBody
        public ErrorResponse handleException(Exception e) {
            log.error(e.getMessage(), e);
    
            if (ENV_PROD.equals(profile)) {
                // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.
                int code = CommonResponseEnum.SERVER_ERROR.getCode();
                BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
                String message = getMessage(baseException);
                return new ErrorResponse(code, message);
            }
    
            return new ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage());
        }
        
    }

可以看到，上面将异常分成几类，实际上只有两大类，一类是ServletException、ServiceException，还记得上文提到的 **按阶段分类** 吗，即对应 进入Controller前的异常 和Service 层异常；然后 ServiceException 再分成自定义异常、未知异常。对应关系如下：

[format_png]: /images/20211214/754934debcf542e3905c98fe46b67ca3.png
[format_png 1]: /images/20211214/527d20f5264343daaae262a8a7002e71.png
[format_png 2]: /images/20211214/9691c51e15104bb39f52449d9720697b.png