打开

别再写满屏的 try catch 了!求求你们了

subtitle
波波影视剧 2021-07-25 03:10
打开网易新闻 查看更多图片

来自:java基基

背景

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

丑陋的 try catch 代码块

优雅的Controller

上面的示例,还只是在层,如果是在层,可能会有更多的代码块。这将会严重影响代码的可读性、“美观性”。

所以如果是我的话,我肯定偏向于第二种,我可以把更多的精力放在业务代码的开发,同时代码也会变得更加简洁。

既然业务代码不显式地对异常进行捕获、处理,而异常肯定还是处理的,不然系统岂不是动不动就崩溃了,所以必须得有其他地方捕获并处理这些异常。

那么问题来了,如何优雅的处理各种异常?

在3.2版本增加了一个注解,可以与、、 等注解配套使用,对于这几个注解的作用,这里不做过多赘述,若有不了解的,可以参考Spring3.2新注解@ControllerAdvice,先大概有个了解。

不过跟异常处理相关的只有注解,从字面上看,就是

异常处理器

的意思,其实际作用也是:若在某个类定义一个异常处理方法,并在方法上添加该注解,那么当出现指定的异常时,会执行该处理异常的方法,其可以使用springmvc提供的数据绑定,比如注入HttpServletRequest等,还可以接受一个当前抛出的Throwable对象。

但是,这样一来,就必须在每一个类都定义一套这样的异常处理方法,因为异常可以是各种各样。这样一来,就会造成大量的冗余代码,而且若需要新增一种异常的处理逻辑,就必须修改所有类了,很不优雅。

当然你可能会说,那就定义个类似的基类,这样总行了吧。

这种做法虽然没错,但仍不尽善尽美,因为这样的代码有一定的侵入性和耦合性。简简单单的,我为啥非得继承这样一个基类呢,万一已经继承其他基类了呢。大家都知道只能继承一个类。

那有没有一种方案,既不需要跟耦合,也可以将定义的

异常处理器

应用到所有控制器呢?所以注解出现了,简单的说,该注解可以把异常处理器应用到所有控制器,而不是单个控制器。借助该注解,我们可以实现:在独立的某个地方,比如单独一个类,定义一套对各种异常的处理机制,然后在类的签名加上注解,统一对 、 进行处理。这就是统一异常处理的原理。

注意到上面对异常按阶段进行分类,大体可以分成:进入前的异常 和 层异常,具体可以参考下图:

不同阶段的异常

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

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

想必 大家都很熟悉,比如 家族的 ,在我们写测试用例的时候经常会用到,使用断言能让我们编码的时候有一种非一般丝滑的感觉,比如:

有没有感觉第一种判定非空的写法很优雅,第二种写法则是相对丑陋的 代码块。那么 神奇的 背后到底做了什么呢?下面是 的部分源码:

可以看到, 其实就是帮我们把 封装了一下,是不是很神奇。虽然很简单,但不可否认的是编码体验至少提升了一个档次。那么我们能不能模仿,也写一个断言类,不过断言失败后抛出的异常不是 这些内置异常,而是我们自己定义的异常。下面让我们来尝试一下。

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

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

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

看到这里,有没有眼前一亮的感觉,代码示例中定义了两个枚举实例:、,分别对应了、两种异常。以后每增加一种异常情况,只需增加一个枚举实例即可,再也不用每一种异常都定义一个异常类了。然后再来看下如何使用,假设有校验是否存在的方法,如下:

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

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

注:上面举的例子是针对特定的业务,而有部分异常情况是通用的,比如:服务器繁忙、网络异常、服务器异常、参数校验异常、404等,所以有、、,其中 会在后文详细说明。

可以看到,上面将异常分成几类,实际上只有两大类,一类是、,还记得上文提到的

按阶段分类

吗,即对应 进入前的异常 和 层异常;然后 再分成自定义异常、未知异常。对应关系如下:

进入前的异常: handleServletException、handleBindException、handleValidException

自定义异常: handleBusinessException、handleBaseException

未知异常: handleException

接下来分别对这几种异常处理器做详细说明。

handleServletException

一个请求,在到达前,会对该请求的请求信息与目标控制器信息做一系列校验。这里简单说一下:

NoHandlerFoundException:首先根据请求查找有没有对应的控制器,若没有则会抛该异常,也就是大家非常熟悉的异常;

HttpRequestMethodNotSupportedException:若匹配到了(匹配结果是一个列表,不同的是方法不同,如:Get、Post等),则尝试将请求的方法与列表的控制器做匹配,若没有对应方法的控制器,则抛该异常;

HttpMediaTypeNotSupportedException:然后再对请求头与控制器支持的做比较,比如请求头,若控制器的参数签名包含注解,但是请求的请求头的值没有包含,那么会抛该异常(当然,不止这种情况会抛这个异常);

MissingPathVariableException:未检测到路径参数。比如url为:,参数签名包含,当请求的url为,在没有明确定义url为的情况下,会被判定为:缺少路径参数;

MissingServletRequestParameterException:缺少请求参数。比如定义了参数@RequestParam("licenceId") String licenceId,但发起请求时,未携带该参数,则会抛出该异常;

TypeMismatchException: 参数类型匹配失败。比如:接收参数为Long型,但传入的值确是一个字符串,那么将会出现类型转换失败的情况,这时会抛该异常;

HttpMessageNotReadableException:与上面的举的例子完全相反,即请求头携带了,但接收参数却没有添加注解,或者请求体携带的 json 串反序列化成 pojo 的过程中失败了,也会抛该异常;

HttpMessageNotWritableException:返回的 pojo 在序列化成 json 过程失败了,那么抛该异常;

handleBindException

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

handleValidException

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

handleBusinessException、handleBaseException

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

handleException

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

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

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

Whitelabel Error Page

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

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

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

捕获404对应的异常

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

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

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

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

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

其中比较常用的只有 和 ,但是名字又贼鬼死长,何不定义2个名字超简单的类来替代呢?于是 和 诞生了,以后返回结果的时候只需这样写:、。

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

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

主要代码

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

PS: 这里使用的DAO框架是。启动时,自动插入的数据为:

开始验证捕获自定义异常

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

检验非空

捕获 Licence not found 异常

Licence not found

2. 根据不存在的 获取 列表:http://localhost:10000/licence/list?licenceType=ddd。可选的 为:user、core-prod 。

校验非空

捕获 Bad licence type 异常

Bad licence type

捕获进入 Controller 前的异常

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

捕获404异常

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

PostMapping

捕获 Request method not supported 异常

Request method not supported

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

getLicences

LicenceParam

捕获参数绑定校验异常

licence type cannot be empty

4. 校验异常2:post 请求,这里使用postman模拟。

addLicence

LicenceAddRequest

请求url即结果

捕获参数绑定校验异常

注:因为参数绑定校验异常的异常信息的获取方式与其它异常不一样,所以才把这2种情况的异常从

进入 Controller 前的异常

单独拆出来,下面是异常信息的收集逻辑:

异常信息的收集

捕获未知异常

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

增加test字段

捕获数据库异常

Error querying database

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

在生产环境,若捕获到

未知异常

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

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

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

修改当前环境为生产环境

使用

断言

枚举类

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

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

获取国际化消息

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

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

END

特别声明:本文为网易自媒体平台“网易号”作者上传并发布,仅代表该作者观点。网易仅提供信息发布平台。
10赞
大家都在看打开应用 查看全部
网易热搜每30分钟更新
打开应用 查看全部
打开