基于模式的 AOP 支持

如果您更喜欢基于 XML 的格式，Spring 还提供对使用 aop 命名空间标记定义切面的支持。与使用 @AspectJ 样式时完全相同的切点表达式和建议类型受支持。因此，在本节中，我们重点关注该语法，并将读者转到上一节 (@AspectJ 支持) 中的讨论，以了解如何编写切点表达式和绑定建议参数。

要使用本节中描述的 aop 命名空间标记，您需要导入 spring-aop 架构，如 基于 XML 架构的配置 中所述。请参阅 AOP 架构，了解如何在 aop 命名空间中导入标记。

在 Spring 配置中，所有切面和顾问元素都必须放在 <aop:config> 元素中（您可以在应用程序上下文配置中有多个 <aop:config> 元素）。<aop:config> 元素可以包含切点、顾问和切面元素（请注意，这些元素必须按该顺序声明）。

<aop:config> 配置风格大量使用了 Spring 的 自动代理 机制。如果您已经通过使用 BeanNameAutoProxyCreator 或类似内容显式地使用了自动代理，这可能会导致问题（例如，未编织建议）。建议的使用模式是仅使用 <aop:config> 风格或仅使用 AutoProxyCreator 风格，并且永远不要将它们混合使用。

声明切面

当您使用模式支持时，切面是作为 Spring 应用程序上下文中 bean 定义的常规 Java 对象。状态和行为被捕获在对象的字段和方法中，切入点和建议信息被捕获在 XML 中。

您可以使用 <aop:aspect> 元素声明一个切面，并使用 ref 属性引用支持 bean，如下例所示

<aop:config>
	<aop:aspect id="myAspect" ref="aBean">
		...
	</aop:aspect>
</aop:config>

<bean id="aBean" class="...">
	...
</bean>

支持切面的 bean（在本例中为 aBean）当然可以像任何其他 Spring bean 一样进行配置和依赖注入。

声明切入点

您可以在 <aop:config> 元素中声明一个命名切入点，让切入点定义在多个切面和顾问中共享。

可以如下定义一个切入点，它表示服务层中任何业务服务的执行

<aop:config>

	<aop:pointcut id="businessService"
		expression="execution(* com.xyz.service.*.*(..))" />

</aop:config>

请注意，切入点表达式本身使用与 @AspectJ 支持 中描述的 AspectJ 切入点表达式语言相同的语言。如果您使用基于模式的声明风格，您还可以在切入点表达式中引用 @Aspect 类型中定义的命名切入点。因此，定义上述切入点的另一种方法如下

<aop:config>

	<aop:pointcut id="businessService"
		expression="com.xyz.CommonPointcuts.businessService()" /> (1)

</aop:config>
1 引用 共享命名切入点定义 中定义的 businessService 命名切入点。

在切面内部声明切入点与声明顶级切入点非常相似，如下例所示

<aop:config>

	<aop:aspect id="myAspect" ref="aBean">

		<aop:pointcut id="businessService"
			expression="execution(* com.xyz.service.*.*(..))"/>

		...
	</aop:aspect>

</aop:config>

与 @AspectJ 切面非常相似，使用基于模式的定义风格声明的切入点可以收集连接点上下文。例如，以下切入点将 this 对象收集为连接点上下文并将其传递给建议

<aop:config>

	<aop:aspect id="myAspect" ref="aBean">

		<aop:pointcut id="businessService"
			expression="execution(* com.xyz.service.*.*(..)) &amp;&amp; this(service)"/>

		<aop:before pointcut-ref="businessService" method="monitor"/>

		...
	</aop:aspect>

</aop:config>

必须声明建议以接收收集的连接点上下文，方法是包括匹配名称的参数，如下所示

  • Java

  • Kotlin

public void monitor(Object service) {
	// ...
}
fun monitor(service: Any) {
	// ...
}

在组合切入点子表达式时，&amp;&amp; 在 XML 文档中很别扭，因此您可以使用 and、or 和 not 关键字分别代替 &amp;&amp;、|| 和 !。例如，前一个切入点可以更好地写成如下形式

<aop:config>

	<aop:aspect id="myAspect" ref="aBean">

		<aop:pointcut id="businessService"
			expression="execution(* com.xyz.service.*.*(..)) and this(service)"/>

		<aop:before pointcut-ref="businessService" method="monitor"/>

		...
	</aop:aspect>

</aop:config>

请注意，以这种方式定义的切入点由其 XML id 引用，不能用作命名切入点来形成复合切入点。因此，基于模式的定义风格中对命名切入点的支持比 @AspectJ 风格提供的支持更有限。

声明建议

基于模式的 AOP 支持使用与 @AspectJ 风格相同的五种建议，并且它们具有完全相同的语义。

前置通知

前置通知在匹配的方法执行之前运行。它在 <aop:aspect> 中使用 <aop:before> 元素声明，如下例所示

<aop:aspect id="beforeExample" ref="aBean">

	<aop:before
		pointcut-ref="dataAccessOperation"
		method="doAccessCheck"/>

	...

</aop:aspect>

在上面的示例中，dataAccessOperation 是在顶部（<aop:config>）级别定义的命名切点的 id（请参见 声明切点）。

正如我们在对 @AspectJ 风格的讨论中指出的那样，使用命名切点可以显著提高代码的可读性。有关详细信息，请参见 共享命名切点定义。

要改为内联定义切点，请将 pointcut-ref 属性替换为 pointcut 属性，如下所示

<aop:aspect id="beforeExample" ref="aBean">

	<aop:before
		pointcut="execution(* com.xyz.dao.*.*(..))"
		method="doAccessCheck"/>

	...

</aop:aspect>

method 属性标识一个方法（doAccessCheck），该方法提供通知的主体。必须为包含通知的 aspect 元素引用的 bean 定义此方法。在执行数据访问操作（与切点表达式匹配的方法执行连接点）之前，将调用 aspect bean 上的 doAccessCheck 方法。

后置返回通知

后置返回通知在匹配的方法执行正常完成后运行。它在 <aop:aspect> 中的声明方式与前置通知相同。以下示例展示了如何声明它

<aop:aspect id="afterReturningExample" ref="aBean">

	<aop:after-returning
		pointcut="execution(* com.xyz.dao.*.*(..))"
		method="doAccessCheck"/>

	...
</aop:aspect>

与 @AspectJ 风格一样，你可以在通知主体中获取返回值。为此，请使用 returning 属性指定应将返回值传递给其的参数的名称，如下例所示

<aop:aspect id="afterReturningExample" ref="aBean">

	<aop:after-returning
		pointcut="execution(* com.xyz.dao.*.*(..))"
		returning="retVal"
		method="doAccessCheck"/>

	...
</aop:aspect>

doAccessCheck 方法必须声明一个名为 retVal 的参数。此参数的类型以与 @AfterReturning 中描述相同的方式约束匹配。例如，你可以将方法签名声明如下

  • Java

  • Kotlin

public void doAccessCheck(Object retVal) {...
fun doAccessCheck(retVal: Any) {...

后置抛出通知

后置抛出通知在匹配的方法执行通过抛出异常退出时运行。它在 <aop:aspect> 中使用 after-throwing 元素声明，如下例所示

<aop:aspect id="afterThrowingExample" ref="aBean">

	<aop:after-throwing
		pointcut="execution(* com.xyz.dao.*.*(..))"
		method="doRecoveryActions"/>

	...
</aop:aspect>

与 @AspectJ 风格一样，你可以在通知主体中获取抛出的异常。为此，请使用 throwing 属性指定应将异常传递给其的参数的名称，如下例所示

<aop:aspect id="afterThrowingExample" ref="aBean">

	<aop:after-throwing
		pointcut="execution(* com.xyz.dao.*.*(..))"
		throwing="dataAccessEx"
		method="doRecoveryActions"/>

	...
</aop:aspect>

doRecoveryActions 方法必须声明一个名为 dataAccessEx 的参数。此参数的类型以与 @AfterThrowing 所述相同的方式约束匹配。例如，方法签名可以声明如下

  • Java

  • Kotlin

public void doRecoveryActions(DataAccessException dataAccessEx) {...
fun doRecoveryActions(dataAccessEx: DataAccessException) {...

After (Finally) 建议

无论匹配的方法执行如何退出，After (finally) 建议都会运行。您可以使用 after 元素声明它，如下例所示

<aop:aspect id="afterFinallyExample" ref="aBean">

	<aop:after
		pointcut="execution(* com.xyz.dao.*.*(..))"
		method="doReleaseLock"/>

	...
</aop:aspect>

Around 建议

最后一种建议是 around 建议。Around 建议在匹配的方法执行“周围”运行。它有机会在方法运行之前和之后执行工作，并确定方法何时、如何，甚至是否实际运行。如果您需要以线程安全的方式在方法执行前后共享状态，则经常使用 Around 建议，例如，启动和停止计时器。

始终使用满足您要求的最弱形式的建议。

例如，如果 before 建议足以满足您的需求，请不要使用 around 建议。

您可以使用 aop:around 元素声明 around 建议。建议方法应将 Object 声明为其返回类型，并且该方法的第一个参数必须为 ProceedingJoinPoint 类型。在建议方法的主体中，您必须在 ProceedingJoinPoint 上调用 proceed()，以便底层方法运行。调用没有参数的 proceed() 将导致调用者原始参数在调用底层方法时提供给它。对于高级用例，有一个接受参数数组 (Object[]) 的 proceed() 方法的重载变体。当调用底层方法时，数组中的值将用作底层方法的参数。有关使用 Object[] 调用 proceed 的说明，请参阅 Around 建议。

以下示例显示如何在 XML 中声明 around 建议

<aop:aspect id="aroundExample" ref="aBean">

	<aop:around
		pointcut="execution(* com.xyz.service.*.*(..))"
		method="doBasicProfiling"/>

	...
</aop:aspect>

doBasicProfiling 建议的实现可以与 @AspectJ 示例中完全相同（当然，除了注释），如下例所示

  • Java

  • Kotlin

public Object doBasicProfiling(ProceedingJoinPoint pjp) throws Throwable {
	// start stopwatch
	Object retVal = pjp.proceed();
	// stop stopwatch
	return retVal;
}
fun doBasicProfiling(pjp: ProceedingJoinPoint): Any? {
	// start stopwatch
	val retVal = pjp.proceed()
	// stop stopwatch
	return pjp.proceed()
}

建议参数

基于模式的声明样式以与 @AspectJ 支持中所述相同的方式支持完全类型的建议，方法是按名称匹配切入点参数和建议方法参数。有关详细信息，请参阅 建议参数。如果您希望明确指定建议方法的参数名称（不依赖于前面描述的检测策略），则可以使用建议元素的 arg-names 属性，该属性的处理方式与建议注释中的 argNames 属性相同（如 确定参数名称 中所述）。以下示例显示如何在 XML 中指定参数名称

<aop:before
	pointcut="com.xyz.Pointcuts.publicMethod() and @annotation(auditable)" (1)
	method="audit"
	arg-names="auditable" />
1 引用 组合切入点表达式 中定义的名为 publicMethod 的切入点。

arg-names 属性接受逗号分隔的参数名称列表。

以下基于 XSD 的方法的稍微复杂一点的示例展示了一些与多个强类型参数结合使用的建议

  • Java

  • Kotlin

package com.xyz.service;

public interface PersonService {

	Person getPerson(String personName, int age);
}

public class DefaultPersonService implements PersonService {

	public Person getPerson(String name, int age) {
		return new Person(name, age);
	}
}
package com.xyz.service

interface PersonService {

	fun getPerson(personName: String, age: Int): Person
}

class DefaultPersonService : PersonService {

	fun getPerson(name: String, age: Int): Person {
		return Person(name, age)
	}
}

接下来是切面。请注意，profile(..) 方法接受多个强类型参数，其中第一个碰巧是用于继续进行方法调用的连接点。此参数的存在表明 profile(..) 将用作 around 建议，如下例所示

  • Java

  • Kotlin

package com.xyz;

import org.aspectj.lang.ProceedingJoinPoint;
import org.springframework.util.StopWatch;

public class SimpleProfiler {

	public Object profile(ProceedingJoinPoint call, String name, int age) throws Throwable {
		StopWatch clock = new StopWatch("Profiling for '" + name + "' and '" + age + "'");
		try {
			clock.start(call.toShortString());
			return call.proceed();
		} finally {
			clock.stop();
			System.out.println(clock.prettyPrint());
		}
	}
}
package com.xyz

import org.aspectj.lang.ProceedingJoinPoint
import org.springframework.util.StopWatch

class SimpleProfiler {

	fun profile(call: ProceedingJoinPoint, name: String, age: Int): Any? {
		val clock = StopWatch("Profiling for '$name' and '$age'")
		try {
			clock.start(call.toShortString())
			return call.proceed()
		} finally {
			clock.stop()
			println(clock.prettyPrint())
		}
	}
}

最后，以下示例 XML 配置对特定连接点的先前建议的执行产生影响

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop
		https://www.springframework.org/schema/aop/spring-aop.xsd">

	<!-- this is the object that will be proxied by Spring's AOP infrastructure -->
	<bean id="personService" class="com.xyz.service.DefaultPersonService"/>

	<!-- this is the actual advice itself -->
	<bean id="profiler" class="com.xyz.SimpleProfiler"/>

	<aop:config>
		<aop:aspect ref="profiler">

			<aop:pointcut id="theExecutionOfSomePersonServiceMethod"
				expression="execution(* com.xyz.service.PersonService.getPerson(String,int))
				and args(name, age)"/>

			<aop:around pointcut-ref="theExecutionOfSomePersonServiceMethod"
				method="profile"/>

		</aop:aspect>
	</aop:config>

</beans>

考虑以下驱动程序脚本

  • Java

  • Kotlin

public class Boot {

	public static void main(String[] args) {
		ApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml");
		PersonService person = ctx.getBean(PersonService.class);
		person.getPerson("Pengo", 12);
	}
}
fun main() {
	val ctx = ClassPathXmlApplicationContext("beans.xml")
	val person = ctx.getBean(PersonService.class)
	person.getPerson("Pengo", 12)
}

使用这样的 Boot 类，我们将在标准输出上获得类似于以下内容的输出

StopWatch 'Profiling for 'Pengo' and '12': running time (millis) = 0
-----------------------------------------
ms     %     Task name
-----------------------------------------
00000  ?  execution(getFoo)

建议排序

当多个建议需要在同一连接点（执行方法）运行时，排序规则如 建议排序 中所述。切面之间的优先级通过 <aop:aspect> 元素中的 order 属性确定，或者通过向支持该切面的 bean 添加 @Order 注解，或者通过让 bean 实现 Ordered 接口来确定。

与在同一 @Aspect 类中定义的建议方法的优先级规则相反，当在同一 <aop:aspect> 元素中定义的两条建议都需要在同一连接点运行时，优先级由建议元素在封闭的 <aop:aspect> 元素中声明的顺序确定，从最高优先级到最低优先级。

例如，给定在同一 <aop:aspect> 元素中定义的 around 建议和 before 建议，这些建议适用于同一连接点，为确保 around 建议比 before 建议具有更高的优先级，必须在 <aop:before> 元素之前声明 <aop:around> 元素。

作为一般经验法则，如果你发现你有多个在同一 <aop:aspect> 元素中定义的建议适用于同一连接点，请考虑将这些建议方法折叠到每个 <aop:aspect> 元素中的每个连接点的一个建议方法中，或者将建议方法重构为可以按切面级别排序的单独 <aop:aspect> 元素。

引入

引入（在 AspectJ 中称为类型间声明）允许切面声明建议对象实现给定的接口，并代表这些对象提供该接口的实现。

您可以在 aop:aspect 中使用 aop:declare-parents 元素进行介绍。您可以使用 aop:declare-parents 元素声明匹配类型具有新的父级（因此得名）。例如，给定一个名为 UsageTracked 的接口和一个名为 DefaultUsageTracked 的该接口的实现，以下方面声明服务接口的所有实现者也实现 UsageTracked 接口。（例如，为了通过 JMX 公开统计信息。）

<aop:aspect id="usageTrackerAspect" ref="usageTracking">

	<aop:declare-parents
		types-matching="com.xyz.service.*+"
		implement-interface="com.xyz.service.tracking.UsageTracked"
		default-impl="com.xyz.service.tracking.DefaultUsageTracked"/>

	<aop:before
		pointcut="execution(* com.xyz..service.*.*(..))
			and this(usageTracked)"
			method="recordUsage"/>

</aop:aspect>

支持 usageTracking bean 的类将包含以下方法

  • Java

  • Kotlin

public void recordUsage(UsageTracked usageTracked) {
	usageTracked.incrementUseCount();
}
fun recordUsage(usageTracked: UsageTracked) {
	usageTracked.incrementUseCount()
}

要实现的接口由 implement-interface 属性确定。types-matching 属性的值是 AspectJ 类型模式。匹配类型的任何 bean 都实现 UsageTracked 接口。请注意，在前一个示例的建议之前，服务 bean 可以直接用作 UsageTracked 接口的实现。要以编程方式访问 bean，您可以编写以下内容

  • Java

  • Kotlin

UsageTracked usageTracked = context.getBean("myService", UsageTracked.class);
val usageTracked = context.getBean("myService", UsageTracked.class)

Aspect 实例化模型

模式定义方面唯一支持的实例化模型是单例模型。其他实例化模型可能会在以后的版本中得到支持。

顾问

“顾问”的概念来自 Spring 中定义的 AOP 支持，在 AspectJ 中没有直接等效项。顾问就像一个小的独立方面，只有一条建议。建议本身由 bean 表示，并且必须实现 Spring 中的建议类型 中描述的建议接口之一。顾问可以利用 AspectJ 切入点表达式。

Spring 使用 <aop:advisor> 元素支持顾问概念。您最常看到它与事务建议结合使用，它在 Spring 中也有自己的命名空间支持。以下示例显示了一个顾问

<aop:config>

	<aop:pointcut id="businessService"
		expression="execution(* com.xyz.service.*.*(..))"/>

	<aop:advisor
		pointcut-ref="businessService"
		advice-ref="tx-advice" />

</aop:config>

<tx:advice id="tx-advice">
	<tx:attributes>
		<tx:method name="*" propagation="REQUIRED"/>
	</tx:attributes>
</tx:advice>

除了前一个示例中使用的 pointcut-ref 属性之外，您还可以使用 pointcut 属性内联定义切入点表达式。

要定义顾问的优先级，以便建议可以参与排序，请使用 order 属性定义顾问的 Ordered 值。

AOP 模式示例

本节展示了如何使用模式支持重写 AOP 示例 中的并发锁定失败重试示例。

由于并发问题（例如，死锁失败者），业务服务执行有时可能会失败。如果重试操作，则很可能在下次尝试时成功。对于在这些条件下（无需返回给用户进行冲突解决的幂等操作）重试是合适的业务服务，我们希望透明地重试操作，以避免客户端看到 PessimisticLockingFailureException。这是一项明确跨越服务层中多个服务的要求，因此，通过切面实现是理想的。

因为我们希望重试操作，所以我们需要使用 around 建议，以便我们可以多次调用 proceed。以下清单显示了基本切面实现（这是一个使用模式支持的常规 Java 类）

  • Java

  • Kotlin

public class ConcurrentOperationExecutor implements Ordered {

	private static final int DEFAULT_MAX_RETRIES = 2;

	private int maxRetries = DEFAULT_MAX_RETRIES;
	private int order = 1;

	public void setMaxRetries(int maxRetries) {
		this.maxRetries = maxRetries;
	}

	public int getOrder() {
		return this.order;
	}

	public void setOrder(int order) {
		this.order = order;
	}

	public Object doConcurrentOperation(ProceedingJoinPoint pjp) throws Throwable {
		int numAttempts = 0;
		PessimisticLockingFailureException lockFailureException;
		do {
			numAttempts++;
			try {
				return pjp.proceed();
			}
			catch(PessimisticLockingFailureException ex) {
				lockFailureException = ex;
			}
		} while(numAttempts <= this.maxRetries);
		throw lockFailureException;
	}
}
class ConcurrentOperationExecutor : Ordered {

	private val DEFAULT_MAX_RETRIES = 2

	private var maxRetries = DEFAULT_MAX_RETRIES
	private var order = 1

	fun setMaxRetries(maxRetries: Int) {
		this.maxRetries = maxRetries
	}

	override fun getOrder(): Int {
		return this.order
	}

	fun setOrder(order: Int) {
		this.order = order
	}

	fun doConcurrentOperation(pjp: ProceedingJoinPoint): Any? {
		var numAttempts = 0
		var lockFailureException: PessimisticLockingFailureException
		do {
			numAttempts++
			try {
				return pjp.proceed()
			} catch (ex: PessimisticLockingFailureException) {
				lockFailureException = ex
			}

		} while (numAttempts <= this.maxRetries)
		throw lockFailureException
	}
}

请注意，切面实现了 Ordered 接口，以便我们可以将切面的优先级设置为高于事务建议（我们希望每次重试时都进行新的事务）。maxRetries 和 order 属性均由 Spring 配置。主要操作发生在 doConcurrentOperation around 建议方法中。我们尝试继续。如果我们因 PessimisticLockingFailureException 而失败，我们将再次尝试，除非我们已经用尽了所有重试尝试。

此类与 @AspectJ 示例中使用的类相同，但去掉了注释。

相应的 Spring 配置如下

<aop:config>

	<aop:aspect id="concurrentOperationRetry" ref="concurrentOperationExecutor">

		<aop:pointcut id="idempotentOperation"
			expression="execution(* com.xyz.service.*.*(..))"/>

		<aop:around
			pointcut-ref="idempotentOperation"
			method="doConcurrentOperation"/>

	</aop:aspect>

</aop:config>

<bean id="concurrentOperationExecutor"
	class="com.xyz.service.impl.ConcurrentOperationExecutor">
		<property name="maxRetries" value="3"/>
		<property name="order" value="100"/>
</bean>

请注意，目前，我们假设所有业务服务都是幂等的。如果不是这种情况，我们可以优化切面，以便它仅重试真正幂等的操作，方法是引入一个 Idempotent 注释，并使用该注释对服务操作的实现进行注释，如下例所示

  • Java

  • Kotlin

@Retention(RetentionPolicy.RUNTIME)
// marker annotation
public @interface Idempotent {
}
@Retention(AnnotationRetention.RUNTIME)
// marker annotation
annotation class Idempotent

更改切面以仅重试幂等操作涉及优化切入点表达式，以便仅匹配 @Idempotent 操作，如下所示

<aop:pointcut id="idempotentOperation"
		expression="execution(* com.xyz.service.*.*(..)) and
		@annotation(com.xyz.service.Idempotent)"/>