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

    文章

    8486

    浏览量

    150806
  • 代码
    +关注

    关注

    30

    文章

    4741

    浏览量

    68324

原文标题:接口统一异常优雅处理介绍及实战

文章出处:【微信号:良许Linux,微信公众号:良许Linux】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    如何有效的处理空指针异常

    地遇到这个问题。 那么我们应该如何有效且优雅处理空指针异常呢? 下面了不起将详细的介绍这个处理方案。 1、什么是空指针
    的头像 发表于 09-30 10:25 1457次阅读

    如何解决液晶显示模块统一接口和显示速度的问题?

    本文提出采用内存接口的液晶显示模块,在现有点阵式液晶显示屏上附加个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 1183次阅读

    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 293次阅读

    基于Python 异常介绍以及异常处理的方法解析

    异常处理在任何门编程语言里都是值得关注的个话题,良好的异常处理可以让你的程序更加健壮,清晰的
    的头像 发表于 01-31 14:20 6243次阅读
    基于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 1059次阅读

    公司这套架构统一处理try...catch真香!

    有大量的冗余代码,而且还影响代码的可读性。这样就需要定义个全局统一异常处理器,以便业务层再也不必处理异常
    的头像 发表于 02-27 10:47 459次阅读

    SpringMVC 如何优雅处理各种异常

    那有没有种方案,既不需要跟Controller耦合,也可以将定义的 异常处理器 应用到所有控制器呢?所以注解@ControllerAdvice出现了,简单的说,该注解可以把异常
    发表于 05-29 16:00 506次阅读
    SpringMVC 如何<b class='flag-5'>优雅</b>的<b class='flag-5'>处理</b>各种<b class='flag-5'>异常</b>?

    异常处理和错误码管理

    团队达成共识,统一规范就可以。 下面介绍下我使用的处理异常的方式。 自定义异常 创建
    的头像 发表于 09-25 14:51 689次阅读
    <b class='flag-5'>异常</b><b class='flag-5'>处理</b>和错误码管理

    站式统一返回值封装、异常处理异常错误码解决方案—最强的Sping Boot接口优雅响应处理

    1. 前言 统一返回值封装、统一异常处理异常错误码体系的意义在于提高代码的可维护性和可读性,使得代码更加健壮和稳定。
    的头像 发表于 06-20 15:42 450次阅读