Java 注解处理器及其应用

package com.zzuhkp;
import java.util.Set;
import javax.annotation.processing.Completion;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
/**
 * 自定义注解处理器
 *
 * @author zzuhkp
 * @date 2020-08-14 10:50
 * @since 1.0
 */
public class CustomProcessor implements Processor {
    /**
     * 获取注解处理器支持的选项，如在命令行指定的选项
     *
     * @return
     */
    @Override
    public Set<String> getSupportedOptions() {
        return null;
    }
    /**
     * 获取注解处理器支持的注解类型
     *
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return null;
    }
    /**
     * 获取注解处理器支持的源代码版本
     *
     * @return
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return null;
    }
    /**
     * 注解处理器的初始化方法
     *
     * @param processingEnv
     */
    @Override
    public void init(ProcessingEnvironment processingEnv) {
    }
    /**
     * 处理注解，如果返回true，后面的注解处理器不会继续处理该注解处理器支持的注解
     *
     * @param annotations
     * @param roundEnv
     * @return
     */
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
    /**
     * 这个确实没看懂
     *
     * @param element
     * @param annotation
     * @param member
     * @param userText
     * @return
     */
    @Override
    public Iterable<? extends Completion> getCompletions(Element element, AnnotationMirror annotation,
        ExecutableElement member, String userText) {
        return null;
    }
}

public class CustomProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

public interface ProcessingEnvironment {
    /**
     * 从工具启动的选项中获取注解处理器支持的选项
     */
    Map<String,String> getOptions();
    /**
     * 返回用来报告错误，警告或其他信息的工具类。
     * 注意：如果Messager 打印了错误类型的消息，将引发错误。
     */
    Messager getMessager();
    /**
     * 获取创建源文件、class文件的工具类。
     */
    Filer getFiler();
    /**
     * 返回获取元素信息的工具类。
     * 元素是对 Java 程序各部分的抽象，如包、类、变量、方法等。
     */
    Elements getElementUtils();
    /**
     * 返回可以获取类型信息的工具类。
     * 类型是指 Java 中的类型，不完全等同于元素，部分元素和类型可以进行转换。
     */
    Types getTypeUtils();
    /**
     * 获取生成的源文件和class应该支持的版本。
     */
    SourceVersion getSourceVersion();
    /**
     * 获取当前区域信息
     */
    Locale getLocale();
}

public interface RoundEnvironment {
    /**
     * 当前是否为最后一轮处理
     */
    boolean processingOver();
    /**
     * 上一轮处理是否引发错误
     */
    boolean errorRaised();
    /**
     * 获取上一轮注解处理生成的根元素
     */
    Set<? extends Element> getRootElements();
    /**
     * 根据注解获取元素
     */
    Set<? extends Element> getElementsAnnotatedWith(TypeElement a);
    /**
     * 根据注解获取元素
     */
    Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a);
}