色哟哟视频在线观看-色哟哟视频在线-色哟哟欧美15最新在线-色哟哟免费在线观看-国产l精品国产亚洲区在线观看-国产l精品国产亚洲区久久

0
  • 聊天消息
  • 系統消息
  • 評論與回復
登錄后你可以
  • 下載海量資料
  • 學習在線課程
  • 觀看技術視頻
  • 寫文章/發帖/加入社區
會員中心
創作中心

完善資料讓更多小伙伴認識你,還能領取20積分哦,立即完善>

3天內不再提示

接口統一異常優雅處理介紹及實戰

dyquk4xk2p3d ? 來源:sprainkle ? 2023-10-22 16:01 ? 次閱讀

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

ac5766a2-70b0-11ee-939d-92fbcf53809c.jpg

丑陋的 try catch 代碼塊

ac61138c-70b0-11ee-939d-92fbcf53809c.jpg

優雅的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層異常,具體可以參考下圖:

ac73719e-70b0-11ee-939d-92fbcf53809c.png

不同階段的異常

目標

消滅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
publicvoidtest1(){
...
Useruser=userDao.selectById(userId);
Assert.notNull(user,"用戶不存在.");
...
}

@Test
publicvoidtest2(){
//另一種寫法
Useruser=userDao.selectById(userId);
if(user==null){
thrownewIllegalArgumentException("用戶不存在.");
}
}

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

publicabstractclassAssert{
publicAssert(){
}

publicstaticvoidnotNull(@NullableObjectobject,Stringmessage){
if(object==null){
thrownewIllegalArgumentException(message);
}
}
}

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

Assert

publicinterfaceAssert{
/**
*創建異常
*@paramargs
*@return
*/
BaseExceptionnewException(Object...args);

/**
*創建異常
*@paramt
*@paramargs
*@return
*/
BaseExceptionnewException(Throwablet,Object...args);

/**
*

斷言對象obj非空。如果對象obj為空,則拋出異常 * *@paramobj待判斷對象 */ defaultvoidassertNotNull(Objectobj){ if(obj==null){ thrownewException(obj); } } /** *

斷言對象obj非空。如果對象obj為空,則拋出異常 *

異常信息message支持傳遞參數方式,避免在判斷之前進行字符串拼接操作 * *@paramobj待判斷對象 *@paramargsmessage占位符對應的參數列表 */ defaultvoidassertNotNull(Objectobj,Object...args){ if(obj==null){ thrownewException(args); } } }

注:

這里只給出Assert接口的部分源碼,更多斷言方法請參考源碼。

BaseException是所有自定義異常的基類。

在接口中定義默認方法是Java8的新語法。

上面的Assert斷言方法是使用接口的默認方法定義的,然后有沒有發現當斷言失敗后,拋出的異常不是具體的某個異常,而是交由2個newException接口方法提供。因為業務邏輯中出現的異常基本都是對應特定的場景,比如根據用戶id獲取用戶信息,查詢結果為null,此時拋出的異常可能為UserNotFoundException,并且有特定的異常碼(比如7001)和異常信息“用戶不存在”。所以具體拋出什么異常,有Assert的實現類決定。

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

善解人意的Enum

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

publicinterfaceIResponseEnum{
intgetCode();
StringgetMessage();
}
/**
*

業務異常

*

業務處理時,出現異常,可以拋出該異常

*/ 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{

@Override
defaultBaseExceptionnewException(Object...args){
Stringmsg=MessageFormat.format(this.getMessage(),args);

returnnewBusinessException(this,args,msg);
}

@Override
defaultBaseExceptionnewException(Throwablet,Object...args){
Stringmsg=MessageFormat.format(this.getMessage(),args);

returnnewBusinessException(this,args,msg,t);
}

}
@Getter
@AllArgsConstructor
publicenumResponseEnumimplementsBusinessExceptionAssert{

/**
*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,就能夠針對不同情況拋出特定的異常(這里指攜帶特定的異常碼和異常消息),這樣既不用定義大量的異常類,同時還具備了斷言的良好可讀性,當然這種方案的好處遠不止這些,請繼續閱讀后文,慢慢體會。

注:上面舉的例子是針對特定的業務,而有部分異常情況是通用的,比如:服務器繁忙、網絡異常、服務器異常、參數校驗異常、404等,所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum,其中ServletResponseEnum會在后文詳細說明。

二、定義統一異常處理器類

@Slf4j
@Component
@ControllerAdvice
@ConditionalOnWebApplication
@ConditionalOnMissingBean(UnifiedExceptionHandler.class)
publicclassUnifiedExceptionHandler{
/**
*生產環境
*/
privatefinalstaticStringENV_PROD="prod";

@Autowired
privateUnifiedMessageSourceunifiedMessageSource;

/**
*當前環境
*/
@Value("${spring.profiles.active}")
privateStringprofile;

/**
*獲取國際化消息
*
*@parame異常
*@return
*/
publicStringgetMessage(BaseExceptione){
Stringcode="response."+e.getResponseEnum().toString();
Stringmessage=unifiedMessageSource.getMessage(code,e.getArgs());

if(message==null||message.isEmpty()){
returne.getMessage();
}

returnmessage;
}

/**
*業務異常
*
*@parame異常
*@return異常結果
*/
@ExceptionHandler(value=BusinessException.class)
@ResponseBody
publicErrorResponsehandleBusinessException(BaseExceptione){
log.error(e.getMessage(),e);

returnnewErrorResponse(e.getResponseEnum().getCode(),getMessage(e));
}

/**
*自定義異常
*
*@parame異常
*@return異常結果
*/
@ExceptionHandler(value=BaseException.class)
@ResponseBody
publicErrorResponsehandleBaseException(BaseExceptione){
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
})
@ResponseBody
publicErrorResponsehandleServletException(Exceptione){
log.error(e.getMessage(),e);
intcode=CommonResponseEnum.SERVER_ERROR.getCode();
try{
ServletResponseEnumservletExceptionEnum=ServletResponseEnum.valueOf(e.getClass().getSimpleName());
code=servletExceptionEnum.getCode();
}catch(IllegalArgumentExceptione1){
log.error("class[{}]notdefinedinenum{}",e.getClass().getName(),ServletResponseEnum.class.getName());
}

if(ENV_PROD.equals(profile)){
//當為生產環境,不適合把具體的異常信息展示給用戶,比如404.
code=CommonResponseEnum.SERVER_ERROR.getCode();
BaseExceptionbaseException=newBaseException(CommonResponseEnum.SERVER_ERROR);
Stringmessage=getMessage(baseException);
returnnewErrorResponse(code,message);
}

returnnewErrorResponse(code,e.getMessage());
}


/**
*參數綁定異常
*
*@parame異常
*@return異常結果
*/
@ExceptionHandler(value=BindException.class)
@ResponseBody
publicErrorResponsehandleBindException(BindExceptione){
log.error("參數綁定校驗異常",e);

returnwrapperBindingResult(e.getBindingResult());
}

/**
*參數校驗異常,將校驗失敗的所有異常組合成一條錯誤信息
*
*@parame異常
*@return異常結果
*/
@ExceptionHandler(value=MethodArgumentNotValidException.class)
@ResponseBody
publicErrorResponsehandleValidException(MethodArgumentNotValidExceptione){
log.error("參數綁定校驗異常",e);

returnwrapperBindingResult(e.getBindingResult());
}

/**
*包裝綁定異常結果
*
*@parambindingResult綁定結果
*@return異常結果
*/
privateErrorResponsewrapperBindingResult(BindingResultbindingResult){
StringBuildermsg=newStringBuilder();

for(ObjectErrorerror: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)
@ResponseBody
publicErrorResponsehandleException(Exceptione){
log.error(e.getMessage(),e);

if(ENV_PROD.equals(profile)){
//當為生產環境,不適合把具體的異常信息展示給用戶,比如數據庫異常信息.
intcode=CommonResponseEnum.SERVER_ERROR.getCode();
BaseExceptionbaseException=newBaseException(CommonResponseEnum.SERVER_ERROR);
Stringmessage=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異常,但其實默認情況下不是這樣,默認情況下會出現類似如下頁面:

ac924380-70b0-11ee-939d-92fbcf53809c.png

Whitelabel Error Page

這個頁面是如何出現的呢?實際上,當出現404的時候,默認是不拋異常的,而是forward跳轉到/error控制器,spring也提供了默認的error控制器,如下:

ac9a9f8a-70b0-11ee-939d-92fbcf53809c.png

BasicErrorController

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

spring.mvc.throw-exception-if-no-handler-found=true
spring.resources.add-mappings=false

如此,就可以異常處理器中捕獲它了,然后前端只要捕獲到特定的狀態碼,立即跳轉到404頁面即可,具體可參考Single Page Applications with Spring Boot。

acb6ba58-70b0-11ee-939d-92fbcf53809c.png

捕獲404對應的異常

統一返回結果

在驗證統一異常處理器之前,順便說一下統一返回結果。說白了,其實是統一一下返回結果的數據結構。code、message是所有返回結果中必有的字段,而當需要返回數據時,則需要另一個字段data來表示。

所以首先定義一個BaseResponse來作為所有返回結果的基類;

然后定義一個通用返回結果類CommonResponse,繼承BaseResponse,而且多了字段data;

為了區分成功和失敗返回結果,于是再定義一個ErrorResponse;

最后還有一種常見的返回結果,即返回的數據帶有分頁信息,因為這種接口比較常見,所以有必要單獨定義一個返回結果類QueryDataResponse,該類繼承自CommonResponse,只是把data字段的類型限制為QueryDdata,QueryDdata中定義了分頁信息相應的字段,即totalCount、pageNo、pageSize、records。

其中比較常用的只有CommonResponse和QueryDataResponse,但是名字又賊鬼死長,何不定義2個名字超簡單的類來替代呢?于是R和QR誕生了,以后返回結果的時候只需這樣寫:new R<>(data)、new QR<>(queryData)。

所有的返回結果類的定義這里就不貼出來了,可以直接查看源碼。

驗證統一異常處理

因為這一套統一異常處理可以說是通用的,所有可以設計成一個common包,以后每一個新項目/模塊只需引入該包即可。所以為了驗證,需要新建一個項目,并引入該common包。項目結構如下:

acd73602-70b0-11ee-939d-92fbcf53809c.png

項目結構

以后只需這樣引入即可:

aceadf0e-70b0-11ee-939d-92fbcf53809c.png

引入common包

主要代碼

下面是用于驗證的主要源碼:

@Service
publicclassLicenceServiceextendsServiceImpl{

@Autowired
privateOrganizationClientorganizationClient;

/**
*查詢{@linkLicence}詳情
*@paramlicenceId
*@return
*/
publicLicenceDTOqueryDetail(LonglicenceId){
Licencelicence=this.getById(licenceId);
checkNotNull(licence);

OrganizationDTOorg=ClientUtil.execute(()->organizationClient.getOrganization(licence.getOrganizationId()));
returntoLicenceDTO(licence,org);
}

/**
*分頁獲取
*@paramlicenceParam分頁查詢參數
*@return
*/
publicQueryDatagetLicences(LicenceParamlicenceParam){
StringlicenceType=licenceParam.getLicenceType();
LicenceTypeEnumlicenceTypeEnum=LicenceTypeEnum.parseOfNullable(licenceType);
//斷言,非空
ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);

LambdaQueryWrapperwrapper=newLambdaQueryWrapper<>();
wrapper.eq(Licence::getLicenceType,licenceType);
IPagepage=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);
}

}

ps: 這里使用的DAO框架是mybatis-plus。啟動時,自動插入的數據為:

--licence
INSERTINTOlicence(licence_id,organization_id,licence_type,product_name,licence_max,licence_allocated)
VALUES(1,1,'user','CustomerPro',100,5);
INSERTINTOlicence(licence_id,organization_id,licence_type,product_name,licence_max,licence_allocated)
VALUES(2,1,'user','suitability-plus',200,189);
INSERTINTOlicence(licence_id,organization_id,licence_type,product_name,licence_max,licence_allocated)
VALUES(3,2,'user','HR-PowerSuite',100,4);
INSERTINTOlicence(licence_id,organization_id,licence_type,product_name,licence_max,licence_allocated)
VALUES(4,2,'core-prod','WildCatApplicationGateway',16,16);

--organizations
INSERTINTOorganization(id,name,contact_name,contact_email,contact_phone)
VALUES(1,'customer-crm-co','MarkBalster','mark.balster@custcrmco.com','823-555-1212');
INSERTINTOorganization(id,name,contact_name,contact_email,contact_phone)
VALUES(2,'HR-PowerSuite','DougDrewry','doug.drewry@hr.com','920-555-1212');

開始驗證

捕獲自定義異常

獲取不存在的licence詳情:http://localhost:10000/licence/5。成功響應的請求:licenceId=1

acf6ef4c-70b0-11ee-939d-92fbcf53809c.png

校驗非空

acff7bee-70b0-11ee-939d-92fbcf53809c.png

捕獲 Licence not found 異常

ad190fb4-70b0-11ee-939d-92fbcf53809c.png

Licence not found

根據不存在的licence type獲取licence列表:http://localhost:10000/licence/list?licenceType=ddd。可選的licence type為:user、core-prod 。

ad22fec0-70b0-11ee-939d-92fbcf53809c.png

校驗非空

ad3a091c-70b0-11ee-939d-92fbcf53809c.png

捕獲 Bad licence type 異常

ad4a78ce-70b0-11ee-939d-92fbcf53809c.png

Bad licence type

捕獲進入 Controller 前的異常

訪問不存在的接口:

http://localhost:10000/licence/list/ddd

ad5acd5a-70b0-11ee-939d-92fbcf53809c.png

捕獲404異常

http 方法不支持:

http://localhost:10000/licence

ad7d38ea-70b0-11ee-939d-92fbcf53809c.png

PostMapping

ad86169a-70b0-11ee-939d-92fbcf53809c.png

捕獲 Request method not supported 異常

ada0f244-70b0-11ee-939d-92fbcf53809c.png

Request method not supported

校驗異常1:

http://localhost:10000/licence/list?licenceType=

adb1bf5c-70b0-11ee-939d-92fbcf53809c.png

getLicences

adbe38cc-70b0-11ee-939d-92fbcf53809c.png

LicenceParam

adc84bfa-70b0-11ee-939d-92fbcf53809c.png

捕獲參數綁定校驗異常

add5baf6-70b0-11ee-939d-92fbcf53809c.png

licence type cannot be empty

校驗異常2:post 請求,這里使用postman模擬

ade86322-70b0-11ee-939d-92fbcf53809c.png

addLicence

adff4db2-70b0-11ee-939d-92fbcf53809c.png

LicenceAddRequest

ae057098-70b0-11ee-939d-92fbcf53809c.png

請求url即結果

ae0d9cb4-70b0-11ee-939d-92fbcf53809c.png

捕獲參數綁定校驗異常

注:因為參數綁定校驗異常的異常信息的獲取方式與其它異常不一樣,所以才把這2種情況的異常從進入 Controller 前的異常單獨拆出來,下面是異常信息的收集邏輯:

ae26a1c8-70b0-11ee-939d-92fbcf53809c.png

異常信息的收集

捕獲未知異常

假設我們現在隨便對Licence新增一個字段test,但不修改數據庫表結構,然后訪問:http://localhost:10000/licence/1。

ae363fc0-70b0-11ee-939d-92fbcf53809c.png

增加test字段

ae4013a6-70b0-11ee-939d-92fbcf53809c.png

捕獲數據庫異常

ae5dae8e-70b0-11ee-939d-92fbcf53809c.png

Error querying database

小結

可以看到,測試的異常都能夠被捕獲,然后以code、message的形式返回。每一個項目/模塊,在定義業務異常的時候,只需定義一個枚舉類,然后實現接口BusinessExceptionAssert,最后為每一種業務異常定義對應的枚舉實例即可,而不用定義許多異常類。使用的時候也很方便,用法類似斷言。

三、擴展

在生產環境,若捕獲到未知異常或者ServletException,因為都是一長串的異常信息,若直接展示給用戶看,顯得不夠專業,于是,我們可以這樣做:當檢測到當前環境是生產環境,那么直接返回 "網絡異常"。

ae71cdb0-70b0-11ee-939d-92fbcf53809c.png

生產環境返回“網絡異常”

可以通過以下方式修改當前環境:

ae7fdc98-70b0-11ee-939d-92fbcf53809c.png

修改當前環境為生產環境

總結

使用斷言枚舉類相結合的方式,再配合統一異常處理,基本大部分的異常都能夠被捕獲。為什么說大部分異常,因為當引入spring cloud security后,還會有認證/授權異常,網關的服務降級異常、跨模塊調用異常、遠程調用第三方服務異常等,這些異常的捕獲方式與本文介紹的不太一樣,不過限于篇幅,這里不做詳細說明,以后會有單獨的文章介紹。

另外,當需要考慮國際化的時候,捕獲異常后的異常信息一般不能直接返回,需要轉換成對應的語言,不過本文已考慮到了這個,獲取消息的時候已經做了國際化映射,邏輯如下:

ae8e7a50-70b0-11ee-939d-92fbcf53809c.png

聲明:本文內容及配圖由入駐作者撰寫或者入駐合作網站授權轉載。文章觀點僅代表作者本人,不代表電子發燒友網立場。文章及其配圖僅供工程師學習之用,如有內容侵權或者其他違規問題,請聯系本站處理。 舉報投訴
  • 接口
    +關注

    關注

    33

    文章

    8580

    瀏覽量

    151030
  • 代碼
    +關注

    關注

    30

    文章

    4780

    瀏覽量

    68531

原文標題:接口統一異常優雅處理介紹及實戰

文章出處:【微信號:良許Linux,微信公眾號:良許Linux】歡迎添加關注!文章轉載請注明出處。

收藏 人收藏

    評論

    相關推薦

    如何有效的處理空指針異常

    地遇到這個問題。 那么我們應該如何有效且優雅處理空指針異常呢? 下面了不起將詳細的介紹這個處理方案。 1、什么是空指針
    的頭像 發表于 09-30 10:25 ?1510次閱讀

    如何解決液晶顯示模塊統一接口和顯示速度的問題?

    本文提出采用內存接口的液晶顯示模塊,在現有點陣式液晶顯示屏上附加個MCU(Micro-Controller Unit微處理器)及相關器件,利用內存與外部控制器進行接口,從而解決了
    發表于 06-07 06:34

    如何返回異常和中斷處理

    關于異常處理,分為三部分:ARM異常和模式:core處理異常時的操作,幾種模式介紹。Vector
    發表于 12-14 09:23

    基于VxWorks的異常處理的研究和實現

    闡述了嵌入式軟件系統中異常處理的必要性,然后基于嵌入式實時操作系統VxWorks,介紹種與具體處理器類型無關的
    發表于 01-11 09:13 ?23次下載

    Java中包、接口異常處理(exception) 實驗

    實驗 4 包、接口異常處理(exception) 、實驗目的     了解 Java 中包(package)、接口
    發表于 09-23 19:00 ?1194次閱讀

    java異常處理的設計與重構

    在程序設計中,進行異常處理是非常關鍵和重要的部分。個程序的異常處理框架的好壞直接影響到整個項
    發表于 09-27 15:40 ?1次下載
    java<b class='flag-5'>異常</b><b class='flag-5'>處理</b>的設計與重構

    java異常處理設計和些建議

    程序設計在程序設計中,進行異常處理是非常關鍵和重要的部分。個程序的異常處理框架的好壞直接影響
    發表于 09-28 11:48 ?0次下載
    java<b class='flag-5'>異常</b><b class='flag-5'>處理</b>設計和<b class='flag-5'>一</b>些建議

    Spring Boot 系列(八)@ControllerAdvice 攔截異常統一處理

    Spring Boot 系列(八)@ControllerAdvice 攔截異常統一處理 在spring 3.2中,新增了@ControllerAdvice 注解,可以用于定義
    發表于 01-16 18:39 ?304次閱讀

    基于Python 異常介紹以及異常處理的方法解析

    異常處理在任何門編程語言里都是值得關注的個話題,良好的異常處理可以讓你的程序更加健壯,清晰的
    的頭像 發表于 01-31 14:20 ?6263次閱讀
    基于Python <b class='flag-5'>異常</b>的<b class='flag-5'>介紹</b>以及<b class='flag-5'>異常</b><b class='flag-5'>處理</b>的方法解析

    Java程序設計教程之異常處理的詳細資料說明

    本文檔的詳細介紹的是Java程序設計教程之異常處理的詳細資料說明主要內容包括了:1 什么是異常,2異常
    發表于 02-22 10:27 ?13次下載
    Java程序設計教程之<b class='flag-5'>異常</b><b class='flag-5'>處理</b>的詳細資料說明

    替代try catch處理異常優雅方式

    不過跟異常處理相關的只有注解@ExceptionHandler,從字面上看,就是 異常處理器 的意思,其實際作用也是:若在某個Controller類定義
    的頭像 發表于 10-26 10:18 ?1078次閱讀

    公司這套架構統一處理try...catch真香!

    有大量的冗余代碼,而且還影響代碼的可讀性。這樣就需要定義個全局統一異常處理器,以便業務層再也不必處理異常
    的頭像 發表于 02-27 10:47 ?476次閱讀

    SpringMVC 如何優雅處理各種異常

    那有沒有種方案,既不需要跟Controller耦合,也可以將定義的 異常處理器 應用到所有控制器呢?所以注解@ControllerAdvice出現了,簡單的說,該注解可以把異常
    發表于 05-29 16:00 ?516次閱讀
    SpringMVC 如何<b class='flag-5'>優雅</b>的<b class='flag-5'>處理</b>各種<b class='flag-5'>異常</b>?

    異常處理和錯誤碼管理

    團隊達成共識,統一規范就可以。 下面介紹下我使用的處理異常的方式。 自定義異常 創建
    的頭像 發表于 09-25 14:51 ?731次閱讀
    <b class='flag-5'>異常</b><b class='flag-5'>處理</b>和錯誤碼管理

    站式統一返回值封裝、異常處理異常錯誤碼解決方案—最強的Sping Boot接口優雅響應處理

    1. 前言 統一返回值封裝、統一異常處理異常錯誤碼體系的意義在于提高代碼的可維護性和可讀性,使得代碼更加健壯和穩定。
    的頭像 發表于 06-20 15:42 ?524次閱讀
    主站蜘蛛池模板: 午夜福利体检| 忘忧草日本在线WWW日本| 棉袜足j吐奶视频| 美女视频秀色福利视频| 暖暖的高清视频在线观看免费中文| 男生扒开美女尿口戳戳| 最美白虎逼| 在线日韩欧美一区二区三区| 51久久成人国产精品麻豆| 99久久国产极品蜜臀AV酒店| 啊灬啊别停灬用力啊老师| 国产成人精品视频频| 国产亚洲精品V在线观看一| 精品一二三区久久AAA片| 免费看的一级毛片| 色欲久久精品AV无码| 亚洲欧美在无码片一区二区| 中文字幕亚洲视频| 粗好大用力好深快点漫画| 国产三级精品三级在线观看| 久久亚洲网站| 人人射人人爱| 亚洲视频中文字幕| 亚洲欧美日韩综合影院| 亚洲精品一区三区三区在线观看 | 免费一区在线观看| 日本午夜精品一区二区三区电影 | 国产亚洲精品久久久久久入口| 久久精品WWW人人爽人人| 美国色情三级欧美三级纸匠情挑| 男女后进式猛烈xx00动态图片| 甜性涩爱全集在线观看| 在线免费观看国产视频| 第一会所欧美无码原创| 久久艹综合| 视频一区国产| 总裁呻吟双腿大开男男H| 高清午夜福利电影在线| 久久视热频国只有精品| 沈阳熟女露脸对白视频| 最新国产亚洲亚洲精品视频|