为 Spring AOP 注释创建切入点以将注释放在类上并在类中的每个方法上执行建议

Question

我希望在类级别有注释，它将在带注释的类中对每个方法执行建议。 这有可能吗？

示例：我想用 @DoSomethingForMe 注释 OmniDemoService，并且我希望 method1 和 method2 都记录“看看我" 执行前

这个例子不起作用，我不知道为什么。当我将 Pointcut 转换为 Around 并仅将其与注释一起使用时（还将注释 ElementType 更改为方法），一切都在方法级别上工作。 所以我认为这是错误定义的Pointcut。

注释：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DoSomethingForMe {
}

建议：

@Aspect
@Component
public class DoSomethingForMeAdvice {

    private static final Logger logger = LoggerFactory.getLogger(DoSomethingForMeAdvice.class);

    @Pointcut("execution(public * *(..)) && @annotation(DoSomethingForMe)")
    public void anyAnnotatedMethod() {
    }

    @Before("anyAnnotatedMethod()")
    public void acquireExecution() {
        logger.info("look at me");
    }
}

用法：

@Service
@DoSomethingForMe
public class OmniDemoService {

    private static final Logger logger = LoggerFactory.getLogger(OmniDemoService.class);

    public void method1() {
            logger.info("---1---");
    }
    
    public void method2() {
            logger.info("---2---");
    }
}

Answer 1

您的问题是您将切入点定义与建议混淆了。

Pointcut 正在瞄准，advice 执行实际的 WhatYouWantToBeExecuted。比如说

@Pointcut("@annotation(com.omnidemo.advice.DoSomethingForMe)")
public void anyAnnotatedMethod() {
}


@Before("anyAnnotatedMethod()")
public void logMethodCall(JoinPoint jp) {
    String methodName = jp.getSignature().toShortString();
    logger.info("Executing: " + methodName);
}

Answer 2

问题的解决方法是使用withinfor切入点

@Pointcut("@within(DoSomethingForMe)")
public void anyAnnotatedMethod() {
}

@Before("anyAnnotatedMethod()")
public void acquireExecution() {
    logger.info("look at me");
}

@J Asgarov 在 cmets 中提供的解决方案

Answer 3

查看AspectJ quick reference 对@annotation() 的评价：

主题具有类型注释的任何连接点 SomeAnnotation

您使用了@annotation(DoSomethingForMe)，但方法执行的“subject”是一个方法。所以这意味着 any 方法注释 @DoSomethingForMe。

使用@this(DoSomethingForMe) 或@target(DoSomethingForMe)。

感谢kriegaex 指出@this 和@target 必须在运行时进行评估，这会严重污染代码库（即检查每个方法）。所以下一个方法更好：

---

如果您查看 AspectJ 手册中关于 type patterns 的部分，您将看到您可以直接注释类型。还请记住使用完全限定的类名。那就是：

execution(public * (@com.path.DoSomethingForMe *).*(..))

另外，如果你有这么简单的切入点，不需要重用，我想你可以放弃额外的方法，直接在advice中使用：

@Before("execution(public * (@com.path.DoSomethingForMe *).*(..))")

它说：“在执行带有@com.path.DoSomethingForMe 注释的类型的任何公共方法之前”，其中“在方法执行之前”的意思是“在方法内部，在开始时”。

---

或者，如果这个切入点对你来说有点过于复杂，你可以像这样将注解匹配和方法匹配分开，正如J Asgarov 在他的评论中所建议的那样：

@Before("execution(public * *(..)) && @within(com.path.DoSomethingForMe)")