Spring AOP：面向切面编程的最佳实践 ( 五 )

7.通知

Spring AOP（面向切面编程）中的通知（Advice）是横切关注点（cross-cutting concern）的具体实现，它定义了在连接点（join point）处执行的代码。通知是在程序执行过程中特定点插入的代码片段，这些代码片段通常用于实现诸如日志记录、性能监控、事务管理等功能。

Spring AOP 支持五种主要类型的通知：

1. 前置通知 (Before Advice)
2. 后置通知 (After Returning Advice)
3. 最终通知 (After (Finally) Advice)
4. 环绕通知 (Around Advice)
5. 抛出异常后通知 (After Throwing Advice)

7.1. 前置通知 (Before Advice)

• 定义: 前置通知是在方法调用之前执行的通知。
• 用途: 通常用于日志记录、性能监控等。

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

@Aspect
public class LoggingAspect {

    @Before("execution(* com.example.BusinessService.doSomething(..))")
    public void logBefore(JoinPoint joinPoint) {
        // 通知内容
    }
}

7.2. 后置通知 (After Returning Advice)

• 定义: 后置通知是在方法成功返回后执行的通知。
• 用途: 通常用于释放资源、日志记录等。

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

@Aspect
public class LoggingAspect {

    @AfterReturning("execution(* com.example.BusinessService.doSomething(..))")
    public void logAfter(JoinPoint joinPoint) {
        System.out.println("After doSomething: " + joinPoint.getSignature());
    }
}

7.3. 最终通知 (After (Finally) Advice)

• 定义: 最终通知无论方法是否正常返回都会执行的通知。
• 用途: 通常用于释放资源、关闭文件等。

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

@Aspect
public class LoggingAspect {

    @After("execution(* com.example.BusinessService.doSomething(..))")
    public void logFinally(JoinPoint joinPoint) {
        System.out.println("Finally after doSomething: " + joinPoint.getSignature());
    }
}

7.4. 环绕通知 (Around Advice)

• 定义: 环绕通知是在方法调用前后都执行的通知。这是最强大的通知类型，因为它可以完全控制方法的调用流程。
• 用途: 通常用于事务管理、性能监控等。

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

@Aspect
public class LoggingAspect {

    @Around("execution(* com.example.BusinessService.doSomething(..))")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Before doSomething: " + joinPoint.getSignature());
        Object result = joinPoint.proceed();
        System.out.println("After doSomething: " + joinPoint.getSignature());
        return result;
    }
}

7.5. 抛出异常后通知 (After Throwing Advice)

• 定义: 抛出异常后通知是在方法抛出异常后执行的通知。
• 用途: 通常用于错误处理、日志记录等。

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

@Aspect
public class LoggingAspect {

    @AfterThrowing(pointcut = "execution(* com.example.BusinessService.doSomething(..))", throwing = "ex")
    public void logAfterThrowing(JoinPoint joinPoint, Exception ex) {
        System.out.println("After throwing: " + joinPoint.getSignature() + ", exception: " + ex.getMessage());
    }
}

7.6.参数对象JoinPoint

所有这些通知都接收一个 JoinPoint 对象作为参数，它提供了有关连接点的信息，例如方法签名、参数值等。

1. getArgs():

   • 说明: 获取连接点方法调用时传递的参数值。
   • 返回: 一个 Object[] 数组，包含调用方法时传递的所有参数。

2. getSignature():

   • 说明: 获取连接点方法的签名信息。
   • 返回: 一个 Signature 对象，它包含了方法签名的信息，如方法名、参数类型等。

3. getThis():

   • 说明: 获取被代理的目标对象。
   • 返回: 代理对象本身。
   • 注意: 这个方法在非代理环境中可能返回 null。

4. getTarget():

   • 说明: 获取连接点方法所在的目标对象。
   • 返回: 目标对象本身。
   • 注意: 这个方法可以用来获取原始的目标对象，即使在代理环境中也是如此。

5. getStaticPart():

   • 说明: 获取连接点方法的静态部分，即方法签名和参数类型。
   • 返回: 一个 Signature 对象，它只包含静态部分的信息。
   • 注意: 这个方法主要用于获取方法签名的静态部分，而不包含参数值。

6. getKind():

   • 说明: 获取连接点的类型。
   • 返回: 一个表示连接点类型的字符串。
   • 示例: 返回 "METHOD_EXECUTION" 表示方法执行连接点。

7. getSourceLocation():

   • 说明: 获取连接点的源代码位置信息。

   • 返回: 一个 SourceLocation 对象，它包含了连接点的源代码位置信息。

环绕通知还接收一个 ProceedingJoinPoint 对象，它可以用来调用原始方法并获取结果。比 JoinPoint 多两个执行目标对象方法的方法

1. proceed():

   • 说明: 继续执行被拦截的方法调用。

   • 返回: 方法的返回值。

     Object result = joinPoint.proceed();
     

2. proceed(Object[] args):

   • 说明: 继续执行被拦截的方法调用，并允许你修改传给方法的参数。

   • 参数: 一个 Object[] 数组，包含新的参数值。

   • 返回: 方法的返回值。

     Object[] originalArgs = joinPoint.getArgs();
     Object[] modifiedArgs = new Object[]{/* 修改后的参数 */};
     Object result = joinPoint.proceed(modifiedArgs);
     

7.7.XML配置文件方式

通知可以通过注解或 XML 配置来定义。在上面的示例中，我们使用了注解来定义通知。如果你使用 XML 配置，可以像这样定义通知：

<aop:config>
    <aop:pointcut id="businessServiceDoSomething" expression="execution(* com.example.BusinessService.doSomething(..))"/>
    
    <aop:before method="logBefore" pointcut-ref="businessServiceDoSomething"/>
    <aop:after-returning method="logAfter" pointcut-ref="businessServiceDoSomething"/>
    <aop:after method="logFinally" pointcut-ref="businessServiceDoSomething"/>
    <aop:around method="logAround" pointcut-ref="businessServiceDoSomething"/>
    <aop:after-throwing method="logAfterThrowing" pointcut-ref="businessServiceDoSomething" throwing="ex"/>
    
</aop:config>

其中 method 属性 对应 切面类中的通知方法名