java - 如何使用@Target(ElementType.TYPE_USE) 处理注解？

Question

我正在实现一个注释处理器，以确保标有注释的元素是实现特定接口(interface)的类的实例，或者是实现特定接口(interface)的类型的使用:

@Documented
@Target(value = { ElementType.PARAMETER, ElementType.TYPE_USE })
@Retention(value = RetentionPolicy.RUNTIME)
public @interface AuditSubject {

}

public interface Auditable {
    // methods that provide data for writing a log entry...
}

public class Report implements Auditable {

}

对于带注释的元素，必须在方法执行后创建一个日志条目(使用 AOP)。示例:

@CreateLogEntry
public Result persist(@AuditSubject Report newReport) {
    // A log entry must be created based on the incoming 'newReport' instance.    
}

@CreateLogEntry
public UpdateResult<@AuditSubject Report> update(Report update) {
    // A log entry must be created based on the updated report, which is not the same instance as 'update' but an equivalent one.
} 

@CreateLogEntry
public Result persistBatch(List<@AuditSubject Report> batch) {
    // A log entry must be created for each element in 'batch' after this method's execution.
}

如果 Report 实现了 Auditable，则必须创建日志条目；如果没有，则抛出运行时异常(哎呀，我忘了实现接口(interface)!)。因此，注释处理器有助于在编译时捕获程序员的错误。到目前为止，我已经成功地检查了参数中的所有使用，但没有检查类型使用。注释处理器的相关代码如下:

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (Element annotated : roundEnv.getElementsAnnotatedWith(AuditSubject.class)) {
        // Only prints elements with ElementKind.PARAMETER)!
        this.messager.printMessage(Kind.NOTE, TextUtils.replaceParams("annotated: {} ; Kind : {} ; enclosing : {}", annotated,  annotated.getKind(), annotated.getEnclosingElement()));

        if (annotated.getKind() == ElementKind.PARAMETER) {
            // Code here works as expected, raises errors for annotated parameters of classes that don't implement Auditable.
        } else if (annotated.getKind() == ElementKind.WHAT_TO_USE) {
            // What ElementKind do I need to use here?
        }
    }

    return false;
}

只有类型为 ElementKind.PARAMETER 的注释元素被识别(process() 循环中的第一行只为 'newReport' 打印一行)如何我检查带注释的类型是否实现了 Auditable？没有“ElementKind.TYPE_USE”常量可供使用。我一直无法找到有关此事的任何相关信息。感谢您的关注。

Answer 1

Java注解处理API是在Java只支持声明注解的时候设计的。 API 仅支持访问声明，例如字段、方法和方法参数。它不访问局部变量声明，也不访问方法体内的其他注释，也不访问类型注释。

如果您希望处理类型注释或方法体内的注释，您将需要编写自己的代码以递归类型或递归检查方法中的代码行。

另一种方法是使用类似 Checker Framework 的工具.它实现了自己的访问者，因此每次出现类型注释时都会调用构建在其上的注释处理器。