AspectJ中JoinPoint和ProceedingJoinPoint注解的使用

原创已于 2023-03-26 21:03:42 修改 · 3.3k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2022-05-07 12:08:03 首次发布

本文详细介绍了AOP（面向切面编程）中的JointPoint和ProceedingJoinPoint概念，以及它们在Spring框架中的应用。JointPoint是程序执行过程中的可识别点，而Pointcut则是选择和组合这些点的规则。ProceedingJoinPoint在JointPoint基础上增加了proceed()方法，用于在环绕通知中启动目标方法的执行。通过实例展示了如何使用@Around注解定义环绕通知，并通过CustomLog注解实现日志记录功能。

概念

Joint Point

JointPoint是程序运行过程中可识别的点，这个点可以用来作为AOP切入点。JointPoint对象则包含了和切入相关的很多信息。比如切入点的对象，方法，属性等。我们可以通过反射的方式获取这些点的状态和信息，用于追踪tracing和记录logging应用信息。

Pointcut

pointcut 是一种程序结构和规则，它用于选取join point并收集这些point的上下文信息。
pointcut通常包含了一系列的Joint Point，我们可以通过pointcut来同时操作jointpoint。单从概念上，可以把Pointcut当做jointpoint的集合。

JointPoint和ProceedingJoinPoint区别
JoinPoint
joinpoint的方法如下

# 返回目标对象，即被代理的对象
Object getTarget();

# 返回切入点的参数
Object[] getArgs();

# 返回切入点的Signature
Signature getSignature();

# 返回切入的类型，比如method-call，field-get等等，不重要
 String getKind();

ProceedingJoinPoint
Proceedingjoinpoint 继承了 JoinPoint。是在JoinPoint的基础上暴露出 proceed 这个方法。proceed很重要，这个是aop代理链执行的方法。

public interface ProceedingJoinPoint extends JoinPoint {
    void set$AroundClosure(AroundClosure var1);

    default void stack$AroundClosure(AroundClosure arc) {
        throw new UnsupportedOperationException();
    }

    Object proceed() throws Throwable;

    Object proceed(Object[] var1) throws Throwable;
}

ProceedingJoinPoint只能用在around(环绕通知)中
环绕通知=前置+目标方法执行+后置通知，proceed方法就是用于启动目标方法执行的

joinPoint使用方法如下

		//1.获取切入点所在的目标对象
       	Object obj = joinPoint.getTarget();  
       	//2.获取修饰符+ 包名+组件名(类名) +方法名
        Signature signature = joinPoint.getSignature();
		//3.获取方法上的注解
		MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method != null)
        {
            xxxxxx annoObj= method.getAnnotation(xxxxxx.class);
        }
        return null;
        //4.获取切入点方法上的参数列表
        Object[] args = joinPoint.getArgs();

使用案例，环绕通知
1.定义一个注解模拟记录日志

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CustomLog {
    String title() default "";
}

2.定一个切面

@Aspect
@Component
@Slf4j
public class CustomAspect {

    /**
     * 定义切入点
     */
    @Pointcut("@annotation(io.renren.common.annotation.CustomLog)")
    public void CusjoinPoint() {

    }

    /**
     * 环绕通知
     * @param joinPoint
     * @return
     * @throws Throwable
     */
    @Around("CusjoinPoint()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        Object proceed = joinPoint.proceed();
        log(joinPoint);
        return proceed;
    }

    /**
     * 简单打印日志--
     * @param joinPoint
     */
    private void log(ProceedingJoinPoint joinPoint) {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        String methodName = method.getName();
        CustomLog customLog = method.getDeclaredAnnotation(CustomLog.class);
        String title = customLog.title();
        log.info("methodName =>{},title=>>>>{}",methodName,title);
    }
}