點擊關注公眾號，實用技術文章及時了解
軟件開發過程中，不可避免的是需要處理各種異常，就我自己來說，至少有一半以上的時間都是在處理各種異常情況，所以代碼中就會出現大量的try {…} catch {…} finally {…} 代碼塊，不僅有大量的冗餘代碼，而且還影響代碼的可讀性。
一、什麼是統一異常處理？Spring在3.2版本增加了一個註解@ControllerAdvice，可以與@ExceptionHandler、@InitBinder、@ModelAttribute 等註解註解配套使用。
不過跟異常處理相關的只有註解@ExceptionHandler，從字面上看，就是 異常處理器 的意思，其實際作用也是：若在某個Controller類定義一個異常處理方法，並在方法上添加該註解，那麼當出現指定的異常時，會執行該處理異常的方法，其可以使用springmvc提供的數據綁定，比如注入HttpServletRequest等，還可以接受一個當前拋出的Throwable對象。
但是，這樣一來，就必須在每一個Controller類都定義一套這樣的異常處理方法，因為異常可以是各種各樣。這樣一來，就會造成大量的冗餘代碼，而且若需要新增一種異常的處理邏輯，就必須修改所有Controller類了，很不優雅。也可以定義個類似BaseController的基類，這種做法雖然沒錯，但因為這樣的代碼有一定的侵入性和耦合性，萬一已經繼承其他基類了呢。
那有沒有一種方案，既不需要跟Controller耦合，也可以將定義的 異常處理器 應用到所有控制器呢？所以註解@ControllerAdvice出現了，簡單的說，該註解可以把異常處理器應用到所有控制器，而不是單個控制器。藉助該註解，我們可以實現：在獨立的某個地方，比如單獨一個類，定義一套對各種異常的處理機制，然後在類的簽名加上註解@ControllerAdvice，統一對 不同階段的、不同異常 進行處理。這就是統一異常處理的原理
注意到上面對異常按階段進行分類，大體可以分成：進入Controller前的異常 和 Service 層異常，具體可以參考下圖：
二、統一異常處理實戰在定義統一異常處理類之前，先來介紹一下如何優雅的判定異常情況並拋異常。
用 Assert(斷言) 替換 throw exception
@Testpublicvoidtest1(){...Useruser=userDao.selectById(userId);Assert.notNull(user,"用戶不存在.");...}@Testpublicvoidtest2(){//另一種寫法Useruser=userDao.selectById(userId);if(user==null){thrownewIllegalArgumentException("用戶不存在.");}}有沒有感覺第一種判定非空的寫法很優雅，其實Assert.notNull()的源碼部分也是用的第二種寫法。
publicabstractclassAssert{publicAssert(){}publicstaticvoidnotNull(@NullableObjectobject,Stringmessage){if(object==null){thrownewIllegalArgumentException(message);}}}可以看到，Assert 其實就是幫我們把 if {…} 封裝了一下，是不是很神奇。雖然很簡單，但不可否認的是編碼體驗至少提升了一個檔次。那麼我們能不能模仿org.springframework.util.Assert，也寫一個斷言類，不過斷言失敗後拋出的異常不是IllegalArgumentException 這些內置異常，而是我們自己定義的異常。
下面讓我們來嘗試一下：
defaultvoidassertNotNull(Objectobj,Object...args){if(obj==null){thrownewException(args);}}上面的Assert斷言方法是使用接口的默認方法定義的，然後有沒有發現當斷言失敗後，拋出的異常不是具體的某個異常，而是交由1個newException接口方法提供。
善解人意的Enum自定義異常BaseException有2個屬性，即code、message，這樣一對屬性，有沒有想到什麼類一般也會定義這2個屬性？沒錯，就是枚舉類。將 Enum 和 Assert 結合起來，相信會讓你眼前一亮。
publicinterfaceIResponseEnum{intgetCode();StringgetMessage();}/***<p>業務異常</p>*<p>業務處理時，出現異常，可以拋出該異常</p>*/publicclassBusinessExceptionextendsBaseException{privatestaticfinallongserialVersionUID=1L;publicBusinessException(IResponseEnumresponseEnum,Object[]args,Stringmessage){super(responseEnum,args,message);}publicBusinessException(IResponseEnumresponseEnum,Object[]args,Stringmessage,Throwablecause){super(responseEnum,args,message,cause);}}publicinterfaceBusinessExceptionAssertextendsIResponseEnum,Assert{@OverridedefaultBaseExceptionnewException(Object...args){Stringmsg=MessageFormat.format(this.getMessage(),args);returnnewBusinessException(this,args,msg);}@OverridedefaultBaseExceptionnewException(Throwablet,Object...args){Stringmsg=MessageFormat.format(this.getMessage(),args);returnnewBusinessException(this,args,msg,t);}}@Getter@AllArgsConstructorpublicenumResponseEnumimplementsBusinessExceptionAssert{/***Badlicencetype*/BAD_LICENCE_TYPE(7001,"Badlicencetype."),/***Licencenotfound*/LICENCE_NOT_FOUND(7002,"Licencenotfound.");/***返回碼*/privateintcode;/***返回消息*/privateStringmessage;}這裡代碼示例中定義了兩個枚舉實例：BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，分別對應了BadLicenceTypeException、LicenceNotFoundException兩種異常。
以後每增加一種異常情況，只需增加一個枚舉實例即可，再也不用每一種異常都定義一個異常類了。然後再來看下如何使用，假設LicenceService有校驗Licence是否存在的方法，如下
/***校驗{@linkLicence}存在*@paramlicence*/privatevoidcheckNotNull(Licencelicence){ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);}若不使用斷言，代碼可能如下：
privatevoidcheckNotNull(Licencelicence){if(licence==null){thrownewLicenceNotFoundException();//或者這樣thrownewBusinessException(7001,"Badlicencetype.");}}使用枚舉類結合(繼承)Assert，只需根據特定的異常情況定義不同的枚舉實例，如上面的BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，就能夠針對不同情況拋出特定的異常（這裡指攜帶特定的異常碼和異常消息），這樣既不用定義大量的異常類，同時還具備了斷言的良好可讀性，當然這種方案的好處遠不止這些
統一返回結果在驗證統一異常處理器之前，順便說一下統一返回結果。說白了，其實是統一一下返回結果的數據結構。code、message 是所有返回結果中必有的字段，而當需要返回數據時，則需要另一個字段 data 來表示。
所以首先定義一個 BaseResponse 來作為所有返回結果的基類；
然後定義一個通用返回結果類CommonResponse，繼承 BaseResponse，而且多了字段 data；
為了區分成功和失敗返回結果，於是再定義一個 ErrorResponse
驗證統一異常處理因為這一套統一異常處理可以說是通用的，所有可以設計成一個 common包，以後每一個新項目/模塊只需引入該包即可。所以為了驗證，需要新建一個項目，並引入該 common包。
@ServicepublicclassLicenceServiceextendsServiceImpl<LicenceMapper,Licence>{@AutowiredprivateOrganizationClientorganizationClient;/***查詢{@linkLicence}詳情*@paramlicenceId*@return*/publicLicenceDTOqueryDetail(LonglicenceId){Licencelicence=this.getById(licenceId);checkNotNull(licence);OrganizationDTOorg=ClientUtil.execute(()->organizationClient.getOrganization(licence.getOrganizationId()));returntoLicenceDTO(licence,org);}/***分頁獲取*@paramlicenceParam分頁查詢參數*@return*/publicQueryData<SimpleLicenceDTO>getLicences(LicenceParamlicenceParam){StringlicenceType=licenceParam.getLicenceType();LicenceTypeEnumlicenceTypeEnum=LicenceTypeEnum.parseOfNullable(licenceType);//斷言,非空ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);LambdaQueryWrapper<Licence>wrapper=newLambdaQueryWrapper<>();wrapper.eq(Licence::getLicenceType,licenceType);IPage<Licence>page=this.page(newQueryPage<>(licenceParam),wrapper);returnnewQueryData<>(page,this::toSimpleLicenceDTO);}/***新增{@linkLicence}*@paramrequest請求體*@return*/@Transactional(rollbackFor=Throwable.class)publicLicenceAddRespDataaddLicence(LicenceAddRequestrequest){Licencelicence=newLicence();licence.setOrganizationId(request.getOrganizationId());licence.setLicenceType(request.getLicenceType());licence.setProductName(request.getProductName());licence.setLicenceMax(request.getLicenceMax());licence.setLicenceAllocated(request.getLicenceAllocated());licence.setComment(request.getComment());this.save(licence);returnnewLicenceAddRespData(licence.getLicenceId());}/***entity->simpledto*@paramlicence{@linkLicence}entity*@return{@linkSimpleLicenceDTO}*/privateSimpleLicenceDTOtoSimpleLicenceDTO(Licencelicence){//省略}/***entity->dto*@paramlicence{@linkLicence}entity*@paramorg{@linkOrganizationDTO}*@return{@linkLicenceDTO}*/privateLicenceDTOtoLicenceDTO(Licencelicence,OrganizationDTOorg){//省略}/***校驗{@linkLicence}存在*@paramlicence*/privatevoidcheckNotNull(Licencelicence){ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);}}小結測試的異常都能夠被捕獲，然後以 code、message 的形式返回。每一個項目/模塊，在定義業務異常的時候，只需定義一個枚舉類，然後實現接口 BusinessExceptionAssert，最後為每一種業務異常定義對應的枚舉實例即可，而不用定義許多異常類。使用的時候也很方便，用法類似斷言。
總結使用 斷言 和 枚舉類 相結合的方式，再配合統一異常處理，基本大部分的異常都能夠被捕獲。
為什麼說大部分異常，因為當引入 spring cloud security 後，還會有認證/授權異常，網關的服務降級異常、跨模塊調用異常、遠程調用第三方服務異常等，這些異常的捕獲方式與本文介紹的不太一樣。
另外，當需要考慮國際化的時候，捕獲異常後的異常信息一般不能直接返回，需要轉換成對應的語言，不過本文已考慮到了這個，獲取消息的時候已經做了國際化映射，邏輯如下：
推薦
Java面試題寶典
技術內卷群，一起來學習！！
PS：因為公眾號平台更改了推送規則，如果不想錯過內容，記得讀完點一下「在看」，加個「星標」，這樣每次新文章推送才會第一時間出現在你的訂閱列表里。點「在看」支持我們吧！
留言列表