你这代码写得真丑，满屏的try-catch，全局异常处理不会吗?

# 背景

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

丑陋的 try catch 代码块

优雅的Controller

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

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

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

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

# 什么是统一异常处理

Spring在3.2版本增加了一个注解@ControllerAdvice，可以与@ExceptionHandler、@InitBinder、@ModelAttribute 等注解注解配套使用，对于这几个注解的作用，这里不做过多赘述，若有不了解的，可以参考Spring3.2新注解@ControllerAdvice，先大概有个了解。

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

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

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

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

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

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

不同阶段的异常

# 目标

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

# 统一异常处理实战

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

用 Assert(断言) 替换 throw exception

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

@Testpublicvoidtest1(){ ... User user = userDao.selectById(userId);Assert.notNull(user,"用户不存在."); ... }@Testpublicvoidtest2(){// 另一种写法 User user = userDao.selectById(userId);if(user ==null) {thrownewIllegalArgumentException("用户不存在."); } }

有没有感觉第一种判定非空的写法很优雅，第二种写法则是相对丑陋的 if {...} 代码块。那么神奇的 Assert.notNull() 背后到底做了什么呢？下面是 Assert 的部分源码：

publicabstractclassAssert{publicAssert(){ }publicstaticvoidnotNull(@Nullable Objectobject, String message){if(object==null) {thrownewIllegalArgumentException(message); } }}

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

Assert

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

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

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

善解人意的Enum

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

publicinterfaceIResponseEnum { int getCode();StringgetMessage();}/** * <p>业务异常</p> * <p>业务处理时，出现异常，可以抛出该异常</p> */publicclassBusinessExceptionextendsBaseException {privatestaticfinal long serialVersionUID =1L;publicBusinessException(IResponseEnum responseEnum,Object[] args,Stringmessage) {super(responseEnum, args, message); }publicBusinessException(IResponseEnum responseEnum,Object[] args,Stringmessage, Throwable cause) {super(responseEnum, args, message, cause); }}publicinterfaceBusinessExceptionAssertextendsIResponseEnum, Assert {@OverridedefaultBaseException newException(Object... args) {Stringmsg = MessageFormat.format(this.getMessage(), args);returnnewBusinessException(this, args, msg); }@OverridedefaultBaseException newException(Throwable t,Object... args) {Stringmsg = MessageFormat.format(this.getMessage(), args);returnnewBusinessException(this, args, msg, t); }}@Getter@AllArgsConstructorpublicenumResponseEnumimplementsBusinessExceptionAssert {/** * Bad licence type */BAD_LICENCE_TYPE(7001,"Bad licence type."),/** * Licence not found */LICENCE_NOT_FOUND(7002,"Licence not found.") ;/** * 返回码 */privateint code;/** * 返回消息 */privateStringmessage;}

看到这里，有没有眼前一亮的感觉，代码示例中定义了两个枚举实例：

BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，分别对应了BadLicenceTypeException、LicenceNotFoundException两种异常。以后每增加一种异常情况，只需增加一个枚举实例即可，再也不用每一种异常都定义一个异常类了。然后再来看下如何使用，假设LicenceService有校验Licence是否存在的方法，如下：

/*** 校验{@linkLicence}存在*@paramlicence */privatevoidcheckNotNull(Licence licence){ ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence); }

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

privatevoidcheckNotNull(Licence licence){if(licence ==null) {thrownewLicenceNotFoundException();// 或者这样thrownewBusinessException(7001,"Bad licence type."); } }

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

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

定义统一异常处理器类

@Slf4j@Component@ControllerAdvice@ConditionalOnWebApplication@ConditionalOnMissingBean(UnifiedExceptionHandler.class)publicclassUnifiedExceptionHandler{/** * 生产环境 */privatefinalstaticString ENV_PROD ="prod";@AutowiredprivateUnifiedMessageSource unifiedMessageSource;/** * 当前环境 */@Value("${spring.profiles.active}")privateString profile; /** * 获取国际化消息 **@parame 异常*@return */publicStringgetMessage(BaseException e){String code ="response."+ e.getResponseEnum().toString(); String message = unifiedMessageSource.getMessage(code, e.getArgs());if(message ==null|| message.isEmpty()) {returne.getMessage(); }returnmessage; }/** * 业务异常 **@parame 异常*@return异常结果 */@ExceptionHandler(value = BusinessException.class)@ResponseBodypublicErrorResponsehandleBusinessException(BaseException e){ log.error(e.getMessage(), e);returnnewErrorResponse(e.getResponseEnum().getCode(), getMessage(e)); }/** * 自定义异常 **@parame 异常*@return异常结果 */@ExceptionHandler(value = BaseException.class)@ResponseBodypublicErrorResponsehandleBaseException(BaseException e){ log.error(e.getMessage(), e);returnnewErrorResponse(e.getResponseEnum().getCode(), getMessage(e)); }/** * Controller上一层相关异常 **@parame 异常*@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 })@ResponseBodypublicErrorResponsehandleServletException(Exception e){ log.error(e.getMessage(), e);intcode = 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 =newBaseException(CommonResponseEnum.SERVER_ERROR); String message = getMessage(baseException);returnnewErrorResponse(code, message); }returnnewErrorResponse(code, e.getMessage()); }/** * 参数绑定异常 **@parame 异常*@return异常结果 */@ExceptionHandler(value = BindException.class)@ResponseBodypublicErrorResponsehandleBindException(BindException e){log.error("参数绑定校验异常", e);returnwrapperBindingResult(e.getBindingResult()); }/** * 参数校验异常，将校验失败的所有异常组合成一条错误信息 **@parame 异常*@return异常结果 */@ExceptionHandler(value = MethodArgumentNotValidException.class)@ResponseBodypublicErrorResponsehandleValidException(MethodArgumentNotValidException e){log.error("参数绑定校验异常", e);returnwrapperBindingResult(e.getBindingResult()); }/** * 包装绑定异常结果 **@parambindingResult 绑定结果*@return异常结果 */privateErrorResponsewrapperBindingResult(BindingResult bindingResult){StringBuilder msg =newStringBuilder();for(ObjectError error : bindingResult.getAllErrors()) {msg.append(", ");if(errorinstanceofFieldError) {msg.append(((FieldError) error).getField()).append(": "); }msg.append(error.getDefaultMessage() ==null?"": error.getDefaultMessage()); }returnnewErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2)); }/** * 未定义异常 **@parame 异常*@return异常结果 */@ExceptionHandler(value = Exception.class)@ResponseBodypublicErrorResponsehandleException(Exception e){ log.error(e.getMessage(), e);if(ENV_PROD.equals(profile)) {// 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.intcode = CommonResponseEnum.SERVER_ERROR.getCode();BaseException baseException =newBaseException(CommonResponseEnum.SERVER_ERROR); String message = getMessage(baseException);returnnewErrorResponse(code, message); }returnnewErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage()); } }

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

进入Controller前的异常: handleServletException、handleBindException、handleValidException

自定义异常: handleBusinessException、handleBaseException

未知异常: handleException

接下来分别对这几种异常处理器做详细说明。

异常处理器说明

handleServletException

一个http请求，在到达Controller前，会对该请求的请求信息与目标控制器信息做一系列校验。这里简单说一下：

NoHandlerFoundException：首先根据请求Url查找有没有对应的控制器，若没有则会抛该异常，也就是大家非常熟悉的404异常；

HttpRequestMethodNotSupportedException：若匹配到了（匹配结果是一个列表，不同的是http方法不同，如：Get、Post等），则尝试将请求的http方法与列表的控制器做匹配，若没有对应http方法的控制器，则抛该异常；

HttpMediaTypeNotSupportedException：然后再对请求头与控制器支持的做比较，比如content-type请求头，若控制器的参数签名包含注解@RequestBody，但是请求的content-type请求头的值没有包含application/json，那么会抛该异常（当然，不止这种情况会抛这个异常）；

MissingPathVariableException：未检测到路径参数。比如url为：/licence/{licenceId}，参数签名包含@PathVariable("licenceId")，当请求的url为/licence，在没有明确定义url为/licence的情况下，会被判定为：缺少路径参数；

MissingServletRequestParameterException：缺少请求参数。比如定义了参数@RequestParam("licenceId") String licenceId，但发起请求时，未携带该参数，则会抛该异常；

TypeMismatchException: 参数类型匹配失败。比如：接收参数为Long型，但传入的值确是一个字符串，那么将会出现类型转换失败的情况，这时会抛该异常；

HttpMessageNotReadableException：与上面的HttpMediaTypeNotSupportedException举的例子完全相反，即请求头携带了"content-type: application/json;charset=UTF-8"，但接收参数却没有添加注解@RequestBody，或者请求体携带的 json 串反序列化成 pojo 的过程中失败了，也会抛该异常；

HttpMessageNotWritableException：返回的 pojo 在序列化成 json 过程失败了，那么抛该异常；

HttpMediaTypeNotAcceptableException：未知；

ServletRequestBindingException：未知；

ConversionNotSupportedException：未知；

MissingServletRequestPartException：未知；

AsyncRequestTimeoutException：未知；

handleBindException

参数校验异常，后文详细说明。

handleValidException

参数校验异常，后文详细说明。

handleBusinessException、handleBaseException

处理自定义的业务异常，只是handleBaseException处理的是除了 BusinessException 意外的所有业务异常。就目前来看，这2个是可以合并成一个的。

handleException

处理所有未知的异常，比如操作数据库失败的异常。

注：上面的handleServletException、handleException 这两个处理器，返回的异常信息，不同环境返回的可能不一样，以为这些异常信息都是框架自带的异常信息，一般都是英文的，不太好直接展示给用户看，所以统一返回SERVER_ERROR代表的异常信息。

异于常人的404

上文提到，当请求没有匹配到控制器的情况下，会抛出NoHandlerFoundException异常，但其实默认情况下不是这样，默认情况下会出现类似如下页面：

Whitelabel Error Page

这个页面是如何出现的呢？实际上，当出现404的时候，默认是不抛异常的，而是forward跳转到/error控制器，spring也提供了默认的error控制器，如下：

BasicErrorController

那么，如何让404也抛出异常呢，只需在properties文件中加入如下配置即可：

spring.mvc.throw-exception-if-no-handler-found=true

spring.resources.add-mappings=false

如此，就可以异常处理器中捕获它了，然后前端只要捕获到特定的状态码，立即跳转到404页面即可

捕获404对应的异常