如果 java 源正在调用带注释的方法，如何编写注释处理器以引发警告消息答案

【问题标题】：How to write annotation processor to raise a warning message if a java source is calling an annotated method如果 java 源正在调用带注释的方法，如何编写注释处理器以引发警告消息
【发布时间】：2012-10-23 12:08:33
【问题描述】：

这是我对 Java 6 的要求：我正在使用 Eclipse JUNO。

使用自定义注释对方法进行注释。
在编译期间，如果方法正在调用带注释的方法。

我正在寻找类似@Deprecated 注解的东西。

这就是我所做的：

编写了自定义注释。
编写了一个注释处理器来读取和处理方法注释。

创建了一个 jar 并将其添加到注释处理器路径中。我的示例代码（见下文）在带注释的方法中引发了警告消息。但这不是我的要求。

我不能做的事：

我无法获得调用方法。我想发出警告那些调用方法中的消息。

我的示例代码：

自定义注解：

package tool.apichecks;

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

@Retention(RetentionPolicy.SOURCE)
@Target({ ElementType.METHOD })
public @interface HighCostMethod {
    String altMethod();
}

注释处理器：

    package tool.apichecks;

import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic.Kind;

@SupportedAnnotationTypes({ "tool.apichecks.HighCostMethod" })
public class MethodProcessor extends AbstractProcessor {

    private enum MethodType {
        HIGH_COST(HighCostMethod.class.getName());

        private String name;

        private MethodType(String name) {
            this.name = name;
        }

        private static MethodType getMethodType(String name) {
            MethodType methodType = null;
            for (MethodType methodType2 : MethodType.values()) {
                if (methodType2.name.equals(name)) {
                    methodType = methodType2;
                    break;
                }
            }
            return methodType;
        }
    }

    private ProcessingEnvironment processingEnvironment;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        this.processingEnvironment = processingEnvironment;
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations,
            RoundEnvironment roundEnvironment) {
        if (!roundEnvironment.processingOver()) {
            for (TypeElement annotation : annotations) {
                final Set<? extends Element> elements = roundEnvironment
                        .getElementsAnnotatedWith(annotation);
                MethodType methodType = MethodType.getMethodType(annotation
                        .toString());

                for (Element element : elements) {
                    switch (methodType) {
                    case HIGH_COST: {
                        processHighCostMethod(element);
                        break;
                    }
                    }
                }
            }
        }
        return true;
    }

    protected void processHighCostMethod(Element element) {
        HighCostMethod highCostMethod = element
                .getAnnotation(HighCostMethod.class);
        /* TODO This warns the annotated method itself. I don't want this. I want to warn the methods that calls this method */
        processingEnvironment
                .getMessager()
                .printMessage(
                        Kind.WARNING,
                        String.format(
                                "Do not use high cost method %s. Instead use %s method.",
                                element, highCostMethod.altMethod()), element);
    }

}

【问题讨论】：

标签： compilation annotations warnings processor

【解决方案1】：

使用 AnnotationProcessor 将仅适用于包含注释或覆盖方法的文件，但不适用于调用方法。也许有办法解决这个问题，但你可能会受到项目的限制，因为处理器一次只查看一个项目。

我猜你需要编写一个带有构建器的 Eclipse 插件，它可以分析所有文件中的代码并检查称为方法的注释。这比注释处理器工作更多，但您也有更多选择。例如。您可以对错误标记实施快速修复。

【讨论】：