Spring 中的切入点 API

本节描述了 Spring 如何处理关键的切入点概念。

概念

Spring 的切入点模型支持独立于通知类型重用切入点。你可以使用同一个切入点针对不同的通知。

org.springframework.aop.Pointcut 接口是核心接口,用于将通知目标指向特定的类和方法。完整的接口如下:

public interface Pointcut {

	ClassFilter getClassFilter();

	MethodMatcher getMethodMatcher();
}

Pointcut 接口拆分为两部分,允许重用类和方法匹配部分,并支持细粒度的组合操作(例如与另一个方法匹配器执行“并集”)。

ClassFilter 接口用于将切入点限制到给定的目标类集合。如果 matches() 方法始终返回 true,则匹配所有目标类。以下列表显示了 ClassFilter 接口定义:

public interface ClassFilter {

	boolean matches(Class clazz);
}

MethodMatcher 接口通常更重要。完整的接口如下:

public interface MethodMatcher {

	boolean matches(Method m, Class<?> targetClass);

	boolean isRuntime();

	boolean matches(Method m, Class<?> targetClass, Object... args);
}

matches(Method, Class) 方法用于测试此切入点是否匹配目标类上的给定方法。可以在创建 AOP 代理时执行此评估,以避免在每次方法调用时都进行测试。如果给定方法的双参数 matches 方法返回 true,并且 MethodMatcher 的 isRuntime() 方法返回 true,则在每次方法调用时都会调用三参数 matches 方法。这允许切入点在目标通知开始之前立即查看传递给方法调用的参数。

大多数 MethodMatcher 实现是静态的,这意味着它们的 isRuntime() 方法返回 false。在这种情况下,永远不会调用三参数 matches 方法。

如果可能,尽量使切入点成为静态的,这样 AOP 框架可以在创建 AOP 代理时缓存切入点评估的结果。

切入点操作

Spring 支持对切入点进行操作(特别是并集和交集)。

并集意味着任一切入点匹配的方法。交集意味着两个切入点都匹配的方法。并集通常更有用。你可以使用 org.springframework.aop.support.Pointcuts 类中的静态方法或同一包中的 ComposablePointcut 类来组合切入点。然而,使用 AspectJ 切入点表达式通常是更简单的方法。

AspectJ 表达式切入点

自 2.0 版起,Spring 使用的最重要类型的切入点是 org.springframework.aop.aspectj.AspectJExpressionPointcut。此切入点使用 AspectJ 提供的库解析 AspectJ 切入点表达式字符串。

有关支持的 AspectJ 切入点原语的讨论,请参阅上一章

便利的切入点实现

Spring 提供了几种便利的切入点实现。你可以直接使用其中一些;另一些则旨在供子类使用,以实现特定于应用的切入点。

静态切入点

静态切入点基于方法和目标类,不能考虑方法的参数。静态切入点对于大多数用法来说是足够的——并且是最好的。Spring 可以在方法首次被调用时只评估一次静态切入点。之后,无需在每次方法调用时再次评估切入点。

本节的其余部分描述了 Spring 中包含的一些静态切入点实现。

正则表达式切入点

指定静态切入点的一种显而易见的方式是正则表达式。除了 Spring 之外,还有一些 AOP 框架也支持这一点。org.springframework.aop.support.JdkRegexpMethodPointcut 是一个通用的正则表达式切入点,它使用 JDK 中的正则表达式支持。

使用 JdkRegexpMethodPointcut 类,你可以提供一个模式字符串列表。如果其中任何一个匹配,切入点将评估为 true。(因此,结果切入点实际上是指定模式的并集。)

以下示例展示了如何使用 JdkRegexpMethodPointcut

  • Java

  • Kotlin

  • Xml

@Configuration
public class JdkRegexpConfiguration {

	@Bean
	public JdkRegexpMethodPointcut settersAndAbsquatulatePointcut() {
		JdkRegexpMethodPointcut pointcut = new JdkRegexpMethodPointcut();
		pointcut.setPatterns(".*set.*", ".*absquatulate");
		return pointcut;
	}
}
@Configuration
class JdkRegexpConfiguration {

	@Bean
	fun settersAndAbsquatulatePointcut() = JdkRegexpMethodPointcut().apply {
		setPatterns(".*set.*", ".*absquatulate")
	}
}
<bean id="settersAndAbsquatulatePointcut"
	  class="org.springframework.aop.support.JdkRegexpMethodPointcut">
	<property name="patterns">
		<list>
			<value>.*set.*</value>
			<value>.*absquatulate</value>
		</list>
	</property>
</bean>

Spring 提供了一个名为 RegexpMethodPointcutAdvisor 的便利类,它允许我们也引用一个 Advice(请记住,Advice 可以是拦截器、前置通知、抛出通知等等)。在底层,Spring 使用 JdkRegexpMethodPointcut。使用 RegexpMethodPointcutAdvisor 可以简化配置,因为一个 Bean 封装了切入点和通知,如下面的示例所示:

  • Java

  • Kotlin

  • Xml

@Configuration
public class RegexpConfiguration {

	@Bean
	public RegexpMethodPointcutAdvisor settersAndAbsquatulateAdvisor(Advice beanNameOfAopAllianceInterceptor) {
		RegexpMethodPointcutAdvisor advisor = new RegexpMethodPointcutAdvisor();
		advisor.setAdvice(beanNameOfAopAllianceInterceptor);
		advisor.setPatterns(".*set.*", ".*absquatulate");
		return advisor;
	}
}
@Configuration
class RegexpConfiguration {

	@Bean
	fun settersAndAbsquatulateAdvisor(beanNameOfAopAllianceInterceptor: Advice) = RegexpMethodPointcutAdvisor().apply {
		advice = beanNameOfAopAllianceInterceptor
		setPatterns(".*set.*", ".*absquatulate")
	}
}
<bean id="settersAndAbsquatulateAdvisor"
	  class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">
	<property name="advice">
		<ref bean="beanNameOfAopAllianceInterceptor"/>
	</property>
	<property name="patterns">
		<list>
			<value>.*set.*</value>
			<value>.*absquatulate</value>
		</list>
	</property>
</bean>

你可以搭配任何 Advice 类型使用 RegexpMethodPointcutAdvisor

属性驱动的切入点

一种重要的静态切入点是元数据驱动的切入点。它使用元数据属性的值(通常是源代码级别的元数据)。

动态切入点

动态切入点比静态切入点评估成本更高。它们不仅考虑静态信息,还考虑方法参数。这意味着必须在每次方法调用时评估它们,并且结果无法缓存,因为参数会变化。

主要示例是控制流切入点。

控制流切入点

Spring 控制流切入点概念上类似于 AspectJ cflow 切入点,尽管功能较弱。(目前无法指定切入点运行在另一个切入点匹配的连接点之下。)控制流切入点匹配当前的调用栈。例如,如果连接点是由 com.mycompany.web 包中的方法或 SomeCaller 类调用的,则它可能会触发。控制流切入点通过使用 org.springframework.aop.support.ControlFlowPointcut 类来指定。

控制流切入点在运行时评估的成本显著高于其他动态切入点。在 Java 1.4 中,其成本大约是其他动态切入点的五倍。

切入点超类

Spring 提供了有用的切入点超类,以帮助你实现自己的切入点。

由于静态切入点最常用,你可能应该继承 StaticMethodMatcherPointcut。这只需要实现一个抽象方法(当然你也可以覆盖其他方法来定制行为)。以下示例展示了如何继承 StaticMethodMatcherPointcut

  • Java

  • Kotlin

class TestStaticPointcut extends StaticMethodMatcherPointcut {

	public boolean matches(Method m, Class targetClass) {
		// return true if custom criteria match
	}
}
class TestStaticPointcut : StaticMethodMatcherPointcut() {

	override fun matches(method: Method, targetClass: Class<*>): Boolean {
		// return true if custom criteria match
	}
}

动态切入点也有超类。你可以搭配任何通知类型使用自定义切入点。

自定义切入点

由于 Spring AOP 中的切入点是 Java 类,而不是像 AspectJ 那样的语言特性,因此你可以声明自定义切入点,无论是静态的还是动态的。Spring 中的自定义切入点可以任意复杂。但是,如果可能,我们建议使用 AspectJ 切入点表达式语言。

Spring 的后续版本可能会提供 JAC 提供的“语义切入点”支持——例如,“目标对象中所有改变实例变量的方法”。