前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Spring AOP 原理源码深度剖析

Spring AOP 原理源码深度剖析

作者头像
方志朋
发布2019-06-21 11:17:13
9590
发布2019-06-21 11:17:13
举报

本文转载于公众号:吉姆餐厅ak

概述

AOP(Aspect-Oriented Programming) 面向切面编程。Spring Aop 在 Spring框架中的地位举足轻重,主要用于实现事务、缓存、安全等功能。本篇主要是对源码进行深度分析。

主要介绍以下三个方面:

Spring AOP 多种代理机制相关核心类介绍。

Spring Boot 中AOP注解方式源码分析。

Spring Boot 1.x 版本和 2.x版本 AOP 默认配置的变动。

Spring AOP 多种代理机制相关核心类介绍

先介绍一些Spring Aop中一些核心类,大致分为三类:

advisorCreator,继承 spring ioc的扩展接口 beanPostProcessor,主要用来扫描获取 advisor。

advisor:顾问的意思,封装了spring aop中的切点和通知。

advice:通知,也就是aop中增强的方法。

对以上三类核心类对应的 UML 分别来看。

advisorCreator:

AbstractAutoProxyCreator:Spring 为Spring AOP 模块暴露的可扩展抽象类,也是 AOP 中最核心的抽象类。Nepxion Matrix 框架便是基于此类对AOP进行扩展和增强。

BeanNameAutoProxyCreator:根据指定名称创建代理对象(阿里大名鼎鼎的连接池框架druid也基于此类做了扩展)。通过设置 advisor,可以对指定的 beanName 进行代理。支持模糊匹配。

AbstractAdvisorAutoProxyCreator:功能比较强大,默认扫描所有Advisor的实现类。相对于根据Bean名称匹配,该类更加灵活。动态的匹配每一个类,判断是否可以被代理,并寻找合适的增强类,以及生成代理类。

DefaultAdvisorAutoProxyCreator:AbstractAdvisorAutoProxyCreator的默认实现类。可以单独使用,在框架中使用AOP,尽量不要手动创建此对象。

AspectJAwareAdvisorAutoProxyCreator:Aspectj的实现方式,也是Spring Aop中最常用的实现方式,如果用注解方式,则用其子类AnnotationAwareAspectJAutoProxyCreator。

AnnotationAwareAspectJAutoProxyCreator:目前最常用的AOP使用方式。spring aop 开启注解方式之后,该类会扫描所有@Aspect()注释的类,生成对应的adviosr。目前SpringBoot框架中默认支持的方式,自动配置。

advisor:

StaticMethodMatcherPointcut:静态方法切面,抽象类。定义了一个classFilter,通过重写getClassFilter()方法来指定切面规则。另外实现了StaticMethodMatcher接口,通过重写matches来指定方法匹配规则。

StaticMethodMatcherPointcutAdvisor:静态方法匹配切面顾问,同未抽象类,扩展了切面排序方法。

NameMatchMethodPointcut:名称匹配切面,通过指定方法集合变量mappedNames,模糊匹配。

NameMatchMethodPointcutAdvisor:方法名称切面顾问,内部封装了

NameMatchMethodPointcut,通过设置方法名称模糊匹配规则和通知来实现切面功能。

RegexpMethodPointcutAdvisor:正则表达式切面顾问,可设置多个正则表达式规则,通过内部封装的

JdkRegexpMethodPointcut解析正则表达式。

DefaultPointcutAdvisor:默认切面顾问,比较灵活。可自由组合切面和通知。

InstantiationModelAwarePointcutAdvisorImpl:springboot自动装配的顾问类型,也是最常用的一种顾问实现。在注解实现的切面中,所有@Aspect类,都会被解析成该对象。

advice:

AspectJMethodBeforeAdvice:前置通知,AspectJ中 before 属性对应的通知(@Before标注的方法会被解析成该通知),,在切面方法执行之前执行。

AspectJAfterReturningAdvice:后置通知,AspectJ中 afterReturning 属性对应的通知(@AfterReturning 标注的方法会被解析成该通知),在切面方法执行之后执行,如果有异常,则不执行。

注意:该通知与AspectJMethodBeforeAdvice对应。

AspectJAroundAdvice:环绕通知,AspectJ中 around 属性对应的通知(@Around标注的方法会被解析成该通知),在切面方法执行前后执行。

AspectJAfterAdvice:返回通知,AspectJ中 after 属性对应的通知(@After 标注的方法会被解析成该通知),不论是否异常都会执行。

可以看出 Spring AOP 提供的实现方式很多,但是殊途同归。

具体使用方式已上传至 github:

https://github.com/admin801122/springboot2-spring5-studying

Spring Boot 中AOP注解方式源码分析

Spring Aop使用方式很多,从上面的 API 也可以看出。本篇就基于最常用的注解实现方式,对源码深入分析。

@Aspect

@Component

public class LogableAspect {

代码语言:txt
复制
@Pointcut("@annotation(com.springboot2.spring5.springAop.aspect.Logable)")
代码语言:txt
复制
 public void aspect() {
代码语言:txt
复制
 }
代码语言:txt
复制
 @Around("aspect()")
代码语言:txt
复制
 public Object doAround(ProceedingJoinPoint point) throws Throwable {
代码语言:txt
复制
     //...
代码语言:txt
复制
     Object returnValue =  point.proceed(point.getArgs());
代码语言:txt
复制
     //...
代码语言:txt
复制
     return returnValue;
代码语言:txt
复制
 }

}

这是实际项目中,使用AOP最常见的形式,基于注解实现。如今springboot大行其道,我们就从springboot中的EnableAspectJAutoProxy自动配置开始。

大致流程主要分为三个步骤:

1: 创建AnnotationAwareAspectJAutoProxyCreator对象

2: 扫描容器中的切面,创建PointcutAdvisor对象

3: 生成代理类

分别来分析以上三个步骤。

1: 创建AnnotationAwareAspectJAutoProxyCreator对象

首先来看AnnotationAwareAspectJAutoProxyCreator对象初始化的过程。springboot中,aop同样以自动装配的方式,所以还是要从spring.factories开始:

Auto Configure

org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\

@Configuration

@ConditionalOnClass({ EnableAspectJAutoProxy.class, Aspect.class, Advice.class,

代码语言:txt
复制
     AnnotatedElement.class })

@ConditionalOnProperty(prefix = "spring.aop", name = "auto", havingValue = "true", matchIfMissing = true)

public class AopAutoConfiguration {

代码语言:txt
复制
@Configuration
代码语言:txt
复制
 @EnableAspectJAutoProxy(proxyTargetClass = false)
代码语言:txt
复制
 @ConditionalOnProperty(prefix = "spring.aop", name = "proxy-target-class", havingValue = "false", matchIfMissing = false)
代码语言:txt
复制
 public static class JdkDynamicAutoProxyConfiguration {
代码语言:txt
复制
}
代码语言:txt
复制
@Configuration
代码语言:txt
复制
 @EnableAspectJAutoProxy(proxyTargetClass = true)
代码语言:txt
复制
 @ConditionalOnProperty(prefix = "spring.aop", name = "proxy-target-class", havingValue = "true", matchIfMissing = true)
代码语言:txt
复制
 public static class CglibAutoProxyConfiguration {
代码语言:txt
复制
}

}

具体来看:

(1)该配置类的加载前提是什么?

@ConditionalOnClass({ EnableAspectJAutoProxy.class, Aspect.class, Advice.class,

代码语言:txt
复制
     AnnotatedElement.class })

条件注解依赖的配置类均被引入到spring-boot-starter-aop中,只需引入该依赖即可自动装配。

而且可以看到spring.aop.auto默认为true,并不需要手动开启。

所以很多同学在springboot项目中使用 aop 的时候,习惯在启动类上引入@EnableAspectJAutoProxy,其实完全不必要。保证项目中有spring-boot-starter-aop依赖即可。

(2)上述代码通过spring.aop.proxy-target-class变量来控制proxyTargetClass的变量,最终都会加载@EnableAspectJAutoProxy配置。

spring.aop.proxy-target-class默认为true,该变量相当关键,控制 spring aop 代理类的生成方式,具体后面详细介绍。

继续跟进EnableAspectJAutoProxy:

class AspectJAutoProxyRegistrar implements ImportBeanDefinitionRegistrar {

代码语言:txt
复制
@Override
代码语言:txt
复制
 public void registerBeanDefinitions(
代码语言:txt
复制
         AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
代码语言:txt
复制
    //注册 AnnotationAwareAspectJAutoProxyCreator
代码语言:txt
复制
     AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary(registry);
代码语言:txt
复制
    AnnotationAttributes enableAspectJAutoProxy =
代码语言:txt
复制
             AnnotationConfigUtils.attributesFor(importingClassMetadata, EnableAspectJAutoProxy.class);
代码语言:txt
复制
     //将 aop 代理方式相关的变量设置到 AopConfigUtils,创建代理类时会读取变量
代码语言:txt
复制
     if (enableAspectJAutoProxy != null) {
代码语言:txt
复制
         if (enableAspectJAutoProxy.getBoolean("proxyTargetClass")) {
代码语言:txt
复制
             AopConfigUtils.forceAutoProxyCreatorToUseClassProxying(registry);
代码语言:txt
复制
         }
代码语言:txt
复制
         if (enableAspectJAutoProxy.getBoolean("exposeProxy")) {
代码语言:txt
复制
             AopConfigUtils.forceAutoProxyCreatorToExposeProxy(registry);
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
 }

}

代码语言:txt
复制
 @Nullable
代码语言:txt
复制
 public static BeanDefinition registerAspectJAnnotationAutoProxyCreatorIfNecessary(BeanDefinitionRegistry registry,
代码语言:txt
复制
         @Nullable Object source) {
代码语言:txt
复制
    return registerOrEscalateApcAsRequired(AnnotationAwareAspectJAutoProxyCreator.class, registry, source);
代码语言:txt
复制
 }

上述代码可以看到注册了一个切面相关BeanDefinition,正是上面提到的类:

AnnotationAwareAspectJAutoProxyCreator,并设置了代理方式配置变量: proxyTargetClass,默认为true。

这里只是创建BeanDefinition,并没有实例化和初始化该对象。那什么时候会触发呢?

上面的 uml 图可以看到,该类继承的顶层接口为 BeanPostProcessor。我们知道BeanPostProcessor实现类会提前初始化,由PostProcessorRegistrationDelegate触发,具体细节之前博客有提到:

SpringBoot2 | @SpringBootApplication注解 自动化配置流程源码分析(三)

该类又继承BeanFactoryAware,所以在其在实例化 bean 后,会触发setBeanFactory()方法,最终会触发

initBeanFactory方法:

代码语言:txt
复制
@Override
代码语言:txt
复制
 protected void initBeanFactory(ConfigurableListableBeanFactory beanFactory) {
代码语言:txt
复制
     super.initBeanFactory(beanFactory);
代码语言:txt
复制
     if (this.aspectJAdvisorFactory == null) {
代码语言:txt
复制
         //advisor 工厂类
代码语言:txt
复制
         this.aspectJAdvisorFactory = new ReflectiveAspectJAdvisorFactory(beanFactory);
代码语言:txt
复制
     }
代码语言:txt
复制
     //用于创建 advisor
代码语言:txt
复制
     this.aspectJAdvisorsBuilder =
代码语言:txt
复制
             new BeanFactoryAspectJAdvisorsBuilderAdapter(beanFactory, this.aspectJAdvisorFactory);
代码语言:txt
复制
 }

至此,AnnotationAwareAspectJAutoProxyCreator BeanDefinition创建完毕。

2: 扫描容器中的切面,创建PointcutAdvisor对象

在spring ioc流程加载的过程中,会触发 beanPostProcessor 扩展接口,

而AnnotationAwareAspectJAutoProxyCreator又是SmartInstantiationAwareBeanPostProcessor的子类,所以该扩展接口正是 aop 实现的入口。

该接口的触发在实例化 bean 之后,初始化 bean之前,具体来看:

@Override

代码语言:txt
复制
 public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
代码语言:txt
复制
     Object cacheKey = getCacheKey(beanClass, beanName);
代码语言:txt
复制
    if (!StringUtils.hasLength(beanName) || !this.targetSourcedBeans.contains(beanName)) {
代码语言:txt
复制
         //advisedBeans用于存储不可代理的bean,如果包含直接返回
代码语言:txt
复制
         if (this.advisedBeans.containsKey(cacheKey)) {
代码语言:txt
复制
             return null;
代码语言:txt
复制
         }
代码语言:txt
复制
         //判断当前bean是否可以被代理,然后存入advisedBeans
代码语言:txt
复制
         if (isInfrastructureClass(beanClass) || shouldSkip(beanClass, beanName)) {
代码语言:txt
复制
             this.advisedBeans.put(cacheKey, Boolean.FALSE);
代码语言:txt
复制
             return null;
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
    // Create proxy here if we have a custom TargetSource.
代码语言:txt
复制
     // Suppresses unnecessary default instantiation of the target bean:
代码语言:txt
复制
     // The TargetSource will handle target instances in a custom fashion.
代码语言:txt
复制
     //到这里说明该bean可以被代理,所以去获取自定义目标类,如果没有定义,则跳过。
代码语言:txt
复制
     TargetSource targetSource = getCustomTargetSource(beanClass, beanName);
代码语言:txt
复制
     if (targetSource != null) {
代码语言:txt
复制
         if (StringUtils.hasLength(beanName)) {
代码语言:txt
复制
             this.targetSourcedBeans.add(beanName);
代码语言:txt
复制
         }
代码语言:txt
复制
         Object[] specificInterceptors = getAdvicesAndAdvisorsForBean(beanClass, beanName, targetSource);
代码语言:txt
复制
         Object proxy = createProxy(beanClass, beanName, specificInterceptors, targetSource);
代码语言:txt
复制
         this.proxyTypes.put(cacheKey, proxy.getClass());
代码语言:txt
复制
         //如果最终可以获得代理类,则返回代理类,直接执行实例化后置通知方法
代码语言:txt
复制
         return proxy;
代码语言:txt
复制
     }
代码语言:txt
复制
    return null;
代码语言:txt
复制
 }

来看一下判定 bean 是否被代理的方法依据:

代码语言:txt
复制
@Override
代码语言:txt
复制
 protected boolean isInfrastructureClass(Class<?> beanClass) {
代码语言:txt
复制
     return (super.isInfrastructureClass(beanClass) ||
代码语言:txt
复制
             (this.aspectJAdvisorFactory != null && this.aspectJAdvisorFactory.isAspect(beanClass)));
代码语言:txt
复制
 }
代码语言:txt
复制
 private boolean hasAspectAnnotation(Class<?> clazz) {
代码语言:txt
复制
     //判定当前类是否有 Aspect 注解,如果有,则不能被代理
代码语言:txt
复制
     return (AnnotationUtils.findAnnotation(clazz, Aspect.class) != null);
代码语言:txt
复制
 }
代码语言:txt
复制
 protected boolean isInfrastructureClass(Class<?> beanClass) {
代码语言:txt
复制
     //判定当前bean是否是 Advice、Pointcut、Advisor、AopInfrastructureBean等子类或实现类,如果是,则不能被代理
代码语言:txt
复制
     boolean retVal = Advice.class.isAssignableFrom(beanClass) ||
代码语言:txt
复制
             Pointcut.class.isAssignableFrom(beanClass) ||
代码语言:txt
复制
             Advisor.class.isAssignableFrom(beanClass) ||
代码语言:txt
复制
             AopInfrastructureBean.class.isAssignableFrom(beanClass);
代码语言:txt
复制
     if (retVal && logger.isTraceEnabled()) {
代码语言:txt
复制
         logger.trace("Did not attempt to auto-proxy infrastructure class [" + beanClass.getName() + "]");
代码语言:txt
复制
     }
代码语言:txt
复制
     return retVal;
代码语言:txt
复制
 }

重点来看 shouldSkip方法:

代码语言:txt
复制
@Override
代码语言:txt
复制
 protected boolean shouldSkip(Class<?> beanClass, String beanName) {
代码语言:txt
复制
     // TODO: Consider optimization by caching the list of the aspect names
代码语言:txt
复制
     //获取所有的候选顾问类 Advisor
代码语言:txt
复制
     List<Advisor> candidateAdvisors = findCandidateAdvisors();
代码语言:txt
复制
     for (Advisor advisor : candidateAdvisors) {
代码语言:txt
复制
         if (advisor instanceof AspectJPointcutAdvisor &&
代码语言:txt
复制
                 ((AspectJPointcutAdvisor) advisor).getAspectName().equals(beanName)) {
代码语言:txt
复制
             return true;
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
     return super.shouldSkip(beanClass, beanName);
代码语言:txt
复制
 }

上述代码通过findCandidateAdvisors()方法来获取所有的候选 advisor:

@Override

代码语言:txt
复制
 protected List<Advisor> findCandidateAdvisors() {
代码语言:txt
复制
     // Add all the Spring advisors found according to superclass rules.
代码语言:txt
复制
     //获得 Advisor 实现类
代码语言:txt
复制
     List<Advisor> advisors = super.findCandidateAdvisors();
代码语言:txt
复制
     // Build Advisors for all AspectJ aspects in the bean factory.
代码语言:txt
复制
     //将@Aspect注解类, 解析成Advisor 
代码语言:txt
复制
     if (this.aspectJAdvisorsBuilder != null) {
代码语言:txt
复制
         advisors.addAll(this.aspectJAdvisorsBuilder.buildAspectJAdvisors());
代码语言:txt
复制
     }
代码语言:txt
复制
     return advisors;
代码语言:txt
复制
 }

继续跟进buildAspectJAdvisors方法,会触发

ReflectiveAspectJAdvisorFactory中的getAdvisors方法:

@Override

代码语言:txt
复制
 public List<Advisor> getAdvisors(MetadataAwareAspectInstanceFactory aspectInstanceFactory) {
代码语言:txt
复制
     //从 aspectMetadata 中获取 Aspect()标注的类 class对象
代码语言:txt
复制
     Class<?> aspectClass = aspectInstanceFactory.getAspectMetadata().getAspectClass();
代码语言:txt
复制
     //获取Aspect()标注的类名
代码语言:txt
复制
     String aspectName = aspectInstanceFactory.getAspectMetadata().getAspectName();
代码语言:txt
复制
     validate(aspectClass);
代码语言:txt
复制
    // We need to wrap the MetadataAwareAspectInstanceFactory with a decorator
代码语言:txt
复制
     // so that it will only instantiate once.
代码语言:txt
复制
     MetadataAwareAspectInstanceFactory lazySingletonAspectInstanceFactory =
代码语言:txt
复制
             new LazySingletonAspectInstanceFactoryDecorator(aspectInstanceFactory);
代码语言:txt
复制
    List<Advisor> advisors = new LinkedList<>();
代码语言:txt
复制
     //遍历该类所有方法,根据方法判断是否能获取到对应 pointCut,如果有,则生成 advisor 对象
代码语言:txt
复制
     for (Method method : getAdvisorMethods(aspectClass)) {
代码语言:txt
复制
         Advisor advisor = getAdvisor(method, lazySingletonAspectInstanceFactory, advisors.size(), aspectName);
代码语言:txt
复制
         if (advisor != null) {
代码语言:txt
复制
             advisors.add(advisor);
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
    // If it's a per target aspect, emit the dummy instantiating aspect.
代码语言:txt
复制
     if (!advisors.isEmpty() && lazySingletonAspectInstanceFactory.getAspectMetadata().isLazilyInstantiated()) {
代码语言:txt
复制
         Advisor instantiationAdvisor = new SyntheticInstantiationAdvisor(lazySingletonAspectInstanceFactory);
代码语言:txt
复制
         advisors.add(0, instantiationAdvisor);
代码语言:txt
复制
     }
代码语言:txt
复制
    // Find introduction fields.
代码语言:txt
复制
     //获取 @DeclareParents 注解修饰的属性(并不常用)
代码语言:txt
复制
     for (Field field : aspectClass.getDeclaredFields()) {
代码语言:txt
复制
         Advisor advisor = getDeclareParentsAdvisor(field);
代码语言:txt
复制
         if (advisor != null) {
代码语言:txt
复制
             advisors.add(advisor);
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
    return advisors;
代码语言:txt
复制
 }

继续来看getAdvisor方法:

代码语言:txt
复制
@Override
代码语言:txt
复制
 @Nullable
代码语言:txt
复制
 public Advisor getAdvisor(Method candidateAdviceMethod, MetadataAwareAspectInstanceFactory aspectInstanceFactory,
代码语言:txt
复制
         int declarationOrderInAspect, String aspectName) {
代码语言:txt
复制
    validate(aspectInstanceFactory.getAspectMetadata().getAspectClass());
代码语言:txt
复制
     //根据候选方法名,来获取对应的 pointCut
代码语言:txt
复制
     AspectJExpressionPointcut expressionPointcut = getPointcut(
代码语言:txt
复制
             candidateAdviceMethod, aspectInstanceFactory.getAspectMetadata().getAspectClass());
代码语言:txt
复制
     if (expressionPointcut == null) {
代码语言:txt
复制
         return null;
代码语言:txt
复制
     }
代码语言:txt
复制
     //如果能获取到 pointCut,则将切点表达式 expressionPointcut、当前
代码语言:txt
复制
     对象ReflectiveAspectJAdvisorFactory、 方法名等包装成 advisor 对象
代码语言:txt
复制
     return new InstantiationModelAwarePointcutAdvisorImpl(expressionPointcut, candidateAdviceMethod,
代码语言:txt
复制
             this, aspectInstanceFactory, declarationOrderInAspect, aspectName);
代码语言:txt
复制
 }
代码语言:txt
复制
 protected static AspectJAnnotation<?> findAspectJAnnotationOnMethod(Method method) {
代码语言:txt
复制
     //定义class对象数组,如果方法中有以下注解中任何一种,则返回该注解
代码语言:txt
复制
     Class<?>[] classesToLookFor = new Class<?>[] {
代码语言:txt
复制
             Before.class, Around.class, After.class, AfterReturning.class, AfterThrowing.class, Pointcut.class};
代码语言:txt
复制
     for (Class<?> c : classesToLookFor) {
代码语言:txt
复制
         AspectJAnnotation<?> foundAnnotation = findAnnotation(method, (Class<Annotation>) c);
代码语言:txt
复制
         if (foundAnnotation != null) {
代码语言:txt
复制
             return foundAnnotation;
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
     return null;
代码语言:txt
复制
 }

InstantiationModelAwarePointcutAdvisorImpl的构造方法会触发构造通知对象:

public Advice getAdvice(Method candidateAdviceMethod, AspectJExpressionPointcut expressionPointcut,

代码语言:txt
复制
         MetadataAwareAspectInstanceFactory aspectInstanceFactory, int declarationOrder, String aspectName) {
代码语言:txt
复制
     //......
代码语言:txt
复制
     //根据注解类型,匹配对应的通知类型
代码语言:txt
复制
     switch (aspectJAnnotation.getAnnotationType()) {
代码语言:txt
复制
         //前置通知
代码语言:txt
复制
         case AtBefore:
代码语言:txt
复制
             springAdvice = new AspectJMethodBeforeAdvice(
代码语言:txt
复制
                     candidateAdviceMethod, expressionPointcut, aspectInstanceFactory);
代码语言:txt
复制
             break;
代码语言:txt
复制
         //最终通知
代码语言:txt
复制
         case AtAfter:
代码语言:txt
复制
             springAdvice = new AspectJAfterAdvice(
代码语言:txt
复制
                     candidateAdviceMethod, expressionPointcut, aspectInstanceFactory);
代码语言:txt
复制
             break;
代码语言:txt
复制
         //后置通知
代码语言:txt
复制
         case AtAfterReturning:
代码语言:txt
复制
             springAdvice = new AspectJAfterReturningAdvice(
代码语言:txt
复制
                     candidateAdviceMethod, expressionPointcut, aspectInstanceFactory);
代码语言:txt
复制
             AfterReturning afterReturningAnnotation = (AfterReturning) aspectJAnnotation.getAnnotation();
代码语言:txt
复制
             if (StringUtils.hasText(afterReturningAnnotation.returning())) {
代码语言:txt
复制
                 springAdvice.setReturningName(afterReturningAnnotation.returning());
代码语言:txt
复制
             }
代码语言:txt
复制
             break;
代码语言:txt
复制
         //异常通知
代码语言:txt
复制
         case AtAfterThrowing:
代码语言:txt
复制
             springAdvice = new AspectJAfterThrowingAdvice(
代码语言:txt
复制
                     candidateAdviceMethod, expressionPointcut, aspectInstanceFactory);
代码语言:txt
复制
             AfterThrowing afterThrowingAnnotation = (AfterThrowing) aspectJAnnotation.getAnnotation();
代码语言:txt
复制
             if (StringUtils.hasText(afterThrowingAnnotation.throwing())) {
代码语言:txt
复制
                 springAdvice.setThrowingName(afterThrowingAnnotation.throwing());
代码语言:txt
复制
             }
代码语言:txt
复制
             break;
代码语言:txt
复制
         //环绕通知
代码语言:txt
复制
         case AtAround:
代码语言:txt
复制
             springAdvice = new AspectJAroundAdvice(
代码语言:txt
复制
                     candidateAdviceMethod, expressionPointcut, aspectInstanceFactory);
代码语言:txt
复制
             break;
代码语言:txt
复制
         //切面
代码语言:txt
复制
         case AtPointcut:
代码语言:txt
复制
             if (logger.isDebugEnabled()) {
代码语言:txt
复制
                 logger.debug("Processing pointcut '" + candidateAdviceMethod.getName() + "'");
代码语言:txt
复制
             }
代码语言:txt
复制
             return null;
代码语言:txt
复制
         default:
代码语言:txt
复制
             throw new UnsupportedOperationException(
代码语言:txt
复制
                     "Unsupported advice type on method: " + candidateAdviceMethod);
代码语言:txt
复制
     }
代码语言:txt
复制
    //......
代码语言:txt
复制
 }

可以看到,根据@Aspect类中方法的注解类型,生成对应的advice,并通过通知的构造方法,将通知增强方法,切面表达式传入到通知当中。

到这里InstantiationModelAwarePointcutAdvisorImpl对象构造完毕。

3: 生成代理类

上面创建advisor的逻辑发生在扩展接口中的postProcessBeforeInstantiation,实例化之前执行,如果有自定义的TargetSource指定类,则则直接生成代理类,并直接执行初始化之后的方法postProcessAfterInitialization。这种情况使用不多,常规代理类还是在postProcessAfterInitialization中创建,也就是 IOC 最后一个扩展方法。

代码语言:txt
复制
@Override
代码语言:txt
复制
 public Object postProcessAfterInitialization(@Nullable Object bean, String beanName) throws BeansException {
代码语言:txt
复制
     if (bean != null) {
代码语言:txt
复制
         Object cacheKey = getCacheKey(bean.getClass(), beanName);
代码语言:txt
复制
         //处理循环依赖的判断
代码语言:txt
复制
         if (!this.earlyProxyReferences.contains(cacheKey)) {
代码语言:txt
复制
             return wrapIfNecessary(bean, beanName, cacheKey);
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
     return bean;
代码语言:txt
复制
 }

protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) {

代码语言:txt
复制
     if (StringUtils.hasLength(beanName) && this.targetSourcedBeans.contains(beanName)) {
代码语言:txt
复制
         return bean;
代码语言:txt
复制
     }
代码语言:txt
复制
     if (Boolean.FALSE.equals(this.advisedBeans.get(cacheKey))) {
代码语言:txt
复制
         return bean;
代码语言:txt
复制
     }
代码语言:txt
复制
     if (isInfrastructureClass(bean.getClass()) || shouldSkip(bean.getClass(), beanName)) {
代码语言:txt
复制
         this.advisedBeans.put(cacheKey, Boolean.FALSE);
代码语言:txt
复制
         return bean;
代码语言:txt
复制
     }
代码语言:txt
复制
    // Create proxy if we have advice.
代码语言:txt
复制
     //获取到合适的advisor,如果为空。如果不为空,则生成代理类。
代码语言:txt
复制
     Object[] specificInterceptors = getAdvicesAndAdvisorsForBean(bean.getClass(), beanName, null);
代码语言:txt
复制
     if (specificInterceptors != DO\_NOT\_PROXY) {
代码语言:txt
复制
         this.advisedBeans.put(cacheKey, Boolean.TRUE);
代码语言:txt
复制
         Object proxy = createProxy(
代码语言:txt
复制
                 bean.getClass(), beanName, specificInterceptors, new SingletonTargetSource(bean));
代码语言:txt
复制
         this.proxyTypes.put(cacheKey, proxy.getClass());
代码语言:txt
复制
         return proxy;
代码语言:txt
复制
     }
代码语言:txt
复制
    this.advisedBeans.put(cacheKey, Boolean.FALSE);
代码语言:txt
复制
     return bean;
代码语言:txt
复制
 }

上述方法通过调用getAdvicesAndAdvisorsForBean()方法来获取advisor,该方法最终会调用findEligibleAdvisors(),Eligible意为有资格的,合适的。具体来看下:

protected List<Advisor> findEligibleAdvisors(Class<?> beanClass, String beanName) {

代码语言:txt
复制
     List<Advisor> candidateAdvisors = findCandidateAdvisors();
代码语言:txt
复制
     //这里会对获取的advisor进行筛选
代码语言:txt
复制
     List<Advisor> eligibleAdvisors = findAdvisorsThatCanApply(candidateAdvisors, beanClass, beanName);
代码语言:txt
复制
     //添加一个默认的advisor,执行时用到。
代码语言:txt
复制
     extendAdvisors(eligibleAdvisors);
代码语言:txt
复制
     if (!eligibleAdvisors.isEmpty()) {
代码语言:txt
复制
         eligibleAdvisors = sortAdvisors(eligibleAdvisors);
代码语言:txt
复制
     }
代码语言:txt
复制
     return eligibleAdvisors;
代码语言:txt
复制
 }

最终的筛选规则在AopUtils中:

public static List<Advisor> findAdvisorsThatCanApply(List<Advisor> candidateAdvisors, Class<?> clazz) {

代码语言:txt
复制
     //......
代码语言:txt
复制
     for (Advisor candidate : candidateAdvisors) {
代码语言:txt
复制
         if (candidate instanceof IntroductionAdvisor) {
代码语言:txt
复制
             // already processed
代码语言:txt
复制
             continue;
代码语言:txt
复制
         } 
代码语言:txt
复制
         //调用 canApply 方法,遍历所有的方法进行匹配
代码语言:txt
复制
         if (canApply(candidate, clazz, hasIntroductions)) {
代码语言:txt
复制
             eligibleAdvisors.add(candidate);
代码语言:txt
复制
         }
代码语言:txt
复制
     }
代码语言:txt
复制
     //......
代码语言:txt
复制
 }

调用canApply方法,遍历被代理类的所有的方法,跟进切面表达式进行匹配,如果有一个方法匹配到,也就意味着该类会被代理。

匹配方法是借助org.aspectj.weaver.internal.tools实现,也就是AspectJ框架中的工具类,有兴趣的可以自行查看。

重点来看一下代理生成方式:

public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException {

代码语言:txt
复制
     if (config.isOptimize() || config.isProxyTargetClass() || hasNoUserSuppliedProxyInterfaces(config)) {
代码语言:txt
复制
         Class<?> targetClass = config.getTargetClass();
代码语言:txt
复制
         if (targetClass == null) {
代码语言:txt
复制
             throw new AopConfigException("TargetSource cannot determine target class: " +
代码语言:txt
复制
                     "Either an interface or a target is required for proxy creation.");
代码语言:txt
复制
         }
代码语言:txt
复制
         //如果代理目标是接口或者Proxy类型,则走jdk类型
代码语言:txt
复制
         if (targetClass.isInterface() || Proxy.isProxyClass(targetClass)) {
代码语言:txt
复制
             return new JdkDynamicAopProxy(config);
代码语言:txt
复制
         }
代码语言:txt
复制
         return new ObjenesisCglibAopProxy(config);
代码语言:txt
复制
     }
代码语言:txt
复制
     else {
代码语言:txt
复制
         return new JdkDynamicAopProxy(config);
代码语言:txt
复制
     }
代码语言:txt
复制
 }

上述方法通过三个变量来进行筛选代理方法:

optimize:官方文档翻译为设置代理是否应执行积极的优化,默认为false。

proxyTargetClass:这个在上面已经提到了,AopAutoConfiguration中指定,默认为true,也就是选择使用 cglib 代理。可以看到该变量和optimize意义一样,之所以这么做,个人理解是为了可以在不同的场景中使用。

hasNoUserSuppliedProxyInterfaces:是否设置了实现接口。

hasNoUserSuppliedProxyInterfaces方法如下:

private boolean hasNoUserSuppliedProxyInterfaces(AdvisedSupport config) {

代码语言:txt
复制
     Class<?>[] ifcs = config.getProxiedInterfaces();
代码语言:txt
复制
     return (ifcs.length == 0 || (ifcs.length == 1 && SpringProxy.class.isAssignableFrom(ifcs[0])));
代码语言:txt
复制
 }

主要就是判断AdvisedSupport中interfaces变量中是否设置了接口,

意思是如果一个类实现了接口,把接口设置到该方法的变量中,但是不是一定会设置到该变量中,具体设置接口的代码如下:

可以看到如果用默认配置也就是proxyTargetClass为true时,只有一种情况会走jdk代理方法,就是代理类为接口类型(注意:代理类是接口类型,并不是指接口类是否实现了接口)或者代理类是Proxy类型,否则全部走cglib代理。所以,平时使用中,代理类大部分还是用cglib的方式来生成。

Spring Boot 1.x 版本和 2.x版本 AOP 默认配置的变动

配置类AopAutoConfiguration:

1.5x版本:

代码语言:txt
复制
@Configuration
代码语言:txt
复制
 @EnableAspectJAutoProxy(proxyTargetClass = true)
代码语言:txt
复制
 @ConditionalOnProperty(prefix = "spring.aop", name = "proxy-target-class", havingValue = "true", matchIfMissing = false)
代码语言:txt
复制
 public static class CglibAutoProxyConfiguration {
代码语言:txt
复制
}

2.x版本:

代码语言:txt
复制
@Configuration
代码语言:txt
复制
 @EnableAspectJAutoProxy(proxyTargetClass = true)
代码语言:txt
复制
 @ConditionalOnProperty(prefix = "spring.aop", name = "proxy-target-class", havingValue = "true", matchIfMissing = true)
代码语言:txt
复制
 public static class CglibAutoProxyConfiguration {
代码语言:txt
复制
}

可以看到,在SpringBoot2.x中最主要的变化就是proxy-target-class默认为true,意味着类代理的时候全部走cglib代理方式,只有为接口代理时才走jdk代理(注意:这里为接口代理,不是指代理目标类是否实现了接口)。所以,在使用springboot2.x的版本中,除了代理目标类是接口外,其余的代理方式全部采用cglib类型。

总结

Springboot通过自动装配AopAutoConfiguration配置类,默认自动开启 AOP 功能。通过注册

AnnotationAwareAspectJAutoProxyCreator类,来扫描创建所有的Advisor,再通过 Advisor在 Spring IOC的扩展接口中来创建代理类。

更多阅读

史上最简单的 SpringCloud 教程汇总

SpringBoot教程汇总

Java面试题系列汇总

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2019年02月27日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Auto Configure
相关产品与服务
云顾问
云顾问(Tencent Cloud Smart Advisor)是一款提供可视化云架构IDE和多个ITOM领域垂直应用的云上治理平台,以“一个平台,多个应用”为产品理念,依托腾讯云海量运维专家经验,助您打造卓越架构,实现便捷、灵活的一站式云上治理。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档