我要投搞

标签云

收藏小站

爱尚经典语录、名言、句子、散文、日志、唯美图片

当前位置:金算盘心水论坛 > 抛出异常 >

统一异常处理介绍及实战

归档日期:07-05       文本归类:抛出异常      文章编辑:爱尚语录

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

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

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

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

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

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

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

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

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

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

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

  注:因为整个统一异常处理方案涉及的代码比较多,这里不方便贴出所有代码,只会贴出关键部分,所以建议将源码clone到本地方便查看。源码地址:,涉及到的项目包括:spring-cloud-advance-common、unified-exception-handling。

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

  有没有感觉第一种判定非空的写法很优雅,第二种写法则是相对丑陋的if {...}代码块。那么

  神奇的Assert.notNull背后到底做了什么呢?下面是Assert的部分源码:

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

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

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

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

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

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

  // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.

  可以看到,上面将异常分成几类,实际上只有两大类,一类是ServletException、ServiceException,还记得上文提到的按阶段分类吗,即对应 进入Controller前的异常 和Service层异常;然后ServiceException再分成自定义异常、未知异常。对应关系如下:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  由于国际化相关知识不属于本文介绍的范畴,所以不过多说明,以后也会有单独的文章介绍。返回搜狐,查看更多

本文链接:http://izytravel.com/paochuyichang/366.html