Springboot注解@Aspect（二）JoinPoint 使用详解

JoinPoint 的作用

JoinPoint 常用方法

示例

JoinPoint 的子类和关联类

JoinPoint 的作用

在 Spring AOP 中，JoinPoint 接口代表了一个程序执行的点，比如方法执行或异常处理。当使用 AOP 通知（Advice）时，你可以将 JoinPoint 作为参数传递到通知方法中，以便获取有关当前执行点的详细信息。

JoinPoint 提供了一种方式来访问当前被通知方法的详细信息，如方法签名、参数等。这在编写通知逻辑时非常有用，因为你可以根据当前执行的方法来修改通知的行为。

JoinPoint：

用于所有类型的通知（@Before、@After、@AfterReturning、@AfterThrowing），但不包括环绕通知。

JoinPoint 常用方法

getArgs()：返回一个对象数组，包含了被通知方法的参数。
getThis()：返回代理对象。
getTarget()：返回目标对象。
getSignature()：返回被通知方法的签名信息。
toString()：打印出正在执行的被通知方法的详细信息。
toShortString()：提供正在执行的被通知方法的简短描述。
toLongString()：提供正在执行的被通知方法的完整描述

示例

假设你有一个前置通知（Before），你想在方法执行之前打印方法名称和参数：

ProceedingJoinPoint对象：ProceedingJoinPoint对象是JoinPoint的子接口,该对象只用在@Around的切面方法中。

@Aspect
@Component
public class aopAspect {
    /**
     * 定义一个切入点表达式,用来确定哪些类需要代理
     * execution(* aopdemo.*.*(..))代表aopdemo包下所有类的所有方法都会被代理
     */
    @Pointcut("execution(* aopdemo.*.*(..))")
    public void declareJoinPointerExpression() {}
 
    /**
     * 前置方法,在目标方法执行前执行
     * @param joinPoint 封装了代理方法信息的对象,若用不到则可以忽略不写
     */
    @Before("declareJoinPointerExpression()")
    public void beforeMethod(JoinPoint joinPoint){
        System.out.println("目标方法名为:" + joinPoint.getSignature().getName());
        System.out.println("目标方法所属类的简单类名:" +        joinPoint.getSignature().getDeclaringType().getSimpleName());
        System.out.println("目标方法所属类的类名:" + joinPoint.getSignature().getDeclaringTypeName());
        System.out.println("目标方法声明类型:" + Modifier.toString(joinPoint.getSignature().getModifiers()));
        //获取传入目标方法的参数
        Object[] args = joinPoint.getArgs();
        for (int i = 0; i < args.length; i++) {
            System.out.println("第" + (i+1) + "个参数为:" + args[i]);
        }
        System.out.println("被代理的对象:" + joinPoint.getTarget());
        System.out.println("代理对象自己:" + joinPoint.getThis());
    }
 
    /**
     * 环绕方法,可自定义目标方法执行的时机
     * @param pjd JoinPoint的子接口,添加了
     *            Object proceed() throws Throwable 执行目标方法
     *            Object proceed(Object[] var1) throws Throwable 传入的新的参数去执行目标方法
     *            两个方法
     * @return 此方法需要返回值,返回值视为目标方法的返回值
     */
    @Around("declareJoinPointerExpression()")
    public Object aroundMethod(ProceedingJoinPoint pjd){
        Object result = null;
 
        try {
            //前置通知
            System.out.println("目标方法执行前...");
            //执行目标方法
            //result = pjd.proeed();
            //用新的参数值执行目标方法
            result = pjd.proceed(new Object[]{"newSpring","newAop"});
            //返回通知
            System.out.println("目标方法返回结果后...");
        } catch (Throwable e) {
            //异常通知
            System.out.println("执行目标方法异常后...");
            throw new RuntimeException(e);
        }
        //后置通知
        System.out.println("目标方法执行后...");
 
        return result;
    }
}

被代理类

/**
 * 被代理对象
 */
@Component
public class TargetClass {
    /**
     * 拼接两个字符串
     */
    public String joint(String str1, String str2) {
        return str1 + "+" + str2;
    }
}

测试类

public class TestAop {
    @Test
    public void testAOP() {
        //1、创建Spring的IOC的容器
        ApplicationContext ctx = new ClassPathXmlApplicationContext("classpath:bean.xml");
 
        //2、从IOC容器中获取bean的实例
        TargetClass targetClass = (TargetClass) ctx.getBean("targetClass");
 
        //3、使用bean
        String result = targetClass.joint("spring","aop");
        System.out.println("result:" + result);
    }
}

结果：

目标方法执行前...
目标方法名为:joint
目标方法所属类的简单类名:TargetClass
目标方法所属类的类名:aopdemo.TargetClass
目标方法声明类型:public
第1个参数为:newSpring
第2个参数为:newAop
被代理的对象:aopdemo.TargetClass@4efc180e
代理对象自己:aopdemo.TargetClass@4efc180e
目标方法返回结果后...
目标方法执行后...
result:newSpring+newAop

JoinPoint 的子类和关联类

MethodSignature：
- MethodSignature 是 Signature 接口的子接口，专门用于方法调用。它提供了访问被拦截方法的详细信息，如方法名称、返回类型和参数类型。
- 在通知方法中，通常通过将 JoinPoint.getSignature() 的返回值强制转换为 MethodSignature 来获取更多关于方法的信息。
ProceedingJoinPoint：
- ProceedingJoinPoint 是 JoinPoint 的子接口，专门用于环绕通知（@Around）。它添加了 proceed() 方法，允许控制何时继续执行拦截的方法。
- proceed() 方法是环绕通知中的关键，它决定了是否继续执行原方法或者提前返回自定义结果。