# 背景

軟件開發(fā)過程中，不可避免的是需要處理各種異常，就我自己來說，至少有一半以上的時間都是在處理各種異常情況，所以代碼中就會出現(xiàn)大量的try {...} catch {...} finally {...}?代碼塊，不僅有大量的冗余代碼，而且還影響代碼的可讀性。比較下面兩張圖，看看您現(xiàn)在編寫的代碼屬于哪一種風(fēng)格？然后哪種編碼風(fēng)格您更喜歡？

丑陋的 try catch 代碼塊

優(yōu)雅的Controller

上面的示例，還只是在Controller層，如果是在Service層，可能會有更多的try catch代碼塊。這將會嚴(yán)重影響代碼的可讀性、“美觀性”。

所以如果是我的話，我肯定偏向于第二種，我可以把更多的精力放在業(yè)務(wù)代碼的開發(fā)，同時代碼也會變得更加簡潔。

既然業(yè)務(wù)代碼不顯式地對異常進(jìn)行捕獲、處理，而異?？隙ㄟ€是處理的，不然系統(tǒng)豈不是動不動就崩潰了，所以必須得有其他地方捕獲并處理這些異常。

那么問題來了，如何優(yōu)雅的處理各種異常？

# 什么是統(tǒng)一異常處理

Spring在3.2版本增加了一個注解@ControllerAdvice，可以與@ExceptionHandler、@InitBinder、@ModelAttribute 等注解注解配套使用，對于這幾個注解的作用，這里不做過多贅述，若有不了解的，可以參考Spring3.2新注解@ControllerAdvice，先大概有個了解。

不過跟異常處理相關(guān)的只有注解@ExceptionHandler，從字面上看，就是?異常處理器?的意思，其實際作用也是：若在某個Controller類定義一個異常處理方法，并在方法上添加該注解，那么當(dāng)出現(xiàn)指定的異常時，會執(zhí)行該處理異常的方法，其可以使用springmvc提供的數(shù)據(jù)綁定，比如注入HttpServletRequest等，還可以接受一個當(dāng)前拋出的Throwable對象。

但是，這樣一來，就必須在每一個Controller類都定義一套這樣的異常處理方法，因為異?？梢允歉鞣N各樣。這樣一來，就會造成大量的冗余代碼，而且若需要新增一種異常的處理邏輯，就必須修改所有Controller類了，很不優(yōu)雅。

當(dāng)然你可能會說，那就定義個類似BaseController的基類，這樣總行了吧。

這種做法雖然沒錯，但仍不盡善盡美，因為這樣的代碼有一定的侵入性和耦合性。簡簡單單的Controller，我為啥非得繼承這樣一個類呢，萬一已經(jīng)繼承其他基類了呢。大家都知道Java只能繼承一個類。

那有沒有一種方案，既不需要跟Controller耦合，也可以將定義的?異常處理器?應(yīng)用到所有控制器呢？所以注解@ControllerAdvice出現(xiàn)了，簡單的說，該注解可以把異常處理器應(yīng)用到所有控制器，而不是單個控制器。借助該注解，我們可以實現(xiàn)：在獨立的某個地方，比如單獨一個類，定義一套對各種異常的處理機制，然后在類的簽名加上注解@ControllerAdvice，統(tǒng)一對?不同階段的、不同異常?進(jìn)行處理。這就是統(tǒng)一異常處理的原理。

注意到上面對異常按階段進(jìn)行分類，大體可以分成：進(jìn)入Controller前的異常 和Service 層異常，具體可以參考下圖：

不同階段的異常

# 目標(biāo)

消滅95%以上的 try catch 代碼塊，以優(yōu)雅的 Assert(斷言) 方式來校驗業(yè)務(wù)的異常情況，只關(guān)注業(yè)務(wù)邏輯，而不用花費大量精力寫冗余的 try catch 代碼塊。

# 統(tǒng)一異常處理實戰(zhàn)

在定義統(tǒng)一異常處理類之前，先來介紹一下如何優(yōu)雅的判定異常情況并拋異常。

用 Assert(斷言) 替換 throw exception

想必 Assert(斷言)?大家都很熟悉，比如 Spring 家族的org.springframework.util.Assert，在我們寫測試用例的時候經(jīng)常會用到，使用斷言能讓我們編碼的時候有一種非一般絲滑的感覺，比如：

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

有沒有感覺第一種判定非空的寫法很優(yōu)雅，第二種寫法則是相對丑陋的 if {...}?代碼塊。那么神奇的 Assert.notNull()?背后到底做了什么呢？下面是 Assert 的部分源碼：

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

可以看到，Assert 其實就是幫我們把 if {...}?封裝了一下，是不是很神奇。雖然很簡單，但不可否認(rèn)的是編碼體驗至少提升了一個檔次。那么我們能不能模仿org.springframework.util.Assert，也寫一個斷言類，不過斷言失敗后拋出的異常不是IllegalArgumentException 這些內(nèi)置異常，而是我們自己定義的異常。下面讓我們來嘗試一下。

Assert

publicinterfaceAssert{/**? ? * 創(chuàng)建異常*@paramargs*@return? ? */BaseExceptionnewException(Object... args);/**? ? * 創(chuàng)建異常*@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>支持傳遞參數(shù)方式，避免在判斷之前進(jìn)行字符串拼接操作? ? **@paramobj 待判斷對象*@paramargs message占位符對應(yīng)的參數(shù)列表? ? */defaultvoidassertNotNull(Object obj, Object... args){if(obj ==null) {thrownewException(args);? ? ? ? }? ? }}

上面的Assert斷言方法是使用接口的默認(rèn)方法定義的，然后有沒有發(fā)現(xiàn)當(dāng)斷言失敗后，拋出的異常不是具體的某個異常，而是交由2個newException接口方法提供。因為業(yè)務(wù)邏輯中出現(xiàn)的異常基本都是對應(yīng)特定的場景，比如根據(jù)用戶id獲取用戶信息，查詢結(jié)果為null，此時拋出的異?？赡転閁serNotFoundException，并且有特定的異常碼（比如7001）和異常信息“用戶不存在”。所以具體拋出什么異常，有Assert的實現(xiàn)類決定。

看到這里，您可能會有這樣的疑問，按照上面的說法，那豈不是有多少異常情況，就得有定義等量的斷言類和異常類，這顯然是反人類的，這也沒想象中高明嘛。別急，且聽我細(xì)細(xì)道來。

善解人意的Enum

自定義異常BaseException有2個屬性，即code、message，這樣一對屬性，有沒有想到什么類一般也會定義這2個屬性？沒錯，就是枚舉類。且看我如何將 Enum 和 Assert 結(jié)合起來，相信我一定會讓你眼前一亮。如下：

publicinterfaceIResponseEnum {? ? int getCode();StringgetMessage();}/** * <p>業(yè)務(wù)異常</p> * <p>業(yè)務(wù)處理時，出現(xiàn)異常，可以拋出該異常</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，分別對應(yīng)了BadLicenceTypeException、LicenceNotFoundException兩種異常。以后每增加一種異常情況，只需增加一個枚舉實例即可，再也不用每一種異常都定義一個異常類了。然后再來看下如何使用，假設(shè)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.");? ? ? ? }? ? }

使用枚舉類結(jié)合(繼承)Assert，只需根據(jù)特定的異常情況定義不同的枚舉實例，如上面的BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，就能夠針對不同情況拋出特定的異常（這里指攜帶特定的異常碼和異常消息），這樣既不用定義大量的異常類，同時還具備了斷言的良好可讀性，當(dāng)然這種方案的好處遠(yuǎn)不止這些，請繼續(xù)閱讀后文，慢慢體會。

注：上面舉的例子是針對特定的業(yè)務(wù)，而有部分異常情況是通用的，比如：服務(wù)器繁忙、網(wǎng)絡(luò)異常、服務(wù)器異常、參數(shù)校驗異常、404等，所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum，其中ServletResponseEnum 會在后文詳細(xì)說明。

定義統(tǒng)一異常處理器類

@Slf4j@Component@ControllerAdvice@ConditionalOnWebApplication@ConditionalOnMissingBean(UnifiedExceptionHandler.class)publicclassUnifiedExceptionHandler{/**? ? * 生產(chǎn)環(huán)境? ? */privatefinalstaticString ENV_PROD ="prod";@AutowiredprivateUnifiedMessageSource unifiedMessageSource;/**? ? * 當(dāng)前環(huán)境? ? */@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;? ? }/**? ? * 業(yè)務(wù)異常? ? **@parame 異常*@return異常結(jié)果? ? */@ExceptionHandler(value = BusinessException.class)@ResponseBodypublicErrorResponsehandleBusinessException(BaseException e){? ? ? ? log.error(e.getMessage(), e);returnnewErrorResponse(e.getResponseEnum().getCode(), getMessage(e));? ? }/**? ? * 自定義異常? ? **@parame 異常*@return異常結(jié)果? ? */@ExceptionHandler(value = BaseException.class)@ResponseBodypublicErrorResponsehandleBaseException(BaseException e){? ? ? ? log.error(e.getMessage(), e);returnnewErrorResponse(e.getResponseEnum().getCode(), getMessage(e));? ? }/**? ? * Controller上一層相關(guān)異常? ? **@parame 異常*@return異常結(jié)果? ? */@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)) {// 當(dāng)為生產(chǎn)環(huán)境, 不適合把具體的異常信息展示給用戶, 比如404.? ? ? ? ? ? code = CommonResponseEnum.SERVER_ERROR.getCode();BaseException baseException =newBaseException(CommonResponseEnum.SERVER_ERROR);? ? ? ? ? ? String message = getMessage(baseException);returnnewErrorResponse(code, message);? ? ? ? }returnnewErrorResponse(code, e.getMessage());? ? }/**? ? * 參數(shù)綁定異常? ? **@parame 異常*@return異常結(jié)果? ? */@ExceptionHandler(value = BindException.class)@ResponseBodypublicErrorResponsehandleBindException(BindException e){log.error("參數(shù)綁定校驗異常", e);returnwrapperBindingResult(e.getBindingResult());? ? }/**? ? * 參數(shù)校驗異常，將校驗失敗的所有異常組合成一條錯誤信息? ? **@parame 異常*@return異常結(jié)果? ? */@ExceptionHandler(value = MethodArgumentNotValidException.class)@ResponseBodypublicErrorResponsehandleValidException(MethodArgumentNotValidException e){log.error("參數(shù)綁定校驗異常", e);returnwrapperBindingResult(e.getBindingResult());? ? }/**? ? * 包裝綁定異常結(jié)果? ? **@parambindingResult 綁定結(jié)果*@return異常結(jié)果? ? */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異常結(jié)果? ? */@ExceptionHandler(value = Exception.class)@ResponseBodypublicErrorResponsehandleException(Exception e){? ? ? ? log.error(e.getMessage(), e);if(ENV_PROD.equals(profile)) {// 當(dāng)為生產(chǎn)環(huán)境, 不適合把具體的異常信息展示給用戶, 比如數(shù)據(jù)庫異常信息.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，還記得上文提到的?按階段分類?嗎，即對應(yīng) 進(jìn)入Controller前的異常 和 Service 層異常；然后 ServiceException 再分成自定義異常、未知異常。對應(yīng)關(guān)系如下：

進(jìn)入Controller前的異常: handleServletException、handleBindException、handleValidException

自定義異常: handleBusinessException、handleBaseException

未知異常: handleException

接下來分別對這幾種異常處理器做詳細(xì)說明。

異常處理器說明

handleServletException

一個http請求，在到達(dá)Controller前，會對該請求的請求信息與目標(biāo)控制器信息做一系列校驗。這里簡單說一下：

NoHandlerFoundException：首先根據(jù)請求Url查找有沒有對應(yīng)的控制器，若沒有則會拋該異常，也就是大家非常熟悉的404異常；

HttpRequestMethodNotSupportedException：若匹配到了（匹配結(jié)果是一個列表，不同的是http方法不同，如：Get、Post等），則嘗試將請求的http方法與列表的控制器做匹配，若沒有對應(yīng)http方法的控制器，則拋該異常；

HttpMediaTypeNotSupportedException：然后再對請求頭與控制器支持的做比較，比如content-type請求頭，若控制器的參數(shù)簽名包含注解@RequestBody，但是請求的content-type請求頭的值沒有包含application/json，那么會拋該異常（當(dāng)然，不止這種情況會拋這個異常）；

MissingPathVariableException：未檢測到路徑參數(shù)。比如url為：/licence/{licenceId}，參數(shù)簽名包含@PathVariable("licenceId")，當(dāng)請求的url為/licence，在沒有明確定義url為/licence的情況下，會被判定為：缺少路徑參數(shù)；

MissingServletRequestParameterException：缺少請求參數(shù)。比如定義了參數(shù)@RequestParam("licenceId") String licenceId，但發(fā)起請求時，未攜帶該參數(shù)，則會拋該異常；

TypeMismatchException: 參數(shù)類型匹配失敗。比如：接收參數(shù)為Long型，但傳入的值確是一個字符串，那么將會出現(xiàn)類型轉(zhuǎn)換失敗的情況，這時會拋該異常；

HttpMessageNotReadableException：與上面的HttpMediaTypeNotSupportedException舉的例子完全相反，即請求頭攜帶了"content-type: application/json;charset=UTF-8"，但接收參數(shù)卻沒有添加注解@RequestBody，或者請求體攜帶的 json 串反序列化成 pojo 的過程中失敗了，也會拋該異常；

HttpMessageNotWritableException：返回的 pojo 在序列化成 json 過程失敗了，那么拋該異常；

HttpMediaTypeNotAcceptableException：未知；

ServletRequestBindingException：未知；

ConversionNotSupportedException：未知；

MissingServletRequestPartException：未知；

AsyncRequestTimeoutException：未知；

handleBindException

參數(shù)校驗異常，后文詳細(xì)說明。

handleValidException

參數(shù)校驗異常，后文詳細(xì)說明。

handleBusinessException、handleBaseException

處理自定義的業(yè)務(wù)異常，只是handleBaseException處理的是除了 BusinessException 意外的所有業(yè)務(wù)異常。就目前來看，這2個是可以合并成一個的。

handleException

處理所有未知的異常，比如操作數(shù)據(jù)庫失敗的異常。

注：上面的handleServletException、handleException 這兩個處理器，返回的異常信息，不同環(huán)境返回的可能不一樣，以為這些異常信息都是框架自帶的異常信息，一般都是英文的，不太好直接展示給用戶看，所以統(tǒng)一返回SERVER_ERROR代表的異常信息。

異于常人的404

上文提到，當(dāng)請求沒有匹配到控制器的情況下，會拋出NoHandlerFoundException異常，但其實默認(rèn)情況下不是這樣，默認(rèn)情況下會出現(xiàn)類似如下頁面：

Whitelabel Error Page

這個頁面是如何出現(xiàn)的呢？實際上，當(dāng)出現(xiàn)404的時候，默認(rèn)是不拋異常的，而是forward跳轉(zhuǎn)到/error控制器，spring也提供了默認(rèn)的error控制器，如下：

BasicErrorController

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

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

spring.resources.add-mappings=false

如此，就可以異常處理器中捕獲它了，然后前端只要捕獲到特定的狀態(tài)碼，立即跳轉(zhuǎn)到404頁面即可

捕獲404對應(yīng)的異常