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,并且 MethodMatcherisRuntime() 方法返回 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

<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 将切入点和建议都封装起来,如下面的示例所示

<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>

您可以将 RegexpMethodPointcutAdvisor 与任何 Advice 类型一起使用。

属性驱动的切入点

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

动态切入点

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

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

控制流切入点

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 提供的“语义切入点”的支持,例如,“更改目标对象中实例变量的所有方法”。