AOP术语
joinPoint:连接点,spring只支持方法类型的连接点;
pointcut:切点,被增强的业务接口的方法;
advice:通知/增强,拦截到连接点后在其前后做的增强操作;
target:代理的目标对象;
weaving:织入,把增强应用到目标对象来创建新的代理对象的过程;
proxy:代理,一个类被aop织入增强后,会产生一个结果代理类;
aspect:切面,建立切点方法和通知方法在执行调用的对应关系就是切面;
introduction:引介切面,是一种特殊的通知,在不修改代码的前提下,可以在运行期间为类动态增加一些方法,和是方法级别的pointcut不同,引介切面是类级别的。
引介切面补充
前置、后置和环绕通知用得比较多,而引介切面用得比较少,下面来看下引介切面的使用。
首先,我有一个厨师和清洁工,他俩各司其职,分别负责做饭和清洁工作,如图1、2:
但是突然有一天,清洁工家里有事,无法完成清洁工作了,需要厨师临时替上,但是又不想修改厨师的职责内容,那么就需要用到引介切面,用@DeclareParents注解,value为厨师,defaultImpl为请假回家的清洁工,下面为参数需要实现的目标,也就是清洁工的职能,如图3:
我们在测试的时候发现厨师不仅完成了做饭的工作,还完成了清洁工作,如图4:
入口类的注册
对XML而言,我们对aop的使用一般都是通过<aop>标签,而传统标签是<import>、<alias>、<beans>、<bean>,说明<aop>属于自定义标签,通过在xml中增加<aop:aspectj-autoproxy/>来开启aop。
对于Javabean而言,只需要在配置类上增加一个@EnableAspectJAutoProxy注解,也一样可以开启aop。
上述提到了<aop>属于自定义标签,那么应该使用自定义标签解析的方式去寻找aop的解析入口,从spring-aop.jar包中META-INF/spring.handlers文件中找到AopNamespaceHandler类,然后在下面找到aspectj-autoproxy对应的解析类AspectJAutoProxyBeanDefinitionParser,关注里面的parse方法中的registerAspectJAnnotationAutoProxyCreatorIfNecessory,如图5:
AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessory,该方法是把aop的入口类封装成BeanDefinition对象,然后和正常的BeanDefinition注册一样,执行registerBeanDefinitioin,其beanName是一个构建动态代理的类,如图6:
useClassProxyingIfNecessory方法里面注册了两个参数,如图7:
PROXY_TARGET_CLASS_ATTRIBUTE(对应@EnableAspectJAutoProxy注解中的proxy-target-class参数)是用来选择代理模式的。如果设为true,不管目标对象是否实现了接口,都使用CGLIB代理;如果设为了false,在目标对象实现接口的时候,采用JDK动态代理,在目标对象没有实现对象的时候,使用CGLIB代理。
EXPOSE_PROXY_ATTRIBUTE(对应@EnableAspectJAutoProxy注解中的expose-proxy参数)是设置代理对象是否需要暴露,也就是是否需要将代理对象设置到ThreadLocal中。
JDK和CGLIB动态代理的区别
上述提到了JDK动态代理和CGLIB动态代理,这里稍微提一下两者的区别:
1、JDK动态代理只能针对接口实现类,通过反射来生成代理实例;而CGLIB是针对类实现的代理,通过对指定类生成一个子类,并覆盖其中的方法来实现增强
2、在spring中,如果目标对象没有实现接口,强制使用CGLIB;如果目标对象实现了接口,默认采用JDK动态代理,也可以通过设置参数proxy-target-class = true来强制使用CGLIB。
AOP流程
了解完aop的前置需求后,接下来就开始对aop的具体实现流程进行梳理。从上面的参数得知,spring是通过代理来作为aop的实现,在通过populateBean方法进行了IOC/DI的依赖注入后,调用initializeBean进行初始化,从该代码中点进去能看到一个初始化方法invokeInitMethods,在该方法后面还有一个applyBeanPostProcessorAfterInitialization方法,如图8:
该方法也是一个BeanPostProcessor的使用,关注postProcessAfterInitialization,就能发现aop的入口类AbstractAutoProxyCreator,关注其中的wrapIfNecessory方法,如图9:
getAdvicesAndAdvisorsForBean创建切面对象数组
该方法是用来创建切面的,如图10:
通过findEligibleAdvisors来找到合格的切面,如图11:
findCandidateAdvisors
该方法是用于寻找有@Aspect注解的类,然后把这些类封装成Advisor对象返回,主要看buildAspectJAdvisors。
1、BeanFactoryUtils.beanNamesForTypeIncludingAncestors:获取所有BeanDefinition中的beanName,如图12:
2、advisorFactory.isAspect:最终会执行hasAspectAnnotation方法来判断类上是否有@Aspect注解,如图13:
3、new BeanFactoryAspectInstanceFactory:创建有@Aspect注解的实例工厂,用于后续生产实例
4、this.advisorFactory.getAdvisor就是用来创建切面实例的,是个比较重要的方法
4.1、先后从工厂中获取到有@Aspect注解的类和类名称,然后创建一个工厂的装饰类,获取实例只会获取一次,如图14:
4.2、getAdvisorMethods获取到没有@Pointcut注解的方法,然后对方法遍历,调用getAdvisor来创建Advisor实例,如图15:
4.2.1、getPointcut获取Pointcut对象,先通过findAspectJAnnotationOnMethod,把方法上的指定注解找出来,并封装成AbstractAspectJAnnotation对象并返回,如图16:
指定的注解类指的是Pointcut.class、Around.class、Before.class、After.class、AfterReturning.class和AfterThrowing.class,具体匹配的过程也不深入研究了。然后创建一个AspectJExpressionPointcut类,把刚刚封装的AspectJAnnotation的表达式放入该类中,如图17:
4.2.2、new InstantiationModelAwarePointcutAdvisorImpl:是用于生成Advisor切面类的,一个切面需要有切点pointcut和通知advice,切点就是上一步生成的AspectJExpressionPointcut,而通知则是在构造方法中的instantiateAdvice方法,如图18。this.aspectJAdvisorFactory.getAdvice来创建切面对象。
4.2.2.1、aspectInstanceFactory.getAspectMetadata().getAspectClass()获得有@Aspect注解的类
4.2.2.2、和切点一样,用AbstractAspectJAdvisorFactory.findAspectJAnnotationOnMethod获得指定注解的类,并封装成AspectJAnnotation对象返回。
4.2.2.3、根据AspectJAnnotation的注解类型创建不同的Advice实例
4.2.2.4、springAdvice.caculateArgumentBindings(),用来处理传参,一个参数必须是JointPoint类型的,如有其它参数就会执行bindArgumentsByName ---> bindExplicitArguments ---> configurePointcutParameters,通过记录参数名和类型的对应关系,把它们放进pointcut中,如图19、20。
4.3、getDeclareParentsAdvisors:判断属性上是否有引介通知,也就是是否有@DeclareParents注解,如图21,interfaceType是新功能的接口,也就是清洁工;typePattern是需要进行引介增强的目标类,也就是厨师;defaultImpl是清洁工的具体实现MyCleaner
4.4、至此findCandidateAdvisors找出了所有由@Aspect注解的类,并封装成了Advisor对象返回
findAdvisorsThatCanApply
该方法旨在判断候选切面是否作用在当前的beanClass上,即pointcut的表达式是否包含了当前bean,如果有的则会生成代理。里面的主要方法是AopUtils.findAdvisorsThatCanApply,这个方法分成两种切面进行去匹配,分成引介切面(实现了IntroductionAdvisor)和非引介切面,匹配方式都是canApply,如图22。并将匹配完后的切面对象返回。
sortAdvisors
将收集到的切面根据order和primary属性进行排序。
createProxy创建代理
如果getAdvicesAndAdvisorsForBean有Advisor生成,那么会通过createProxy生成代理对象。
1、new ProxyFactory()创建代理工厂,如图23
2、确定代理方式,如图24。
proxyFactory.isProxyTargetClass:proxyTargetClass为@EnableAspectJAutoProxy注解的一个参数,如果为true,不管目标有没有实现接口,都会使用CGLIB代理。
shouldProxyTargetClass:通过BeanDefinition中的preserveTargetClass参数去判断,如果为true,则使用CGLIB代理;如果为false,还需要通过evaluateProxyInterface确定,如图25:
evaluateProxyInterface:首先通过ClassUtils.getAllInterfacesForClass获取所有接口后遍历,当isConfigurationCallbackInterface(不能实现如图26的接口)和isInterfnalLanguageInterface(全限定名不能是如图27的字符串结尾)都为false的时候,赋予hasReasonableProxyInterface为true,代表除了过滤的接口外还有其他的接口剩余,则把接口添加进proxyFactory代理工厂中,后续使用JDK动态代理,否则就使用CGLIB代理,如图28:
3、buildAdvisor把参数中的Advisor数组对象进行增强包装:
resolveInterceptorNames:对自定义MethodInterceptor类型的Advice对象包装秤Advisor对象后返回,如图29:
this.advisorAdapterRegistry.wrap():将自定义MethodInterceptor类型的Advisor对象重新包装,如图30:
4、proxyFactory.getProxy来获取代理实例
以JDK代理为例,通过getProxy来创建代理对象,和测试用的JDKProxy一样,也是通过Proxy.newProxyInstance方法创建,最终会调用到invoke方法,可以看到该类中就有一个invoke方法。
this.adviced.targetSource:从代理工厂中拿到TargetSource对象,包装了被代理的实例。
this.adviced.exposeProxy:就是@EnableAspectJAutoProxy的另一个参数exposeProxy,该属性设置代理对象是否需要暴露,也就是是否要将代理对象设置到ThreadLocal中,通过AopContext.setCurrentProxy实现,如图31和32:
this.adviced.getInterceptorsAndDynamicInterceptionAdvice:从代理工厂里拿到过滤器链。
1、config.getAdvisors():从代理工厂中获得该被代理类的所有Advisor切面
2、对切面进行遍历,切面分为引介切面和非引介切面
2.1、对非引介切面而言,如果切面的pointcut和被代理对象的路径是匹配的,说明该切面就是需要被拦截的对象,然后通过matches判断是否是需要拦截的方法,如图33:
registry.getInterceptor拿到里面对应的切面,如果Advice是MethodInterceptor类型的,如AspectJAroundAdvice、AspectJAfterAdvice、AspectJAfterThrowingAdvice,则直接添加,可以查看MethodInterceptor的实现类;如果Advice不是MethodInterceptor类型的,通过adapter.getInterceptor把advice包装成以下类型然后进行添加:AspectJMethodBeforeAdvice、AspectJAfterReturningAdvice,如图34:
spring支持静态和动态的MethodMatcher,如果isRuntime返回true,表示是动态的,需要包装后再添加;否则就是静态的,可以直接添加,如图35:
2.2、对于引介切面而言,在getInterceptors后直接添加就行,如图36:
3、把上述生成的过滤器链连放入缓存中,如图37:
invocation.proceed():进行反射调用
1、如果刚刚返回的过滤器链是为空,说明该方法并没有被拦截,直接执行AopUtils.invokeJoinpointUsingReflection进行反射调用。
2、如果返回不为空,则需要通过invocation.proceed()进行链式调用
2.1、如果执行链中的advice全部被执行完,则调用invoke.joinpoint方法
2.2、如果有未被执行完的advice,会调用MethodInterceptor.invoke方法,实现类以MethodBeforeAdviceInterceptor为例,首先会调用自己advice注解的method方法,根据断点提示,反射调用了该method方法,如图38。然后执行mi.proceed(),如图39,发现又回到了之前的proceed方法中,此时currentInterceptorIndex会+1后执行下一个advice,直到advice全部被调用完,然后递交给被代理方法,然后就可以通过invoke来执行被代理方法了。这就是前置通知的执行流程,同样的流程也可以去查看后置通知、环绕通知等,都是差不多的,这里就不细说了。
至此,Spring的AOP流程已经结束了。
自定义Spring容器代码地址:https://github.com/LuoChen1996/identitify_spring.git
Spring源码测试代码地址:https://github.com/LuoChen1996/my_spring.git