异常处理器说明
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
异常,但其实默认情况下不是这样,默认情况下会出现类似如下页面:
Whitelabel Error Page
这个页面是如何出现的呢?实际上,当出现404的时候,默认是不抛异常的,而是 forward
跳转到/error
控制器,spring
也提供了默认的error
控制器,如下:
BasicErrorController
那么,如何让404也抛出异常呢,只需在properties
文件中加入如下配置即可:
spring.mvc.throw-exception-if-no-handler-found=true spring.resources.add-mappings=false
如此,就可以异常处理器中捕获它了,然后前端只要捕获到特定的状态码,立即跳转到404页面即可,具体可参考Single Page Applications with Spring Boot。
捕获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
包。项目结构如下:
项目结构
以后只需这样引入即可:
引入common包
主要代码
下面是用于验证的主要源码:
@Service public class LicenceService extends ServiceImpl<LicenceMapper, Licence> { @Autowired private OrganizationClient organizationClient; /** * 查询{@link Licence} 详情 * @param licenceId * @return */ public LicenceDTO queryDetail(Long licenceId) { Licence licence = this.getById(licenceId); checkNotNull(licence); OrganizationDTO org = ClientUtil.execute(() -> organizationClient.getOrganization(licence.getOrganizationId())); return toLicenceDTO(licence, org); } /** * 分页获取 * @param licenceParam 分页查询参数 * @return */ public QueryData<SimpleLicenceDTO> getLicences(LicenceParam licenceParam) { String licenceType = licenceParam.getLicenceType(); LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum.parseOfNullable(licenceType); // 断言, 非空 ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum); LambdaQueryWrapper<Licence> wrapper = new LambdaQueryWrapper<>(); wrapper.eq(Licence::getLicenceType, licenceType); IPage<Licence> page = this.page(new QueryPage<>(licenceParam), wrapper); return new QueryData<>(page, this::toSimpleLicenceDTO); } /** * 新增{@link Licence} * @param request 请求体 * @return */ @Transactional(rollbackFor = Throwable.class) public LicenceAddRespData addLicence(LicenceAddRequest request) { Licence licence = new Licence(); 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); return new LicenceAddRespData(licence.getLicenceId()); } /** * entity -> simple dto * @param licence {@link Licence} entity * @return {@link SimpleLicenceDTO} */ private SimpleLicenceDTO toSimpleLicenceDTO(Licence licence) { // 省略 } /** * entity -> dto * @param licence {@link Licence} entity * @param org {@link OrganizationDTO} * @return {@link LicenceDTO} */ private LicenceDTO toLicenceDTO(Licence licence, OrganizationDTO org) { // 省略 } /** * 校验{@link Licence}存在 * @param licence */ private void checkNotNull(Licence licence) { ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence); } }
ps: 这里使用的DAO框架是
mybatis-plus
。 启动时,自动插入的数据为:
-- licence INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated) VALUES (1, 1, 'user','CustomerPro', 100,5); INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated) VALUES (2, 1, 'user','suitability-plus', 200,189); INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated) VALUES (3, 2, 'user','HR-PowerSuite', 100,4); INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated) VALUES (4, 2, 'core-prod','WildCat Application Gateway', 16,16); -- organizations INSERT INTO organization (id, name, contact_name, contact_email, contact_phone) VALUES (1, 'customer-crm-co', 'Mark Balster', 'mark.balster@custcrmco.com', '823-555-1212'); INSERT INTO organization (id, name, contact_name, contact_email, contact_phone) VALUES (2, 'HR-PowerSuite', 'Doug Drewry','doug.drewry@hr.com', '920-555-1212');
开始验证
捕获自定义异常
- 获取不存在的
licence
详情:http://localhost:10000/licence/5。成功响应的请求:licenceId=1
校验非空
捕获 Licence not found 异常Licence not found
- 根据不存在的
licence type
获取licence
列表:http://localhost:10000/licence/list?licenceType=ddd。可选的licence type
为:user、core-prod 。
校验非空
捕获 Bad licence type 异常Bad licence type
捕获进入 Controller 前的异常
- 访问不存在的接口:
http://localhost:10000/licence/list/ddd
捕获404异常 - http 方法不支持:
http://localhost:10000/licence
PostMapping
捕获 Request method not supported 异常Request method not supported
- 校验异常1:
http://localhost:10000/licence/list?licenceType=
getLicences
LicenceParam捕获参数绑定校验异常licence type cannot be empty
- 校验异常2:post 请求,这里使用postman模拟。
addLicence
LicenceAddRequest请求url即结果捕获参数绑定校验异常
注:因为参数绑定校验异常的异常信息的获取方式与其它异常不一样,所以才把这2种情况的异常从 进入 Controller 前的异常 单独拆出来,下面是异常信息的收集逻辑:
异常信息的收集
捕获未知异常
假设我们现在随便对 Licence
新增一个字段 test
,但不修改数据库表结构,然后访问:http://localhost:10000/licence/1。
增加test字段捕获数据库异常Error querying database
小结
可以看到,测试的异常都能够被捕获,然后以 code
、message
的形式返回。每一个项目/模块,在定义业务异常的时候,只需定义一个枚举类,然后实现接口 BusinessExceptionAssert
,最后为每一种业务异常定义对应的枚举实例即可,而不用定义许多异常类。使用的时候也很方便,用法类似断言。
扩展
在生产环境,若捕获到 未知异常 或者 ServletException
,因为都是一长串的异常信息,若直接展示给用户看,显得不够专业,于是,我们可以这样做:当检测到当前环境是生产环境,那么直接返回 "网络异常"。
生产环境返回“网络异常”
可以通过以下方式修改当前环境:
修改当前环境为生产环境
总结
使用 断言 和 枚举类 相结合的方式,再配合统一异常处理,基本大部分的异常都能够被捕获。为什么说大部分异常,因为当引入 spring cloud security
后,还会有认证/授权异常,网关的服务降级异常、跨模块调用异常、远程调用第三方服务异常等,这些异常的捕获方式与本文介绍的不太一样,不过限于篇幅,这里不做详细说明,以后会有单独的文章介绍。
另外,当需要考虑国际化的时候,捕获异常后的异常信息一般不能直接返回,需要转换成对应的语言,不过本文已考虑到了这个,获取消息的时候已经做了国际化映射,逻辑如下:
获取国际化消息
由于国际化相关知识不属于本文介绍的范畴,所以不过多说明,以后也会有单独的文章介绍。