Java注解处理器 - 五分钟快速入门

基本概念

Java 注解（Annotation）分为两类：编译时（Compile time）处理的注解和在运行时（Runtime）通过反射机制运行处理的注解。本文将重点介绍在编译时（Compile time）处理的注解，关于在运行时（Runtime）通过反射机制运行处理的注解，比较简单这里不做介绍大家可以自行找资料学习。

注解处理器（Annotation Processor）是javac的一个工具，它用来在编译时扫描和处理注解(Annotation). 你可以自定义注解, 在编译期生成新的Java文件。

在Java 5首次引入注解的时候, 注解处理器的API还没有成熟, 也没有标准化. 处理注解需要一个名为apt（也就是Annotation Processor Tool, 注解处理器工具）的独立的工具, 以及包含在com.sum.mirror包中的Mirror API. apt需要使用Mirror API来自定义处理器.

从Java 6开始，注解处理器通过JSR 269已经标准化并被纳入到标准库中，APT工具也被无缝集成到Java编译工具javac里面。Java 6提供了一个已经实现通用功能的抽象类javax.annotation.processing.AbstractProcessor，同时还提供了javax.lang.model包。

注解处理器API

如果我们要自己开发一个注解处理器，需要继承于AbstractProcessor，如下所示：

package com.bytebeats.apt;

public class ExampleProcessor extends AbstractProcessor {
   

    @Override
    public synchronized void init(ProcessingEnvironment env){ }

    @Override
    public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> annotataions = new LinkedHashSet<String>(2);
        annotataions.add(Factory.class.getCanonicalName());
        return annotataions;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

}

其中，

• init(ProcessingEnvironment env)：每一个注解处理器类都必须有一个空的构造函数。init()方法会被注解处理工具调用，并输入ProcessingEnviroment参数。ProcessingEnviroment提供很多有用的工具类Elements, Types和Filer。
• process(Set<? extends TypeElement> annotations, RoundEnvironment
  env)：这是最重要的一个方法，你在这里写你的扫描、评估和处理注解的代码，以及生成Java文件。输入参数RoundEnviroment，可以让你查询出包含特定注解的被注解元素。
• getSupporte