。

如果对系统异常的情况不做处理#xff0c;Springboot本身会默认将错误异常作为接口的请求返回。

public

在日常项目中我们难免会遇到系统错误的情况。

如果对系统异常的情况不做处理Springboot本身会默认将错误异常作为接口的请求返回。

public

从上图可以看到Springboot没有对异常进行处理的情况下将错误的堆栈直接当做响应数据返回了。

这样对用户既不友好又可能因为泄漏系统堆栈信息引发潜在的安全风险。

因此搭建一个完善的异常处理机制对于维护系统健壮性是十分必要的。

要快速的搭建异常处理机制那么需要考虑如何对异常进行捕获并加以处理最便捷的方法便是用**ExceptionHandler**注解实现。

ExceptionHandler(MyException.class)protected

ResponseEntityObject

ResultDTO().fail(ResultCodeEnum.ERROR_SERVER),

HttpStatus.OK);}​

通过在Controller内添加上述的异常处理代码Springboot就可以将相关的错误信息转义成系统的统一错误处理进而避免堆栈外露。

(这里的ResultDTO是系统内自定义的JSON结构可以根据自己的业务自行修改。

)

然而ExceptionHandler本身存在一个弊端就是他作用的范围必须是Controller也就意味着有多少个Controller你的异常处理代码便要重复写多遍这无疑是低效率的。

为了减少重复的代码冗余ControllerAdvance就进入了我们的视野。

ControllerAdvice

{ExceptionHandler(Exception.class)protected

ResponseEntityObject

ResultDTO().fail(ResultCodeEnum.ERROR_SERVER),

HttpStatus.OK);}

简单来说ControllerAdvance是一个全局处理的注解其中的代码会对所有的Controller生效通常会搭配ExceptionHandler处理异常由此以来就可以实现只编写一次异常处理方法就可以处理全局异常的情况。

至于ControllerAdvance和ExceptionHandler是如何实现这个神奇的功能的限于篇幅原因后续会考虑单独出一篇文章详细介绍。

其实根据名字不难推断ControllerAdvance就是一种针对于Controller对象的动态代理罢了。

个性化异常处理

用了ControllerAdvance和ExceptionHandler几乎可以解决80%的项目面临的报错处理问题。

然而思考一下。

如果一个项目中出现了多组人同时维护、迭代一个系统的时候降本增效嘛懂的都懂每组人要关注的报错自然会不一样。

如A组人只关注报错AB组人员只关注报错B那么这种通用的异常解决方案是无法区分开的。

针对于这种情况就不得不请出另外一位大佬了他就是AOP针对于动态代理有很多的实现方式和框架这里我们直接默认采用SpringBoot的自带AOP框架

dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-aop/artifactIdversion2.1.11.RELEASE/version

/dependency​

不管选择的AOP实现框架是什么要采用AOP编码都少不了以下两个步骤

1、定义切点和执行时机哪些地方要做增强

对于Springboot自带的AOP框架其执行时机共有以下五个

增强时机增强类型异同点After后置增强目标方法执行之后调用增强方法Before前置增强目标方法执行之前先调用增强方法AfterReturning返回增强目标方法执行return之后返回结果之前调用增强方法如果出异常则不执行AfterThrowing异常增强目标方法执行产生异常调用增强方法需注意的是处理后异常依旧会往上抛出不会被catch。

Around环绕增强环绕增强包含前面四种增强通过一定的try-catch处理环绕类型可以替代上述的任意一种增强。

了解了SpringBoot的动态代理的执行时机之后我们还需要知道其定义切点的方式。

框架定义切点的方式主要有两个

切点表达式

我们首先介绍注释的正确打开方式。

要通过注解来实现自己的AOP那么首先需要定义一个新的注解。

这里我简单定义了一个注解

ElementType.METHOD,

Retention(RetentionPolicy.RUNTIME)

Documented

在定义了注解以后将注解定义为方法的入参并通过annotation()标注出注解的变量名称由此就可以实现注解AOP的功能。

Around(value

name.SERVER_NAME();//处理异常return

serverName);

ResultDTO().success(Boolean.TRUE);

}切点表达式

Springboot的AOP中还提供了一种十分强大的实现动态代理切点标注的方式即切点表达式其基本模式如下所示

ret-type-pattern

注意到modifiers-pattern?、declaring-type-pattern?、throws-pattern?等携带问号的参数都是非必填的。

紧接着我们来逐一介绍上述参数的含义

modifiers-pattern?修饰符匹配主要表示的是切点是public/private/protected/default的哪一种。

ret-type-pattern顾名思义指的是返回值的类型常见如void/Boolean/String等declaring-type-pattern?这个指的是被增强的方法、属性的类路径如com.example.demo.service.aop.MyAspect等name-pattern(param-pattern)这个是相对关键的参数指的是被增强的方法名称以及其对应的参数类型。

throws-patternthrow-pattern见词知意可以知道它是指的方法所抛出的异常类型。

除了了解了上述的表达式的基本匹配含义以外还有几个特殊的符号通配指的提一下

*****匹配任何数量字符

…匹配任何数量字符的重复如在类型模式中匹配任何数量子包而在方法参数模式中匹配任何数量参数0个或者多个参数

也许上面的代码和介绍让你一脸懵逼没关系可以简单看下下面两个表达式的含义你就大致明白他们的含义了

1、代表【返回值任意】且前缀为【com.example.demo.rpc】的【任意类下】【任意名称】的【所有参数】方法

execution(*

com.example.demo.rpc.*.*(..))//

2、代表【返回值为Boolean】且位于【com.example.demo.rpc及其子包下】的【任意名称】的【以String为最后一个入参数】的方法

execution(Boolean

String))借助于切面表达式我们可以很自由灵活地定义出我们的切点从而通过AOP实现我们对于异常的处理

String))

一、借助于ControllerAdvance和ExceptionHandler实现的通用异常处理方法

两者其实本质上的实现思路都是一样的通过对执行代码做动态代理从而将错误包装起来达到异常不外漏的效果。

在实际业务场景中方法一几乎可以涵盖80%的异常处理场景。

方案二则主要针对一个系统中需要做个性化处理的情况可以根据具体的业务需要进行选择。

参考文献