创建仅适用于特定返回类型的自定义方法级别注释 [AOP]

我想创建一个仅适用于特定类型的返回值的注释。

例如，这是我的注释。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface MyAnnotation {

}

我也有一个界面：

public interface MyInterface {
    String generateKey();
}

实现我的接口的示例类：

public class ExampleClass implements MyInterface {

@Override
public String generateKey() {
   return "Whatever";
    }
}

所以在这些之后，我想以这样的方式配置我的注释它甚至不会编译如果返回类型未实现MyInterface.

在这种情况下，我希望编译良好：

@MyAnnotation
public ExampleClass anExampleMethod() {
    return new ExampleClass();
}

这不能编译：

@MyAnnotation
public String anotherMethod() {
    return "Whatever";
}

我想知道这是否有可能以任何方式实现。当然，我可以检查参数是否在我的 Aspect 类中实现此接口，但最好在我的库中拥有这种保护，以防止滥用任何注释。

辅助分类器：

这些直接来自您的示例，仅包含包名称和导入。

package de.scrum_master.app;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Retention(RUNTIME)
@Target(METHOD)
public @interface MyAnnotation {}

package de.scrum_master.app;

public interface MyInterface {
  String generateKey();
}

package de.scrum_master.app;

public class ExampleClass implements MyInterface {
  @Override
  public String generateKey() {
    return "Whatever";
  }
}

不应编译的类：

这个类有一些带注释的方法和一些不带注释的方法。一种带注释的方法可以not return MyInterface或其任何实现类。目标是编译失败。

package de.scrum_master.app;

public class Application {
  @MyAnnotation
  public MyInterface annotatedMethodReturningInterface(int number) {
    return new ExampleClass();
  }

  @MyAnnotation
  public ExampleClass annotatedMethodReturningImplementingClass() {
    return new ExampleClass();
  }

  @MyAnnotation
  public String annotatedMethodReturningSomethingElse() {
    // This one should not compile!
    return "Whatever";
  }

  public MyInterface nonAnnotatedMethodReturningInterface(int number) {
    return new ExampleClass();
  }

  public ExampleClass nonAnnotatedMethodReturningImplementingClass() {
    return new ExampleClass();
  }

  public String nonAnnotatedMethodReturningSomethingElse() {
    return "Whatever";
  }
}

约定检查方面（本机 AspectJ 语法）：

package de.scrum_master.aspect;

import de.scrum_master.app.MyAnnotation;
import de.scrum_master.app.MyInterface;

public aspect AnnotationCheckerAspect {
  declare error :
    @annotation(MyAnnotation) && execution(* *(..)) && !execution(MyInterface+ *(..)) :
    "Method annotated with @MyAnnotation must return MyInterface type";
}

这方面检查

• 所有方法执行
• 该方法有@MyAnnotation
• 但返回类型不同于MyInterface或任何子类型或实现类。

Eclipse 中的结果如下所示：

当然，如果您从命令行或通过 AspectJ Maven 插件或类似插件进行编译，编译错误是一样的。

如果您不喜欢本机语法（我更喜欢它，但由于某些难以理解的原因，其他人似乎更喜欢 @AspectJ 风格）：

约定检查方面（基于注释的 @AspectJ 语法）：

package de.scrum_master.aspect;

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

@Aspect
public class AnnotationCheckerAspect {
  @DeclareError(
    "@annotation(de.scrum_master.app.MyAnnotation) && " +
    "execution(* *(..)) && " +
    "!execution(de.scrum_master.app.MyInterface+ *(..))"
  )
  static final String wrongSignatureError =
  "Method annotated with @MyAnnotation must return MyInterface type";
}

另请参阅我的相关答案：

• https://stackoverflow.com/a/27121947/1082681 https://stackoverflow.com/a/27121947/1082681
• https://stackoverflow.com/a/54067850/1082681 https://stackoverflow.com/a/54067850/1082681
• https://stackoverflow.com/a/41700647/1082681 https://stackoverflow.com/a/41700647/1082681
• https://stackoverflow.com/a/27312472/1082681 https://stackoverflow.com/a/27312472/1082681
• https://stackoverflow.com/a/50126576/1082681 https://stackoverflow.com/a/50126576/1082681