参考:
1. http://www.cnblogs.com/hongwz/p/5764917.html
2. https://www.cnblogs.com/zhaozihan/p/5953063.html (非常棒)
一.前言
在以前的项目中,很少去关注spring aop的具体实现与理论,只是简单了解了一下什么是aop具体怎么用,看到了一篇博文写得还不错,就转载来学习一下,博文地址:http://www.cnblogs.com/xrq730/p/4919025.html
AOP
AOP(Aspect Oriented Programming),即面向切面编程,可以说是OOP(Object Oriented Programming,面向对象编程)的补充和完善。OOP引入封装、继承、多态等概念来建立一种对象层次结构,用于模拟公共行为的一个集合。不过OOP允许开发者定义纵向的关系,但并不适合定义横向的关系,例如日志功能。日志代码往往横向地散布在所有对象层次中,而与它对应的对象的核心功能毫无关系对于其他类型的代码,如安全性、异常处理和透明的持续性也都是如此,这种散布在各处的无关的代码被称为横切(cross cutting),在OOP设计中,它导致了大量代码的重复,而不利于各个模块的重用。
AOP技术恰恰相反,它利用一种称为"横切"的技术,剖解开封装的对象内部,并将那些影响了多个类的公共行为封装到一个可重用模块,并将其命名为"Aspect",即切面。所谓"切面",简单说就是那些与业务无关,却为业务模块所共同调用的逻辑或责任封装起来,便于减少系统的重复代码,降低模块之间的耦合度,并有利于未来的可操作性和可维护性。
使用"横切"技术,AOP把软件系统分为两个部分:核心关注点和横切关注点。业务处理的主要流程是核心关注点,与之关系不大的部分是横切关注点。横切关注点的一个特点是,他们经常发生在核心关注点的多处,而各处基本相似,比如权限认证、日志、事物。AOP的作用在于分离系统中的各种关注点,将核心关注点和横切关注点分离开来。
AOP核心概念
1、横切关注点
对哪些方法进行拦截,拦截后怎么处理,这些关注点称之为横切关注点
2、切面(aspect)
类是对物体特征的抽象,切面就是对横切关注点的抽象
3、连接点(joinpoint)
被拦截到的点,因为Spring只支持方法类型的连接点,所以在Spring中连接点指的就是被拦截到的方法,实际上连接点还可以是字段或者构造器
4、切入点(pointcut)
对连接点进行拦截的定义。连接点是实的感念,切入点是虚的概念。连接点可能是某个具体方法的调用,而切入点往往对应着一组连接点,在Spring运行期间,AOP正是通过分析切入点这个虚的概念,找到旗下所有匹配的连接点,再把通知进行织入到具体方法当中。
5、通知(advice)
所谓通知指的就是指拦截到连接点之后要执行的代码,通知分为前置、后置、异常、最终、环绕通知五类
6、目标对象
代理的目标对象
7、织入(weave)
将切面应用到目标对象并导致代理对象创建的过程
8、引入(introduction)
在不修改代码的前提下,引入可以在运行期为类动态地添加一些 方法或字段
Spring对AOP的支持
Spring中AOP代理由Spring的IOC容器负责生成、管理,其依赖关系也由IOC容器负责管理。因此,AOP代理可以直接使用容器中的其它bean实例作为目标,这种关系可由IOC容器的依赖注入提供。Spring创建代理的规则为:
1、默认使用Java动态代理来创建AOP代理,这样就可以为任何接口实例创建代理了
2、当需要代理的类不是代理接口的时候,Spring会切换为使用CGLIB代理,也可强制使用CGLIB
AOP编程其实是很简单的事情,纵观AOP编程,程序员只需要参与三个部分:
1、定义普通业务组件
2、定义切入点,一个切入点可能横切多个业务组件
3、定义增强处理,增强处理就是在AOP框架中为普通业务组件织入的处理动作
所以进行AOP编程的关键就是定义切入点和定义增强处理,一旦定义了合适的切入点和增强处理,AOP框架将自动生成AOP代理,即:代理对象的方法=增强处理+被代理对象的方法。
下面给出一个Spring AOP的.xml文件模板,名字叫做aop.xml,之后的内容都在aop.xml上进行扩展:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
</beans>
基于Spring的AOP简单实现
注意一下,在讲解之前,说明一点:使用Spring AOP,要成功运行起代码,只用Spring提供给开发者的jar包是不够的,请额外上网下载两个jar包:
1、aopalliance.jar
2、aspectjweaver.jar
若使用Spring boot,请按照如下配置:
<!-- AOP -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
开始讲解用Spring AOP的XML实现方式,先定义一个接口:
public interface HelloWorld
{
void printHelloWorld();
void doPrint();
}
定义两个接口实现类:
public class HelloWorldImpl1 implements HelloWorld
{
public void printHelloWorld()
{
System.out.println("Enter HelloWorldImpl1.printHelloWorld()");
}
public void doPrint()
{
System.out.println("Enter HelloWorldImpl1.doPrint()");
return ;
}
}
public class HelloWorldImpl2 implements HelloWorld
{
public void printHelloWorld()
{
System.out.println("Enter HelloWorldImpl2.printHelloWorld()");
}
public void doPrint()
{
System.out.println("Enter HelloWorldImpl2.doPrint()");
return ;
}
}
横切关注点,这里是打印时间:
public class TimeHandler {
public void printStartTime(){
System.out.println("前置增强 StartTime ---> " + System.currentTimeMillis());
}
public void printEndTime(){
System.out.println("后置增强 EndTime ---> " + System.currentTimeMillis());
}
}
有这三个类就可以实现一个简单的Spring AOP了,看一下aop.xml的配置:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
<!-- 将以下三个类放入Spring容器中,交由IOC管理 -->
<bean id="timeHandler" class="com.learn.learning.aop.example1.TimeHandler" />
<bean id="helloWorldImpl1" class="com.learn.learning.aop.example1.HelloWorldImpl1"/>
<bean id="helloWorldImpl2" class="com.learn.learning.aop.example1.HelloWorldImpl2"/>
<aop:config>
<!-- 首先定义切面,余下所有的配置都是围绕切面展开 -->
<aop:aspect id="time" ref="timeHandler">
<!-- ponitcut:切入点
(..)代表所有参数,(*)代表一个参数, (*, String)代表第二个参数
返回值 路径 参数
expression: example1包下任意子包中的任意类中的包含hello的所有方法,参数任意
-->
<aop:pointcut id="addAllMethod" expression="execution(* com.learn.learning.aop.example1.HelloWorld.*Hello*(..))" />
<aop:before method="printStartTime" pointcut-ref="addAllMethod" />
<aop:after method="printEndTime" pointcut-ref="addAllMethod" />
</aop:aspect>
</aop:config>
</beans>
写一个main函数调用一下:
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("/config/example1/aop.xml");
HelloWorld helloWorldImpl1 = (HelloWorld)context.getBean("helloWorldImpl1");
helloWorldImpl1.printHelloWorld();
System.out.println("--------------分割线--------------");
helloWorldImpl1.doPrint();
}
注意: 此处可能出现如下错误,错误原因在于创建代理失败,一般是因为aspect jweaver版本不对或是没有引入导致。
exception in thread "main" org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'timeHandler' defined in class path resource [config/example1/aop.xml]: BeanPostProcessor before instantiation of bean failed; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.aop.aspectj.AspectJPointcutAdvisor#0': Cannot create inner bean '(inner bean)#4690b489' of type [org.springframework.aop.aspectj.AspectJMethodBeforeAdvice] while setting constructor argument; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name '(inner bean)#4690b489': Cannot resolve reference to bean 'addAllMethod' while setting constructor argument; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'addAllMethod': Instantiation of bean failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.springframework.aop.aspectj.AspectJExpressionPointcut]: No default constructor found; nested exception is java.lang.NoClassDefFoundError: org/aspectj/weaver/reflect/ReflectionWorld$ReflectionWorldException
main函数执行结果如下:
前置增强 StartTime ---> 1544951972828
Enter HelloWorldImpl1.printHelloWorld()
后置增强 EndTime ---> 1544951972828
--------------分割线--------------
Enter HelloWorldImpl1.doPrint()
不难发现,我们给实现了HelloWorld接口的所有类中,包含Hello字符串的所有方法都加上了代理。例1中,helloWorldImpl1是代理对象,printHelloWorld()是被代理对象的方法,而printStartTime()和printEndTime()则是增强处理。
所以让我们再复习一遍,代理对象的方法=增强处理+被代理对象的方法。
代理
1. 静态代理
静态代理产生于代码编译阶段,即一旦代码编辑后就无法发生改变了。
定义接口:
public interface IPerson {
void doSomething();
}
定义实现类:
public class PersonImpl implements IPerson{
@Override
public void doSomething() {
System.out.println("我要买apple");
}
}
定义静态代理:
public class PersonStaticProxy {
private IPerson iPerson;
public PersonStaticProxy(IPerson iPerson){
this.iPerson = iPerson;
}
public void doSomething(){
System.out.println("before proxy");
iPerson.doSomething();
System.out.println("after proxy");
}
public static void main(String[] args) {
PersonStaticProxy personStaticProxy = new PersonStaticProxy(new PersonImpl());
personStaticProxy.doSomething();
}
}
输出:
before proxy
我要买apple
after proxy
通过代理类我们实现了将日志代码集成到了目标类,但从上面我们可以看出它具有很大的局限性:需要固定的类(PersonStaticProxy)编写接口,需要实现接口中被代理的每一个方法(毕竟以后是拿着PersonStaticProxy代替PersonImpl来使用,因此必须实现PersonImpl中的公用方法),如果有多个类需要加入日志代码,还需要些多个代理类,这就造成了大量的代码重复。
2. 动态代理
那能否通过一次代码编写就将logger织入到所有的函数中呢?答案是可以的。
public class PersonDynamicProxy implements InvocationHandler {
private Object delegate;
public Object bind(Object delegate){
this.delegate = delegate;
Class[] interfaces = delegate.getClass().getInterfaces();//实现的所有接口
return Proxy.newProxyInstance(delegate.getClass().getClassLoader(), interfaces, this);
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
Object result = null;
try{
System.out.println("Before Proxy");
method.invoke(delegate, args);
System.out.println("After Proxy");
}catch(Exception e){
throw e;
}
return result;
}
public static void main(String[] args) {
PersonDynamicProxy personDynamicProxy = new PersonDynamicProxy();
IPerson iPerson = (IPerson) personDynamicProxy.bind(new PersonImpl());
Objects.requireNonNull(iPerson);
iPerson.doSomething();
System.out.println("--------------分割线--------------");
iPerson.saySomething();
}
}
注意观察Proxy.newProxyInstance() 创建代理类对象方法。
3. CGLIB
CGLIB解决了动态代理的难题,它通过生成目标类子类的方式来实现来实现代理,而不是接口,规避了接口的局限性。CGLIB是一个强大的高性能代码生成包(生成原理还没研究过),其在运行时期(非编译时期)生成被 代理对象的子类,并重写了被代理对象的所有方法,从而作为代理对象。
public class PersonCGLIBProxy implements MethodInterceptor {
private Object delegate;
@Override
public Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
System.out.println("Before proxy");
Object result = methodProxy.invokeSuper(method, args);
System.out.println("After proxy");
return result;
}
public static PersonImpl getProxyInstance() {
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(PersonImpl.class);
enhancer.setCallback(new PersonCGLIBProxy());
return (PersonImpl)enhancer.create();
}
public static void main(String[] args) {
PersonImpl pp = PersonCGLIBProxy.getProxyInstance();
pp.doSomething();
}
}
但很遗憾这里报错了,希望以后能解决:
Before proxy
Exception in thread "main" java.lang.ClassCastException: java.lang.reflect.Method cannot be cast to com.learn.learning.aop.example3.PersonImpl$$EnhancerByCGLIB$$b2083a72
at com.learn.learning.aop.example3.PersonImpl$$EnhancerByCGLIB$$b2083a72$$FastClassByCGLIB$$57108bb2.invoke(<generated>)
at org.springframework.cglib.proxy.MethodProxy.invokeSuper(MethodProxy.java:228)
at com.learn.learning.aop.example3.PersonCGLIBProxy.intercept(PersonCGLIBProxy.java:24)
at com.learn.learning.aop.example3.PersonImpl$$EnhancerByCGLIB$$b2083a72.doSomething(<generated>)
at com.learn.learning.aop.example3.PersonCGLIBProxy.main(PersonCGLIBProxy.java:39)
而且CGLIB也具有局限性,对于无法生成子类的类(final类),肯定是没有办法生成代理子类的。
基于Spring的AOP使用其他细节
1. 多个横切关注点同时存在
打印日志,Java类为:
public class LogHandler
{
public void LogBefore()
{
System.out.println("Log before method");
}
public void LogAfter()
{
System.out.println("Log after method");
}
}
aop.xml配置为:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
<!-- 将以下三个类放入Spring容器中,交由IOC管理 -->
<bean id="timeHandler" class="com.learn.learning.aop.example1.TimeHandler" />
<!-- 新增日志横切关注点 -->
<bean id="logHandler" class="com.learn.learning.aop.example2.LogHandler"/>
<bean id="helloWorldImpl1" class="com.learn.learning.aop.example1.HelloWorldImpl1"/>
<bean id="helloWorldImpl2" class="com.learn.learning.aop.example1.HelloWorldImpl2"/>
<aop:config>
<!-- 首先定义切面,余下所有的配置都是围绕切面展开 -->
<aop:aspect id="time" ref="timeHandler" order="2">
<!-- ponitcut:切入点
(..)代表所有参数,(*)代表一个参数, (*, String)代表第二个参数
返回值 路径 参数
expression: example1包下任意子包中的任意类中的包含hello的所有方法,参数任意
-->
<aop:pointcut id="addAllMethod" expression="execution(* com.learn.learning.aop.example1.HelloWorld.*Hello*(..))" />
<aop:before method="printStartTime" pointcut-ref="addAllMethod" />
<aop:after method="printEndTime" pointcut-ref="addAllMethod" />
</aop:aspect>
<!-- 定义第二个切面 -->
<aop:aspect id="log" ref="logHandler" order="1">
<aop:pointcut id="printLog" expression="execution(* com.learn.learning.aop.example1.HelloWorld.*Hello*(..))" />
<aop:before method="LogBefore" pointcut-ref="printLog"/>
<aop:after method="LogAfter" pointcut-ref="printLog"/>
</aop:aspect>
</aop:config>
</beans>
main函数输出结果:
Log before method
前置增强 StartTime ---> 1544953402763
Enter HelloWorldImpl1.printHelloWorld()
后置增强 EndTime ---> 1544953402763
Log after method
--------------分割线--------------
Enter HelloWorldImpl1.doPrint()
若在aop.xml中定义了多个切面,切面按以下两种情况执行:
1. spring 默认按照aspect的定义顺序执行。
2. aspect提供了order属性,数字越小,权重越大。