声明通知

通知与切入点表达式相关联，在切入点匹配的方法执行之前、之后或周围运行。切入点表达式可以是内联切入点，也可以是命名切入点的引用。

前置通知

您可以通过使用@Before注解在切面中声明前置通知。

以下示例使用内联切入点表达式。

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

@Aspect
public class BeforeExample {

	@Before("execution(* com.xyz.dao.*.*(..))")
	public void doAccessCheck() {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.Before

@Aspect
class BeforeExample {

	@Before("execution(* com.xyz.dao.*.*(..))")
	fun doAccessCheck() {
		// ...
	}
}

如果我们使用命名切入点，我们可以将前面的示例重写如下：

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

@Aspect
public class BeforeExample {

	@Before("com.xyz.CommonPointcuts.dataAccessOperation()")
	public void doAccessCheck() {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.Before

@Aspect
class BeforeExample {

	@Before("com.xyz.CommonPointcuts.dataAccessOperation()")
	fun doAccessCheck() {
		// ...
	}
}

后置返回通知

后置返回通知在匹配的方法执行正常返回时运行。您可以使用@AfterReturning注解声明它。

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.AfterReturning;

@Aspect
public class AfterReturningExample {

	@AfterReturning("execution(* com.xyz.dao.*.*(..))")
	public void doAccessCheck() {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.AfterReturning

@Aspect
class AfterReturningExample {

	@AfterReturning("execution(* com.xyz.dao.*.*(..))")
	fun doAccessCheck() {
		// ...
	}
}

您可以在同一个切面中拥有多个通知声明（以及其他成员）。在这些示例中，我们只显示单个通知声明，以突出每个通知的效果。

有时，您需要在通知主体中访问实际返回的值。您可以使用绑定返回值的@AfterReturning形式来获得该访问权限，如下例所示：

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.AfterReturning;

@Aspect
public class AfterReturningExample {

	@AfterReturning(
		pointcut="execution(* com.xyz.dao.*.*(..))",
		returning="retVal")
	public void doAccessCheck(Object retVal) {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.AfterReturning

@Aspect
class AfterReturningExample {

	@AfterReturning(
		pointcut = "execution(* com.xyz.dao.*.*(..))",
		returning = "retVal")
	fun doAccessCheck(retVal: Any?) {
		// ...
	}
}

returning属性中使用的名称必须与通知方法中参数的名称相对应。当方法执行返回时，返回值将作为相应的参数值传递给通知方法。returning子句还将匹配限制为仅那些返回指定类型值（在本例中为Object，它匹配任何返回值）的方法执行。

请注意，在使用后置返回通知时，无法返回完全不同的引用。

后置抛出通知

后置抛出通知在匹配的方法执行因抛出异常而退出时运行。您可以使用@AfterThrowing注解声明它，如下例所示：

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.AfterThrowing;

@Aspect
public class AfterThrowingExample {

	@AfterThrowing("execution(* com.xyz.dao.*.*(..))")
	public void doRecoveryActions() {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.AfterThrowing

@Aspect
class AfterThrowingExample {

	@AfterThrowing("execution(* com.xyz.dao.*.*(..))")
	fun doRecoveryActions() {
		// ...
	}
}

通常，您希望通知仅在抛出给定类型的异常时运行，并且您通常还需要在通知主体中访问抛出的异常。您可以使用throwing属性来限制匹配（如果需要 — 否则使用Throwable作为异常类型）并将抛出的异常绑定到通知参数。以下示例演示了如何执行此操作：

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.AfterThrowing;

@Aspect
public class AfterThrowingExample {

	@AfterThrowing(
		pointcut="execution(* com.xyz.dao.*.*(..))",
		throwing="ex")
	public void doRecoveryActions(DataAccessException ex) {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.AfterThrowing

@Aspect
class AfterThrowingExample {

	@AfterThrowing(
		pointcut = "execution(* com.xyz.dao.*.*(..))",
		throwing = "ex")
	fun doRecoveryActions(ex: DataAccessException) {
		// ...
	}
}

throwing属性中使用的名称必须与通知方法中参数的名称相对应。当方法执行因抛出异常而退出时，异常将作为相应的参数值传递给通知方法。throwing子句还将匹配限制为仅那些抛出指定类型异常（在本例中为DataAccessException）的方法执行。

请注意，@AfterThrowing并不表示通用的异常处理回调。具体来说，@AfterThrowing通知方法只应接收来自连接点（用户声明的目标方法）本身的异常，而不应接收来自伴随的@After/@AfterReturning方法的异常。

后置（最终）通知

后置（最终）通知在匹配的方法执行退出时运行。它通过使用@After注解声明。后置通知必须准备好处理正常和异常返回条件。它通常用于释放资源和类似目的。以下示例演示了如何使用后置最终通知：

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.After;

@Aspect
public class AfterFinallyExample {

	@After("execution(* com.xyz.dao.*.*(..))")
	public void doReleaseLock() {
		// ...
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.After

@Aspect
class AfterFinallyExample {

	@After("execution(* com.xyz.dao.*.*(..))")
	fun doReleaseLock() {
		// ...
	}
}

请注意，AspectJ 中的@After通知被定义为“后置最终通知”，类似于 try-catch 语句中的 finally 块。它将在任何结果下被调用，无论是正常返回还是从连接点（用户声明的目标方法）抛出异常，这与仅适用于成功正常返回的@AfterReturning不同。

环绕通知

最后一种通知是环绕通知。环绕通知在匹配方法的执行“周围”运行。它有机会在方法运行之前和之后执行工作，并决定方法何时、如何以及是否实际运行。如果您需要在方法执行之前和之后以线程安全的方式共享状态（例如，启动和停止计时器），通常会使用环绕通知。

始终使用满足您需求的最低功能形式的通知。

例如，如果前置通知足以满足您的需求，请不要使用环绕通知。

环绕通知通过使用@Around注解方法来声明。该方法应将其返回类型声明为Object，并且该方法的第一个参数必须是ProceedingJoinPoint类型。在通知方法的主体中，您必须在ProceedingJoinPoint上调用proceed()，以便底层方法运行。不带参数调用proceed()将导致在调用底层方法时向其提供调用者的原始参数。对于高级用例，proceed()方法有一个重载变体，它接受一个参数数组（Object[]）。数组中的值将用作调用底层方法时的参数。

当使用Object[]调用proceed时的行为与 AspectJ 编译器编译的环绕通知的proceed行为略有不同。对于使用传统 AspectJ 语言编写的环绕通知，传递给proceed的参数数量必须与传递给环绕通知的参数数量匹配（而不是底层连接点接受的参数数量），并且在给定参数位置传递给proceed的值会取代连接点处该值所绑定实体的原始值（如果这目前没有意义，请不要担心）。

Spring 采取的方法更简单，并且更适合其基于代理的、仅执行的语义。如果您编译为 Spring 编写的@AspectJ切面并使用带有 AspectJ 编译器和织入器的proceed和参数，则只需要注意此差异。有一种编写此类切面的方法，它在 Spring AOP 和 AspectJ 之间是 100% 兼容的，这将在关于通知参数的以下部分中讨论。

环绕通知返回的值是方法调用者看到的值。例如，一个简单的缓存切面可以从缓存中返回一个值（如果它有），或者在没有缓存时调用proceed()（并返回该值）。请注意，proceed可以在环绕通知的主体中调用一次、多次或根本不调用。所有这些都是合法的。

如果将环绕通知方法的返回类型声明为void，则始终向调用者返回null，从而有效地忽略任何proceed()调用的结果。因此，建议环绕通知方法声明返回类型为Object。通知方法通常应返回proceed()调用返回的值，即使底层方法具有void返回类型。但是，根据用例，通知可以选择返回缓存值、包装值或其他值。

以下示例演示了如何使用环绕通知：

Java
Kotlin

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.ProceedingJoinPoint;

@Aspect
public class AroundExample {

	@Around("execution(* com.xyz..service.*.*(..))")
	public Object doBasicProfiling(ProceedingJoinPoint pjp) throws Throwable {
		// start stopwatch
		Object retVal = pjp.proceed();
		// stop stopwatch
		return retVal;
	}
}

import org.aspectj.lang.annotation.Aspect
import org.aspectj.lang.annotation.Around
import org.aspectj.lang.ProceedingJoinPoint

@Aspect
class AroundExample {

	@Around("execution(* com.xyz..service.*.*(..))")
	fun doBasicProfiling(pjp: ProceedingJoinPoint): Any? {
		// start stopwatch
		val retVal = pjp.proceed()
		// stop stopwatch
		return retVal
	}
}

通知参数

Spring AOP 可以处理类声明和方法参数中使用的泛型。假设您有以下泛型类型：

访问当前`JoinPoint`

任何通知方法都可以将其第一个参数声明为org.aspectj.lang.JoinPoint类型。请注意，环绕通知需要将其第一个参数声明为ProceedingJoinPoint类型，它是JoinPoint的子类。

JoinPoint接口提供了许多有用的方法：

getArgs()：返回方法参数。
getThis()：返回代理对象。
getTarget()：返回目标对象。
getSignature()：返回正在被通知的方法的描述。
toString()：打印正在被通知的方法的有用描述。

有关更多详细信息，请参见javadoc。

向通知传递参数

我们已经了解了如何绑定返回值或异常值（使用后置返回和后置抛出通知）。要使参数值可用于通知主体，您可以使用args的绑定形式。如果您在args表达式中使用参数名代替类型名，则当调用通知时，相应参数的值将作为参数值传递。一个示例应该能更清楚地说明这一点。假设您希望通知 DAO 操作的执行，该操作将Account对象作为第一个参数，并且您需要访问通知主体中的帐户。您可以编写以下内容：

Java
Kotlin

@Before("execution(* com.xyz.dao.*.*(..)) && args(account,..)")
public void validateAccount(Account account) {
	// ...
}

@Before("execution(* com.xyz.dao.*.*(..)) && args(account,..)")
fun validateAccount(account: Account) {
	// ...
}

切入点表达式的args(account,..)部分有两个目的。首先，它将匹配限制为仅那些方法接受至少一个参数，并且传递给该参数的参数是Account实例的方法执行。其次，它通过account参数使实际的Account对象可用于通知。

另一种编写方式是声明一个切入点，当它匹配连接点时“提供”Account对象值，然后从通知中引用命名切入点。这看起来如下所示：

Java
Kotlin

@Pointcut("execution(* com.xyz.dao.*.*(..)) && args(account,..)")
private void accountDataAccessOperation(Account account) {}

@Before("accountDataAccessOperation(account)")
public void validateAccount(Account account) {
	// ...
}

@Pointcut("execution(* com.xyz.dao.*.*(..)) && args(account,..)")
private fun accountDataAccessOperation(account: Account) {
}

@Before("accountDataAccessOperation(account)")
fun validateAccount(account: Account) {
	// ...
}

有关更多详细信息，请参见 AspectJ 编程指南。

代理对象（this）、目标对象（target）和注解（@within、@target、@annotation和@args）都可以以类似的方式绑定。下一组示例演示了如何匹配使用@Auditable注解注解的方法的执行并提取审计代码：

以下显示了@Auditable注解的定义：

Java
Kotlin

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Auditable {
	AuditCode value();
}

@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class Auditable(val value: AuditCode)

以下显示了匹配@Auditable方法执行的通知：

Java
Kotlin

@Before("com.xyz.Pointcuts.publicMethod() && @annotation(auditable)") (1)
public void audit(Auditable auditable) {
	AuditCode code = auditable.value();
	// ...
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。

@Before("com.xyz.Pointcuts.publicMethod() && @annotation(auditable)") (1)
fun audit(auditable: Auditable) {
	val code = auditable.value()
	// ...
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。

通知参数和泛型

Spring AOP 可以处理类声明和方法参数中使用的泛型。假设您有以下泛型类型：

Java
Kotlin

public interface Sample<T> {
	void sampleGenericMethod(T param);
	void sampleGenericCollectionMethod(Collection<T> param);
}

interface Sample<T> {
	fun sampleGenericMethod(param: T)
	fun sampleGenericCollectionMethod(param: Collection<T>)
}

您可以通过将通知参数绑定到您想要拦截方法的参数类型来限制对某些参数类型的方法类型的拦截：

Java
Kotlin

@Before("execution(* ..Sample+.sampleGenericMethod(*)) && args(param)")
public void beforeSampleMethod(MyType param) {
	// Advice implementation
}

@Before("execution(* ..Sample+.sampleGenericMethod(*)) && args(param)")
fun beforeSampleMethod(param: MyType) {
	// Advice implementation
}

这种方法不适用于泛型集合。因此，您不能按如下方式定义切入点：

Java
Kotlin

@Before("execution(* ..Sample+.sampleGenericCollectionMethod(*)) && args(param)")
public void beforeSampleMethod(Collection<MyType> param) {
	// Advice implementation
}

@Before("execution(* ..Sample+.sampleGenericCollectionMethod(*)) && args(param)")
fun beforeSampleMethod(param: Collection<MyType>) {
	// Advice implementation
}

为了使其工作，我们必须检查集合的每个元素，这是不合理的，因为我们也无法决定如何处理一般情况下的null值。要实现类似的功能，您必须将参数类型化为Collection<?>并手动检查元素的类型。

确定参数名称

通知调用中的参数绑定依赖于将切入点表达式中使用的名称与通知和切入点方法签名中声明的参数名称进行匹配。

本节交替使用参数和实参，因为 AspectJ API 将参数名称为实参名。

Spring AOP 使用以下ParameterNameDiscoverer实现来确定参数名称。每个发现者都将有机会发现参数名称，并且第一个成功的发现者获胜。如果所有注册的发现者都无法确定参数名称，则会抛出异常。

AspectJAnnotationParameterNameDiscoverer: 使用用户通过相应通知或切入点注解中的argNames属性明确指定的参数名称。有关详细信息，请参见显式参数名称。
KotlinReflectionParameterNameDiscoverer: 使用 Kotlin 反射 API 确定参数名称。此发现器仅在类路径中存在此类 API 时使用。
StandardReflectionParameterNameDiscoverer: 使用标准java.lang.reflect.Parameter API 确定参数名称。要求使用javac的-parameters标志编译代码。Java 8+ 上的推荐方法。
AspectJAdviceParameterNameDiscoverer: 从切入点表达式、returning和throwing子句推断参数名称。有关使用的算法的详细信息，请参见javadoc。

显式参数名称

@AspectJ 通知和切入点注解有一个可选的argNames属性，您可以使用它来指定注解方法的参数名称。

如果 @AspectJ 切面已由 AspectJ 编译器（ajc）编译，即使没有调试信息，您也不需要添加argNames属性，因为编译器保留了所需的信息。

同样，如果 @AspectJ 切面已使用javac和-parameters标志编译，您也不需要添加argNames属性，因为编译器保留了所需的信息。

以下示例演示了如何使用argNames属性：

Java
Kotlin

@Before(
	value = "com.xyz.Pointcuts.publicMethod() && target(bean) && @annotation(auditable)", (1)
	argNames = "bean,auditable") (2)
public void audit(Object bean, Auditable auditable) {
	AuditCode code = auditable.value();
	// ... use code and bean
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。
2	声明`bean`和`auditable`为参数名称。

@Before(
	value = "com.xyz.Pointcuts.publicMethod() && target(bean) && @annotation(auditable)", (1)
	argNames = "bean,auditable") (2)
fun audit(bean: Any, auditable: Auditable) {
	val code = auditable.value()
	// ... use code and bean
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。
2	声明`bean`和`auditable`为参数名称。

如果第一个参数的类型是JoinPoint、ProceedingJoinPoint或JoinPoint.StaticPart，则可以从argNames属性的值中省略该参数的名称。例如，如果您修改前面的通知以接收连接点对象，则argNames属性不需要包含它：

Java
Kotlin

@Before(
	value = "com.xyz.Pointcuts.publicMethod() && target(bean) && @annotation(auditable)", (1)
	argNames = "bean,auditable") (2)
public void audit(JoinPoint jp, Object bean, Auditable auditable) {
	AuditCode code = auditable.value();
	// ... use code, bean, and jp
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。
2	声明`bean`和`auditable`为参数名称。

@Before(
	value = "com.xyz.Pointcuts.publicMethod() && target(bean) && @annotation(auditable)", (1)
	argNames = "bean,auditable") (2)
fun audit(jp: JoinPoint, bean: Any, auditable: Auditable) {
	val code = auditable.value()
	// ... use code, bean, and jp
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。
2	声明`bean`和`auditable`为参数名称。

对类型为JoinPoint、ProceedingJoinPoint或JoinPoint.StaticPart的第一个参数的特殊处理对于不收集任何其他连接点上下文的通知方法特别方便。在这种情况下，您可以省略argNames属性。例如，以下通知不需要声明argNames属性：

Java
Kotlin

@Before("com.xyz.Pointcuts.publicMethod()") (1)
public void audit(JoinPoint jp) {
	// ... use jp
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。

@Before("com.xyz.Pointcuts.publicMethod()") (1)
fun audit(jp: JoinPoint) {
	// ... use jp
}

1	引用组合切入点表达式中定义的`publicMethod`命名切入点。

带参数的执行

我们之前提到过，我们将描述如何编写一个在 Spring AOP 和 AspectJ 中一致工作的带参数的proceed调用。解决方案是确保通知签名按顺序绑定每个方法参数。以下示例演示了如何执行此操作：

Java
Kotlin

@Around("execution(List<Account> find*(..)) && " +
		"com.xyz.CommonPointcuts.inDataAccessLayer() && " +
		"args(accountHolderNamePattern)") (1)
public Object preProcessQueryPattern(ProceedingJoinPoint pjp,
		String accountHolderNamePattern) throws Throwable {
	String newPattern = preProcess(accountHolderNamePattern);
	return pjp.proceed(new Object[] {newPattern});
}

1	引用共享命名切入点定义中定义的`inDataAccessLayer`命名切入点。

@Around("execution(List<Account> find*(..)) && " +
		"com.xyz.CommonPointcuts.inDataAccessLayer() && " +
		"args(accountHolderNamePattern)") (1)
fun preProcessQueryPattern(pjp: ProceedingJoinPoint,
						accountHolderNamePattern: String): Any? {
	val newPattern = preProcess(accountHolderNamePattern)
	return pjp.proceed(arrayOf<Any>(newPattern))
}

1	引用共享命名切入点定义中定义的`inDataAccessLayer`命名切入点。

在许多情况下，您无论如何都会进行这种绑定（如前面的示例所示）。

通知排序

当多个通知都想在同一个连接点运行时会发生什么？Spring AOP 遵循与 AspectJ 相同的优先级规则来确定通知的执行顺序。优先级最高的通知在“进入”时首先运行（因此，给定两个前置通知，优先级最高的那个首先运行）。在从连接点“退出”时，优先级最高的通知最后运行（因此，给定两个后置通知，优先级最高的那个将第二个运行）。

当在不同切面中定义的两个通知都需要在同一个连接点运行时，除非您另行指定，否则执行顺序是不确定的。您可以通过指定优先级来控制执行顺序。这可以通过在切面类中实现org.springframework.core.Ordered接口或使用@Order注解来完成。给定两个切面，从Ordered.getOrder()返回较低值（或注解值）的切面具有较高的优先级。

特定切面的每种不同通知类型概念上都旨在直接应用于连接点。因此，@AfterThrowing通知方法不应接收来自伴随的@After/@AfterReturning方法的异常。

在同一个@Aspect类中定义的、需要在同一个连接点运行的通知方法，根据其通知类型按以下顺序分配优先级，从高到低依次为：@Around、@Before、@After、@AfterReturning、@AfterThrowing。但是请注意，@After通知方法实际上将在同一个切面中的任何@AfterReturning或@AfterThrowing通知方法之后被调用，遵循 AspectJ 对@After的“after finally advice”语义。

当在同一个@Aspect类中定义的两个相同类型的通知（例如，两个@After通知方法）都需要在同一个连接点运行，并且它们的排序未定义时（因为无法通过反射获取 javac 编译类的源代码声明顺序）。可以考虑将此类通知方法合并为每个@Aspect类中每个连接点的一个通知方法，或者将通知分解为单独的@Aspect类，然后您可以通过Ordered或@Order在切面级别对它们进行排序。