Spring AOP如何为目标方法创建拦截器链?

简介: Spring AOP如何为目标方法创建拦截器链?

在Spring AOP中代理对象增强通知执行原理一文中我们提到了为目标方法进行增强分析了其执行流程。本文我们详细研究一下拦截器链的产生。


取得拦截器链的工作是由配置好的advisorChainFactory来完成的,从名字上可以猜到,它是一个生成通知器链的工厂。在这里advisorchainFactory被配置成一个DefaultAdvisorChainFactory对象,实现了interceptor链的获取。

拦截器链的产生是由DefaultAdvisorChainFactory 类完成的,该类如下所示。

public class DefaultAdvisorChainFactory implements AdvisorChainFactory, Serializable {
  @Override
  public List<Object> getInterceptorsAndDynamicInterceptionAdvice(
      Advised config, Method method, @Nullable Class<?> targetClass) {
    // This is somewhat tricky... We have to process introductions first,
    // but we need to preserve order in the ultimate list.
// 单例 AdvisorAdapterRegistry 
    AdvisorAdapterRegistry registry = GlobalAdvisorAdapterRegistry.getInstance();
  //获取到Advisors 每个advisor包含了advice
    Advisor[] advisors = config.getAdvisors();
    List<Object> interceptorList = new ArrayList<>(advisors.length);
    // 获取target class
    Class<?> actualClass = (targetClass != null ? targetClass : method.getDeclaringClass());
    // 是否有引入通知
    Boolean hasIntroductions = null;
    // 遍历advisors 
    for (Advisor advisor : advisors) {
        // 1.判断是否为PointcutAdvisor
      if (advisor instanceof PointcutAdvisor) {
        // Add it conditionally.
        PointcutAdvisor pointcutAdvisor = (PointcutAdvisor) advisor;
        if (config.isPreFiltered() || pointcutAdvisor.getPointcut().getClassFilter().matches(actualClass)) {
          MethodMatcher mm = pointcutAdvisor.getPointcut().getMethodMatcher();
          boolean match;
          if (mm instanceof IntroductionAwareMethodMatcher) {
            if (hasIntroductions == null) {
              hasIntroductions = hasMatchingIntroductions(advisors, actualClass);
            }
            match = ((IntroductionAwareMethodMatcher) mm).matches(method, actualClass, hasIntroductions);
          }
          else {
            match = mm.matches(method, actualClass);
          }
          if (match) {
            MethodInterceptor[] interceptors = registry.getInterceptors(advisor);
            if (mm.isRuntime()) {
              // Creating a new object instance in the getInterceptors() method
              // isn't a problem as we normally cache created chains.
              for (MethodInterceptor interceptor : interceptors) {
                interceptorList.add(new InterceptorAndDynamicMethodMatcher(interceptor, mm));
              }
            }
            else {
              interceptorList.addAll(Arrays.asList(interceptors));
            }
          }
        }
      }
      // 2.判断是否为引入通知IntroductionAdvisor
      else if (advisor instanceof IntroductionAdvisor) {
        IntroductionAdvisor ia = (IntroductionAdvisor) advisor;
        if (config.isPreFiltered() || ia.getClassFilter().matches(actualClass)) {
          Interceptor[] interceptors = registry.getInterceptors(advisor);
          interceptorList.addAll(Arrays.asList(interceptors));
        }
      }
      // 3.其他则直接获取Interceptor
      else {
        Interceptor[] interceptors = registry.getInterceptors(advisor);
        interceptorList.addAll(Arrays.asList(interceptors));
      }
    }
    return interceptorList;
  }
   // 是否包含引入通知且适配actualClass
  private static boolean hasMatchingIntroductions(Advisor[] advisors, Class<?> actualClass) {
    for (Advisor advisor : advisors) {
      if (advisor instanceof IntroductionAdvisor) {
        IntroductionAdvisor ia = (IntroductionAdvisor) advisor;
        if (ia.getClassFilter().matches(actualClass)) {
          return true;
        }
      }
    }
    return false;
  }
}

从上述方法我们可以了解到其首先获取了AdvisorAdapterRegistry与advisors,然后对advisors进行了遍历最终通过AdvisorAdapterRegistry获取Interceptor。


在对advisors进行遍历获取Interceptor分为三种情况:

PointcutAdvisor,如我们自定义切面中的advice被包装后的advisor

IntroductionAdvisor,如DefaultIntroductionAdvisor与DeclareParentsAdvisor

其他如ProxyFactoryBean的内部类PrototypePlaceholderAdvisor

【1】PointcutAdvisor情况下获取Interceptor

如果Advisor是PointcutAdvisor,那么将会执行如下方法逻辑。这种Advisor也是最常见的Advisor,我们切面中的增强方法就会被包装为这种类型的Advisor。

// 类型转换
PointcutAdvisor pointcutAdvisor = (PointcutAdvisor) advisor;
// 首先通过ClassFilter进行类型匹配
if (config.isPreFiltered() || pointcutAdvisor.getPointcut().getClassFilter().matches(actualClass)) {
// 我们自定义切面这里的Pointcut是AspectJExpressionPointcut
  MethodMatcher mm = pointcutAdvisor.getPointcut().getMethodMatcher();
  boolean match;
  // 其次进行方法匹配,是否对actualClass的method生效
  if (mm instanceof IntroductionAwareMethodMatcher) {
    // 这里会判断是否为IntroductionAwareMethodMatcher,
    //我们的AspectJExpressionPointcut就是这种类型
    if (hasIntroductions == null) {
      // 是否有引入通知且匹配当前actualClass
      hasIntroductions = hasMatchingIntroductions(advisors, actualClass);
    }
    match = ((IntroductionAwareMethodMatcher) mm).matches(method, actualClass, hasIntroductions);
  }
  else {
    match = mm.matches(method, actualClass);
  }
  // 如果匹配则调用registry获取MethodInterceptor
  if (match) {
    MethodInterceptor[] interceptors = registry.getInterceptors(advisor);
    if (mm.isRuntime()) {
      // Creating a new object instance in the getInterceptors() method
      // isn't a problem as we normally cache created chains.
      for (MethodInterceptor interceptor : interceptors) {
        interceptorList.add(new InterceptorAndDynamicMethodMatcher(interceptor, mm));
      }
    }
    else {
      interceptorList.addAll(Arrays.asList(interceptors));
    }
  }
}

如上所示,首先获取MethodMatcher 校验当前advisor是否匹配actualClass的该method,如果匹配则调用registry获取MethodInterceptor[]。如果MethodMatcher 是在runTime状态(也就是动态的)则对之前拿到的MethodInterceptor[] interceptors进行遍历封装为InterceptorAndDynamicMethodMatcher。可以看到,在DefaultAdvisorChainFactory的实现中,首先够早了一个GlobalAdvisorAdapterRegistry单件,然后对配置的Advisor通知器进行逐个遍历,在遍历的过程中会使用GlobalAdvisorAdapterRegistry完成适配和注册过程。

【2】IntroductionAdvisor情况下获取Interceptor

IntroductionAdvisor其实就是指DefaultIntroductionAdvisor和DeclareParentsAdvisor。方法如下所示,对cofig进行过滤判断及ClassFilter是否匹配actualClass判断后直接使用registry获取Interceptor。

IntroductionAdvisor ia = (IntroductionAdvisor) advisor;
if (config.isPreFiltered() || ia.getClassFilter().matches(actualClass)) {
  Interceptor[] interceptors = registry.getInterceptors(advisor);
  interceptorList.addAll(Arrays.asList(interceptors));
}

至于最后一种其他情况则是直接通过registry获取Interceptor。

else {
  Interceptor[] interceptors = registry.getInterceptors(advisor);
  interceptorList.addAll(Arrays.asList(interceptors));
}

【3】AdvisorAdapterRegistry获取拦截器

这里的AdvisorAdapterRegistry其实是DefaultAdvisorAdapterRegistry。其在实例化的时候就会注册三个Adapter用来对BeforeAdvice、ReturningAdvice及ThrowsAdvice进行适配。

public DefaultAdvisorAdapterRegistry() {
  registerAdvisorAdapter(new MethodBeforeAdviceAdapter());
  registerAdvisorAdapter(new AfterReturningAdviceAdapter());
  registerAdvisorAdapter(new ThrowsAdviceAdapter());
}

我们继续看其getInterceptors方法。

@Override
public MethodInterceptor[] getInterceptors(Advisor advisor) throws UnknownAdviceTypeException {
  List<MethodInterceptor> interceptors = new ArrayList<>(3);
  // 获取Advisor内部的advice
  Advice advice = advisor.getAdvice();
  // 如果其是MethodInterceptor类型,则直接放入
  if (advice instanceof MethodInterceptor) {
    interceptors.add((MethodInterceptor) advice);
  }
  // 否则通过适配器尝试得到MethodInterceptor
  for (AdvisorAdapter adapter : this.adapters) {
    if (adapter.supportsAdvice(advice)) {
      interceptors.add(adapter.getInterceptor(advisor));
    }
  }
  // 如果拦截器为空,抛出异常
  if (interceptors.isEmpty()) {
    throw new UnknownAdviceTypeException(advisor.getAdvice());
  }
  //返回
  return interceptors.toArray(new MethodInterceptor[0]);
}

如下图所示,AspectJAroundAdvice、AspectJAfterThrowingAdvice以及AspectJAfterAdvice本身就实现了MethodInterceptor接口,是MethodInterceptor类型。


b143187e84ba4e24878337e117b35488.pngThrowsAdviceAdapter

// 判断条件
advice instanceof ThrowsAdvice
// 返回结果
new ThrowsAdviceInterceptor(advisor.getAdvice())

AfterReturningAdviceAdapter

// 判断条件
advice instanceof AfterReturningAdvice
// 返回结果
new AfterReturningAdviceInterceptor(advice)

MethodBeforeAdviceAdapter

// 判断条件
advice instanceof MethodBeforeAdvice
// 返回结果
new MethodBeforeAdviceInterceptor(advice)

最终我们获取的拦截器会放到AdvisedSupport的Map<MethodCacheKey, List<Object>> methodCache缓存里面,如下图所示。


目录
相关文章
|
15天前
|
XML Java 开发者
Spring Boot中的AOP实现
Spring AOP(面向切面编程)允许开发者在不修改原有业务逻辑的情况下增强功能,基于代理模式拦截和增强方法调用。Spring Boot通过集成Spring AOP和AspectJ简化了AOP的使用,只需添加依赖并定义切面类。关键概念包括切面、通知和切点。切面类使用`@Aspect`和`@Component`注解标注,通知定义切面行为,切点定义应用位置。Spring Boot自动检测并创建代理对象,支持JDK动态代理和CGLIB代理。通过源码分析可深入了解其实现细节,优化应用功能。
|
1月前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
175 73
|
23天前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
71 8
|
2月前
|
监控 安全 Java
什么是AOP?如何与Spring Boot一起使用?
什么是AOP?如何与Spring Boot一起使用?
103 5
|
2月前
|
监控 Java 数据安全/隐私保护
如何用Spring Boot实现拦截器:从入门到实践
如何用Spring Boot实现拦截器:从入门到实践
72 5
|
2月前
|
Java 开发者 Spring
Spring AOP 底层原理技术分享
Spring AOP(面向切面编程)是Spring框架中一个强大的功能,它允许开发者在不修改业务逻辑代码的情况下,增加额外的功能,如日志记录、事务管理等。本文将深入探讨Spring AOP的底层原理,包括其核心概念、实现方式以及如何与Spring框架协同工作。
|
2月前
|
XML 监控 安全
深入调查研究Spring AOP
【11月更文挑战第15天】
56 5
|
2月前
|
Java 开发者 Spring
Spring AOP深度解析:探秘动态代理与增强逻辑
Spring框架中的AOP(Aspect-Oriented Programming,面向切面编程)功能为开发者提供了一种强大的工具,用以将横切关注点(如日志、事务管理等)与业务逻辑分离。本文将深入探讨Spring AOP的底层原理,包括动态代理机制和增强逻辑的实现。
62 4
|
4月前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
AOP(面向切面编程)能够帮助我们在不修改现有代码的前提下,为应用程序添加新的功能或行为。Micronaut框架中的AOP模块通过动态代理机制实现了这一目标。AOP将横切关注点(如日志记录、事务管理等)从业务逻辑中分离出来,提高模块化程度。在Micronaut中,带有特定注解的类会在启动时生成代理对象,在运行时拦截方法调用并执行额外逻辑。例如,可以通过创建切面类并在目标类上添加注解来记录方法调用信息,从而在不侵入原有代码的情况下增强应用功能,提高代码的可维护性和可扩展性。
98 1
|
2月前
|
安全 Java 编译器
什么是AOP面向切面编程?怎么简单理解?
本文介绍了面向切面编程(AOP)的基本概念和原理,解释了如何通过分离横切关注点(如日志、事务管理等)来增强代码的模块化和可维护性。AOP的核心概念包括切面、连接点、切入点、通知和织入。文章还提供了一个使用Spring AOP的简单示例,展示了如何定义和应用切面。
362 1
什么是AOP面向切面编程?怎么简单理解?