0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

替代try catch处理异常的优雅方式

jf_ro2CN3Fa 来源:芋道源码 作者:芋道源码 2022-10-26 10:18 次阅读


背景

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

丑陋的 try catch 代码块

f3f92d42-54d2-11ed-a3b6-dac502259ad0.png优雅的Controller

f41fe6ee-54d2-11ed-a3b6-dac502259ad0.png

上面的示例,还只是在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 层异常,具体可以参考下图:

f42f9dfa-54d2-11ed-a3b6-dac502259ad0.png

不同阶段的异常

目标

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

统一异常处理实战

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

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

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

善解人意的Enum

自定义异常BaseException有2个属性,即codemessage,这样一对属性,有没有想到什么类一般也会定义这2个属性?没错,就是枚举类。且看我如何将 EnumAssert 结合起来,相信我一定会让你眼前一亮。如下:

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_TYPELICENCE_NOT_FOUND,分别对应了BadLicenceTypeExceptionLicenceNotFoundException两种异常。以后每增加一种异常情况,只需增加一个枚举实例即可,再也不用每一种异常都定义一个异常类了。然后再来看下如何使用,假设LicenceService有校验Licence是否存在的方法,如下:

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

若不使用断言,代码可能如下:

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

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

注:上面举的例子是针对特定的业务,而有部分异常情况是通用的,比如:服务器繁忙、网络异常、服务器异常、参数校验异常、404等,所以有CommonResponseEnumArgumentResponseEnumServletResponseEnum,其中 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());
}

}

可以看到,上面将异常分成几类,实际上只有两大类,一类是ServletExceptionServiceException,还记得上文提到的 按阶段分类 吗,即对应 进入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 过程失败了,那么抛该异常;

handleBindException

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

handleValidException

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

handleBusinessException、handleBaseException

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

handleException

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

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

异于常人的404

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

f4a2476a-54d2-11ed-a3b6-dac502259ad0.png

Whitelabel Error Page

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

f4bce980-54d2-11ed-a3b6-dac502259ad0.png

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

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

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

捕获404对应的异常

统一返回结果

在验证统一异常处理器之前,顺便说一下统一返回结果。说白了,其实是统一一下返回结果的数据结构。codemessage 是所有返回结果中必有的字段,而当需要返回数据时,则需要另一个字段 data 来表示。

所以首先定义一个 BaseResponse 来作为所有返回结果的基类;

然后定义一个通用返回结果类CommonResponse,继承 BaseResponse,而且多了字段 data

为了区分成功和失败返回结果,于是再定义一个 ErrorResponse

最后还有一种常见的返回结果,即返回的数据带有分页信息,因为这种接口比较常见,所以有必要单独定义一个返回结果类 QueryDataResponse,该类继承自 CommonResponse,只是把 data 字段的类型限制为 QueryDdataQueryDdata中定义了分页信息相应的字段,即totalCountpageNopageSizerecords

其中比较常用的只有 CommonResponseQueryDataResponse,但是名字又贼鬼死长,何不定义2个名字超简单的类来替代呢?于是 RQR 诞生了,以后返回结果的时候只需这样写:new R<>(data)new QR<>(queryData)

所有的返回结果类的定义这里就不贴出来了

验证统一异常处理

因为这一套统一异常处理可以说是通用的,所有可以设计成一个 common包,以后每一个新项目/模块只需引入该包即可。所以为了验证,需要新建一个项目,并引入该 common包。

主要代码

下面是用于验证的主要源码:

@Service
publicclassLicenceServiceextendsServiceImpl<LicenceMapper,Licence>{

@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');
开始验证
捕获自定义异常

1. 获取不存在的 licence 详情:http://localhost:10000/licence/5。成功响应的请求:licenceId=1

检验非空

f527e776-54d2-11ed-a3b6-dac502259ad0.png

捕获 Licence not found 异常f60139ea-54d2-11ed-a3b6-dac502259ad0.png

Licence not found

f62a38fe-54d2-11ed-a3b6-dac502259ad0.png2. 根据不存在的 licence type 获取 licence 列表:http://localhost:10000/licence/list?licenceType=ddd。可选的 licence type 为:user、core-prod 。

校验非空

f636f526-54d2-11ed-a3b6-dac502259ad0.png

捕获 Bad licence type 异常f6596ff2-54d2-11ed-a3b6-dac502259ad0.png

Bad licence type

f68029a8-54d2-11ed-a3b6-dac502259ad0.png捕获进入 Controller 前的异常

1. 访问不存在的接口:http://localhost:10000/licence/list/ddd

捕获404异常

f688ba1e-54d2-11ed-a3b6-dac502259ad0.png

2. http 方法不支持:http://localhost:10000/licence

PostMapping

f6a5dbf8-54d2-11ed-a3b6-dac502259ad0.png

捕获 Request method not supported 异常

f6b126ac-54d2-11ed-a3b6-dac502259ad0.png

Request method not supported

f6e91fb2-54d2-11ed-a3b6-dac502259ad0.png

3. 校验异常1:http://localhost:10000/licence/list?licenceType=

getLicences

f6f9cf88-54d2-11ed-a3b6-dac502259ad0.png

LicenceParam

f72aae50-54d2-11ed-a3b6-dac502259ad0.png

捕获参数绑定校验异常

f73e5306-54d2-11ed-a3b6-dac502259ad0.png

licence type cannot be empty

f770a7ca-54d2-11ed-a3b6-dac502259ad0.png4. 校验异常2:post 请求,这里使用postman模拟

addLicence

f7cecde6-54d2-11ed-a3b6-dac502259ad0.png

LicenceAddRequest

f7eb6866-54d2-11ed-a3b6-dac502259ad0.png

请求url即结果

f7fd77b8-54d2-11ed-a3b6-dac502259ad0.png

捕获参数绑定校验异常f81e93f8-54d2-11ed-a3b6-dac502259ad0.png

注:因为参数绑定校验异常的异常信息的获取方式与其它异常不一样,所以才把这2种情况的异常从 进入 Controller 前的异常 单独拆出来,下面是异常信息的收集逻辑:

异常信息的收集

f85d1312-54d2-11ed-a3b6-dac502259ad0.png
捕获未知异常

假设我们现在随便对 Licence 新增一个字段 test,但不修改数据库表结构,然后访问:http://localhost:10000/licence/1。

增加test字段

f8935cce-54d2-11ed-a3b6-dac502259ad0.png

捕获数据库异常

f8b0a36a-54d2-11ed-a3b6-dac502259ad0.png

Error querying database

f8d12b44-54d2-11ed-a3b6-dac502259ad0.png
小结

可以看到,测试的异常都能够被捕获,然后以 codemessage 的形式返回。每一个项目/模块,在定义业务异常的时候,只需定义一个枚举类,然后实现接口 BusinessExceptionAssert,最后为每一种业务异常定义对应的枚举实例即可,而不用定义许多异常类。使用的时候也很方便,用法类似断言。

扩展

在生产环境,若捕获到 未知异常 或者 ServletException,因为都是一长串的异常信息,若直接展示给用户看,显得不够专业,于是,我们可以这样做:当检测到当前环境是生产环境,那么直接返回 "网络异常"。

生产环境返回“网络异常”

f8f18aec-54d2-11ed-a3b6-dac502259ad0.png

可以通过以下方式修改当前环境:

f9038b70-54d2-11ed-a3b6-dac502259ad0.png

修改当前环境为生产环境

总结

使用 断言枚举类 相结合的方式,再配合统一异常处理,基本大部分的异常都能够被捕获。为什么说大部分异常,因为当引入 spring cloud security 后,还会有认证/授权异常,网关的服务降级异常、跨模块调用异常、远程调用第三方服务异常等,这些异常的捕获方式与本文介绍的不太一样,不过限于篇幅,这里不做详细说明,以后会有单独的文章介绍。

另外,当需要考虑国际化的时候,捕获异常后的异常信息一般不能直接返回,需要转换成对应的语言,不过本文已考虑到了这个,获取消息的时候已经做了国际化映射,逻辑如下:

f9199190-54d2-11ed-a3b6-dac502259ad0.png

获取国际化消息

最后总结,全局异常属于老生长谈的话题,希望这次通过手机的项目对大家有点指导性的学习。大家根据实际情况自行修改。

也可以采用以下的jsonResult对象的方式进行处理,也贴出来代码.

@Slf4j
@RestControllerAdvice
publicclassGlobalExceptionHandler{

/**
*没有登录
*@paramrequest
*@paramresponse
*@parame
*@return
*/
@ExceptionHandler(NoLoginException.class)
publicObjectnoLoginExceptionHandler(HttpServletRequestrequest,HttpServletResponseresponse,Exceptione)
{
log.error("[GlobalExceptionHandler][noLoginExceptionHandler]exception",e);
JsonResultjsonResult=newJsonResult();
jsonResult.setCode(JsonResultCode.NO_LOGIN);
jsonResult.setMessage("用户登录失效或者登录超时,请先登录");
returnjsonResult;
}

/**
*业务异常
*@paramrequest
*@paramresponse
*@parame
*@return
*/
@ExceptionHandler(ServiceException.class)
publicObjectbusinessExceptionHandler(HttpServletRequestrequest,HttpServletResponseresponse,Exceptione)
{
log.error("[GlobalExceptionHandler][businessExceptionHandler]exception",e);
JsonResultjsonResult=newJsonResult();
jsonResult.setCode(JsonResultCode.FAILURE);
jsonResult.setMessage("业务异常,请联系管理员");
returnjsonResult;
}

/**
*全局异常处理
*@paramrequest
*@paramresponse
*@parame
*@return
*/
@ExceptionHandler(Exception.class)
publicObjectexceptionHandler(HttpServletRequestrequest,HttpServletResponseresponse,Exceptione)
{
log.error("[GlobalExceptionHandler][exceptionHandler]exception",e);
JsonResultjsonResult=newJsonResult();
jsonResult.setCode(JsonResultCode.FAILURE);
jsonResult.setMessage("系统错误,请联系管理员");
returnjsonResult;
}
}

欢迎大家点在

看鼓励。



审核编辑 :李倩


声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 代码
    +关注

    关注

    30

    文章

    4744

    浏览量

    68344
  • 异常处理
    +关注

    关注

    0

    文章

    14

    浏览量

    7267

原文标题:替代try catch处理异常的优雅方式

文章出处:【微信号:芋道源码,微信公众号:芋道源码】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    ARM处理器的异常中断响应过程

    ARM处理器的异常中断响应是嵌入式系统设计中一个至关重要的环节,它确保了系统在面对内部或外部事件时能够稳定、可靠地运行。
    的头像 发表于 09-10 11:18 758次阅读

    Panasonic松下焊接电异常处理

    电子发烧友网站提供《Panasonic松下焊接电异常处理.pdf》资料免费下载
    发表于 08-19 14:24 0次下载

    HarmonyOS Next原生应用开发-从TS到ArkTS的适配规则(十四)

    类型,应省略类型标注。TypeScript try { // ... } catch (a: unknown) { // 处理异常 } ArkTS
    发表于 08-16 10:20

    嵌入式C编程常用的异常错误处理

    嵌入式C编程中,异常错误处理是确保系统稳定性和可靠性的重要部分。以下是一些常见的异常错误处理方法及其详细说明和示例: 1. 断言 (Assertions) 断言用于在开发阶段捕获程
    发表于 08-06 14:32

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

    处理的逻辑集中到一个地方,避免代码中出现大量的try-catch语句,降低了代码的复杂度,提高了代码的可读性;异常体系的设计可以清晰地区分不同类型的异常,使得开发者能够更加精准地
    的头像 发表于 06-20 15:42 454次阅读

    熔纤机放电异常怎么处理

    构成威胁。因此,我们需要及时发现和处理这种异常,以确保设备的正常运行和操作人员的安全。 首先,让我们了解一下熔纤机的基本原理和构造。熔纤机主要由供料系统、加热系统、熔融区、拉伸区和收卷区组成。供料系统将原材
    的头像 发表于 04-08 16:13 1116次阅读

    变压器运行中常见的异常现象应如何处理呢?

    变压器运行中常见的异常现象应如何处理
    的头像 发表于 03-08 09:19 582次阅读
    变压器运行中常见的<b class='flag-5'>异常</b>现象应如何<b class='flag-5'>处理</b>呢?

    鸿蒙原生应用开发-ArkTS语言基础类库异步并发简述async/await

    Promise对象的解析,并将其解析值存储在result变量中。 需要注意的是,由于要等待异步操作完成,因此需要将整个操作包在async函数中。除了在async函数中使用await外,还可以使用try/catch
    发表于 03-06 14:44

    介绍C语言中错误处理异常处理的一些常用的方法和策略

    C语言是一种低级的、静态的、结构化的编程语言,它没有提供像C++或Java等高级语言中的异常处理机制,例如try-catch-finally等。
    的头像 发表于 02-28 14:25 588次阅读

    优雅停机是什么?SpringBoot+Nacos+k8s实现优雅停机

    优雅停机是什么?网上说的优雅下线、无损下线,都是一个意思。
    的头像 发表于 02-20 10:00 1886次阅读
    <b class='flag-5'>优雅</b>停机是什么?SpringBoot+Nacos+k8s实现<b class='flag-5'>优雅</b>停机

    CAN模块RxBuffer接收异常要怎么处理呢?

    Cy_CANFD_DeInit后再重新Init也没用,那部分异常的CAN消息仍无法接收到。请问在这种情况下要怎么处理呢? 现象: 1、CAN模块正常工作 2、其他中断占用过多的CPU时间 3、CAN模块异常,部分(放在
    发表于 02-01 08:10

    Service层的异常处理

    一般初学者学习编码和[错误处理]时,先知道[编程语言]有一种处理错误的形式或约定(如Java就抛异常),然后就开始用这些工具。但却忽视这问题本质:「处理错误是为了写正确程序」 。
    的头像 发表于 01-08 11:29 544次阅读

    输电线路常见异常处理原则

    输电线路常见异常处理原则  输电线路是电力系统的重要组成部分,用于将发电厂产生的电能传输到用户。然而,在输电线路的正常运行过程中,常会出现一些异常情况,如断线、短路、过载等。正确处理
    的头像 发表于 12-18 15:47 1272次阅读

    直流屏系统的操作、查询及异常处理方法

    直流屏系统的操作、查询及异常处理方法
    的头像 发表于 12-15 10:29 730次阅读
    直流屏系统的操作、查询及<b class='flag-5'>异常</b><b class='flag-5'>处理</b>方法

    Java怎么排查oom异常

    Java中的OOM(Out of Memory)异常是指当Java虚拟机的堆内存不足以容纳新的对象时抛出的异常。OOM异常是一种常见的运行时异常,经常出现在长时间运行的Java应用程序
    的头像 发表于 12-05 13:47 1212次阅读