Spring AOP失效之谜

>>强大,10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程!

Spring AOP失效之谜

什么是AOP
1

AOP(Aspect Oriented Programming),即面向切面编程,其是OOP(Object Oriented Programming,面向对象编程)的补充和完善。在面向对象编程的世界中,我们很容易理解OOP的思想,简单来说,OOP引入封装、继承、多态等概念来建立一种对象层次结构,这种层次结构是纵向的。虽然OOP允许开发者定义纵向的关系,但并不适合定义横向的关系,例如日志功能。日志代码往往横向地散布在所有对象层次中,而与它对应的对象的核心功能关系不大,对于其他类型的代码,如安全性检查、异常处理、事务处理等也都是如此,这种散布在各处的重复的代码被称为横切逻辑,在OOP设计中,它导致了大量代码的重复,不利于各个功能模块的重用。

AOP技术则恰恰相反,它利用一种称为"横切"的技术,剖解开封装的对象内部,并将那些影响了多个类的公共行为封装到一个可重用模块之中,并将其命名为"Aspect",即切面。所谓"切面",简单说就是将那些被多个业务模块所共同调用的逻辑封装起来,以达到减少重复代码,降低模块之间的耦合度,并提高系统的可维护性的目的。

使用"横切"技术,AOP把软件系统分为两个部分:核心关注点和横切关注点。业务处理的主要流程是核心关注点,与业务逻辑关系不大的部分是横切关注点。横切关注点的一个特点是,他们经常发生在核心关注点的多处,而各处基本相似,比如权限认证、日志、事务管理等。AOP的作用在于分离系统中的各种关注点,将核心关注点和横切关注点分离开来。

AOP示例
2

前面说了这么多,接下来我们就用Spring AOP来实现简单的日志记录功能吧。假如我们已经有了一个功能完善的用户登陆接口,现在我们需要在用户调用登陆接口的前后记录下用户的登录行为日志。要实现该功能,最简单的方法就是在原有的登录逻辑里加入日志记录代码,但是这样一来势必需要对原有的登录逻辑进行修改,容易引入新的bug,因此我们决定使用AOP来实现日志记录的功能。在本实例中,我们搭建一个Spring Boot工程,并引入Spring AOP依赖,pom文件依赖关系如下:

Spring AOP失效之谜

接着我们实现最原始的登录逻辑:

Spring AOP失效之谜

登录逻辑十分简单,首先判断用户是否为合法用户,如果是则可以正常登录,如果不是则禁止登录。

由于我们要在登录逻辑前后加入日志功能,所以我们需要编写一个环绕通知:

Spring AOP失效之谜

可以看到,我们的环绕增强针对login方法进行横切逻辑的织入,在调用目标对象的前后,分别对用户登录日志进行记录。

接下来写一个测试类看一下效果:

Spring AOP失效之谜

结果输出如下:

Spring AOP失效之谜

可以看到,我们通过AOP很方便地实现了日志记录功能。

AOP失效的情形
3

接下来假如我们又有了一个新需求,就是要对不合法用户做些特殊的处理,比如说统计下不合法用户调用登陆接口的次数。由于直接修改原有的登录逻辑有很多弊端,所以我们还是选择通过AOP来实现该功能。这可以通过编写一个返回增强来实现:

Spring AOP失效之谜

我们对isLegal方法进行增强,先拿到isLegal方法的返回值,再根据该返回值决定是否需要累加登录次数。

接下来我们还是用上一节的测试类来测试一下,我们直接看结果:

Spring AOP失效之谜

这个时候诡异的事情发生了。明明user_1为非法用户,但是为何没有对其登录次数进行累加呢?AOP为何会失效呢?下文将为你解开谜团。

AOP为何失效
4

之所以会出现上述AOP失效的现象,归根到底是由于AOP的实现机制导致的。Spring AOP采用代理的方式实现AOP,我们编写的横切逻辑被添加到动态生成的代理对象中,只要我们调用的是代理对象,则可以保证调用的是被增强的代理方法。而在代理对象中,不管你的横切逻辑是怎样的,也不管你增加了多少层的横切逻辑,有一点可以确定的是,你终归会调用目标对象的同一方法来调用原始的业务逻辑。

如果目标对象中的原始方法依赖于其他对象,那么Spring会注入所依赖对象的代理对象,从而保证依赖的对象的横切逻辑能够被正常织入。而一旦目标对象调用的是自身的其他方法时,问题就来了,这种情况下,目标对象调用的并不是代理对象的方法,故被调用的方法无法织入横切逻辑。

Spring AOP失效之谜

如上图所示,method1和method2方法是同个类中的方法,当外部通过代理对象调用method1时,最终会调用目标对象的method1方法,而在目标对象的method1方法中调用method2方法时,最终调用的是目标对象的method2方法,而不是代理对象的method2方法,故而针对method2的AOP增强失效了。

如何避免AOP失效
5

要解决上述Spring AOP失效的问题,有两个方法,一个是将isLegal方法跟login方法写在不同的类里,这样一来,当login方法调用isLegal方法时,Spring会注入相应的代理对象,从而可以调用到isLegal方法的代理逻辑。另一个方法是在调用isLegal方法时先获取当前上下文的代理对象,再通过该代理对象调用被增强了的isLegal方法,这样一来也能解决AOP失效的问题。实际上Spring AOP为我们提供了获取当前上下文代理对象的方法,使用起来非常方便,首先需要在AOP配置里暴露代理对象,在Spring Boot中可以通过注解@EnableAspectJAutoProxy(exposeProxy = true)进行配置:

Spring AOP失效之谜

然后修改login方法,通过AopContext获取当前上下文代理对象,再通过该代理对象调用isLegal方法:

Spring AOP失效之谜

最后我们运行测试类看下效果:

Spring AOP失效之谜

可以看到,现在已经可以实现对非法用户的登录次数进行累加了,这样就解决了上述AOP失效的问题。


扫描二维码关注我吧

Spring AOP失效之谜

在公众号后台回复“进群”,

可以申请加入技术讨论群哦。