目录
理解AOP
什么是AOP
AOP体系与概念
AOP实例
第一个实例
第二个实例
AOP相关注解
@Pointcut
@Around
@Before
@After
@AfterReturning
@AfterThrowing
1 理解AOP
1.1 什么是AOP
AOP(Aspect Oriented Programming),面向切面思想,是Spring的三大核心思想之一(两外两个:IOC-控制反转、DI-依赖注入)。
那么AOP为何那么重要呢?在我们的程序中,经常存在一些系统性的需求,比如权限校验、日志记录、统计等,这些代码会散落穿插在各个业务逻辑中,非常冗余且不利于维护。例如下面这个示意图:
有多少业务操作,就要写多少重复的校验和日志记录代码,这显然是无法接受的。当然,用面向对象的思想,我们可以把这些重复的代码抽离出来,写成公共方法,就是下面这样:
这样,代码冗余和可维护性的问题得到了解决,但每个业务方法中依然要依次手动调用这些公共方法,也是略显繁琐。有没有更好的方式呢?有的,那就是AOP,AOP将权限校验、日志记录等非业务代码完全提取出来,与业务代码分离,并寻找节点切入业务代码中:
1.2 AOP体系与概念
简单地去理解,其实AOP要做三类事:
在哪里切入,也就是权限校验等非业务操作在哪些业务代码中执行。
在什么时候切入,是业务代码执行前还是执行后。
切入后做什么事,比如做权限校验、日志记录等。
因此,AOP的体系可以梳理为下图:
一些概念详解:
:切点,决定处理如权限校验、日志记录等在何处切入业务代码中(即织入切面)。切点分为方式和方式。前者可以用路径表达式指定哪些类织入切面,后者可以指定被哪些注解修饰的代码织入切面。
:处理,包括处理时机和处理内容。处理内容就是要做什么事,比如校验权限和记录日志。处理时机就是在什么时机执行处理内容,分为前置处理(即业务代码执行前)、后置处理(业务代码执行后)等。
:切面,即和。
:连接点,是程序执行的一个点。例如,一个方法的执行或者一个异常的处理。在 Spring AOP 中,一个连接点总是代表一个方法执行。
:织入,就是通过动态代理,在目标对象方法中执行处理内容的过程。
网络上有张图,我觉得非常传神,贴在这里供大家观详:
2 AOP实例
实践出真知,接下来我们就撸代码来实现一下AOP。完成项目已上传至:
https://github.com/ThinkMugz/aopDemo
2.1 第一个实例
接下来,我们先看一个极简的例子:所有的请求被调用前在控制台输出一句"get请求的advice触发了"。
具体实现如下:
创建一个AOP切面类,只要在类上加个 注解即可。 注解用来描述一个切面类,定义切面类的时候需要打上这个注解。 注解将该类交给 Spring 来管理。在这个类里实现advice:
创建一个接口类,内部创建一个get请求:
项目启动后,请求接口:
在这里插入图片描述
请求接口,控制台无输出,证明切点确实是只针对被修饰的方法。
2.2 第二个实例
下面我们将问题复杂化一些,该例的场景是:
自定义一个注解
创建一个切面类,切点设置为拦截所有标注的方法,截取到接口的参数,进行简单的权限校验
将标注在测试接口类的测试接口上
具体的实现步骤:
使用自定义一个注解:
创建第一个AOP切面类,,只要在类上加个 注解即可。 注解用来描述一个切面类,定义切面类的时候需要打上这个注解。 注解将该类交给 Spring 来管理。在这个类里实现第一步权限校验逻辑:
创建接口类,并在目标方法上标注自定义注解 :
在这里,我们先进行一个测试。首先,填好请求地址和header:
其次,构造正常的参数:
可以拿到正常的响应结果:
然后,构造一个异常参数,再次请求:
响应结果显示,切面类进行了判断,并返回相应结果:
有人会问,如果我一个接口想设置多个切面类进行校验怎么办?这些切面的执行顺序如何管理?
很简单,一个自定义的注解可以对应多个切面类,这些切面类执行顺序由注解管理,该注解后的数字越小,所在切面类越先执行。
下面在实例中进行演示:
创建第二个AOP切面类,在这个类里实现第二步权限校验:
重启项目,继续测试,构造两个参数都异常的情况:
响应结果,表面第二个切面类执行顺序更靠前:
3 AOP相关注解
上面的案例中,用到了诸多注解,下面针对这些注解进行详解。
3.1 @Pointcut
注解,用来定义一个切面,即上文中所关注的某件事情的入口,切入点定义了事件触发时机。
@Pointcut 注解指定一个切面,定义需要拦截的东西,这里介绍两个常用的表达式:一个是使用 ,另一个是使用 。
execution表达式:
以 表达式为例:
annotation() 表达式:
方式是针对某个注解来定义切面,比如我们对具有 @PostMapping 注解的方法做切面,可以如下定义切面:
然后使用该切面的话,就会切入注解是 的所有方法。这种方式很适合处理 不同注解有各种特定处理逻辑的场景。
还有就是如上面案例所示,针对自定义注解来定义切面。
3.2 @Around
注解用于修饰增强处理,增强处理非常强大,表现在:
可以自由选择增强动作与目标方法的执行顺序,也就是说可以在增强动作前后,甚至过程中执行目标方法。这个特性的实现在于,调用参数的方法才会执行目标方法。
可以改变执行目标方法的参数值,也可以改变执行目标方法之后的返回值。
增强处理有以下特点:
当定义一个增强处理方法时,该方法的第一个形参必须是 类型(至少一个形参)。在增强处理方法体内,调用的方法才会执行目标方法:这就是增强处理可以完全控制目标方法执行时机、如何执行的关键;如果程序没有调用的方法,则目标方法不会执行。
调用的方法时,还可以传入一个对象,该数组中的值将被传入目标方法作为实参——这就是增强处理方法可以改变目标方法参数值的关键。这就是如果传入的数组长度与目标方法所需要的参数个数不相等,或者数组元素与目标方法所需参数的类型不匹配,程序就会出现异常。
功能虽然强大,但通常需要在线程安全的环境下使用。因此,如果使用普通的、就能解决的问题,就没有必要使用了。如果需要目标方法执行之前和之后共享某种状态数据,则应该考虑使用。尤其是需要使用增强处理阻止目标的执行,或需要改变目标方法的返回值时,则只能使用增强处理了。
下面,在前面例子上做一些改造,来观察的特点。
自定义注解类不变。首先,定义接口类:
唯一切面类(前面案例有两个切面类,这里只需保留一个即可):
同样使用JMeter调用接口,传入参数:,响应结果表明:截取到了接口的入参,并使接口返回了切面类中的结果。
3.3 @Before
注解指定的方法在切面切入目标方法之前执行,可以做一些 处理,也可以做一些信息的统计,比如获取用户的请求 以及用户的 地址等等,这个在做个人站点的时候都能用得到,都是常用的方法。例如下面代码:
对象很有用,可以用它来获取一个签名,利用签名可以获取请求的包名、方法名,包括参数(通过 获取)等。
3.4 @After
注解和 注解相对应,指定的方法在切面切入目标方法之后执行,也可以做一些完成某方法之后的 Log 处理。
到这里,我们来写个 Controller 测试一下执行结果,新建一个 AopController 如下:
启动项目,在浏览器中输入:localhost:8080/aop/csdn,观察一下控制台的输出信息:
从打印出来的 中可以看出程序执行的逻辑与顺序,可以很直观的掌握 和 两个注解的实际作用。
3.5 @AfterReturning
注解和 有些类似,区别在于 注解可以用来捕获切入方法执行完之后的返回值,对返回值进行业务逻辑上的增强处理,例如:
需要注意的是,在 注解 中,属性 的值必须要和参数保持一致,否则会检测不到。该方法中的第二个入参就是被切方法的返回值,在 方法中可以对返回值进行增强,可以根据业务需要做相应的封装。我们重启一下服务,再测试一下:
3.6 @AfterThrowing
当被切方法执行过程中抛出异常时,会进入 注解的方法中执行,在该方法中可以做一些异常的处理逻辑。要注意的是 属性的值必须要和参数一致,否则会报错。该方法中的第二个入参即为抛出的异常。
以上就是AOP的全部内容。通过几个例子就可以感受到,AOP的便捷之处。欢迎大家指出文中不足之处,喜欢的朋友来个一键三连,听说这么做的人offer拿到手软( ω )y
转载于:猿天地