Java之注解

一 注解的定义

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明 。如果要对于元数据的作用进行分类，还没有明确的定义，不过我们可以根据它所起的作用，注解不会改变编译器的编译方式，也不会改变虚拟机指令执行的顺序，它更可以理解为是一种特殊的注释，本身不会起到任何作用，需要工具方法或者编译器本身读取注解的内容继而控制进行某种操作。大致可分为三类：

• 编写文档：通过代码里标识的元数据生成文档。
• 代码分析：通过代码里标识的元数据对代码进行分析。
• 编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。

二 用途

注解可以在代码编译期间帮我们完成一些复杂的准备工作。
比如Greendao，我们注解一个实体类，它要处理成好多逻辑关系类，这些逻辑类让我们自己去书写的话那将是一个庞大的代码量， extends AbstractDao等这些类。
比如BufferKnife，我们用注解将控件的属性传递给它，它将生成一些功能类去处理这些值，***_ViewBinding等这些类型的类。运行时注解的使用,比如Retrofit的@GET或者@POST等等都是运行时注解，它的注解的处理必须跟Retrofit的对象有关联，所以必须定义成运行时的。所以注解已经成为一种趋势，比如BufferKnife，EventBus，Darrger，Greendao，Arouter，Retrofit。。。看来我们也要去完成我们的一个注解了。

三 知识准备

Java JDK中包含了三个注解分别为@Override（校验格式），@Deprecated：（标记过时的方法或者类），@SuppressWarnnings（注解主要用于抑制编译器警告）等等java1.8之后有新增了一些注解像@FunctionalInterface()这样的,对于每个注解的具体使用细节这里不再论述。我们可以通过点击这里来看一下专业解释! 来看一下@Override的源码。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)

}
通过源代码的阅读我们可以看出声明注解的方式为@interface，每个注解都需要不少于一个的元注解的修饰，这里的元注解其实就是修饰注解的注解，可以理解成最小的注解单位吧。。。下面详细的看下每个注释注解的意义吧：

@Target： 
说明了Annotation所修饰的对象范围,也就是我们这个注解是用在那个对象上面的：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。以下属性是多选状态，我们可以定义多个注解作用域，比如：

@Target({ElementType.METHOD,ElementType.FIELD})，单个的使用         @Target(ElementType.FIELD)。    
（1）.CONSTRUCTOR：构造方法声明。
（2）.FIELD：用于描述域也就是类属性之类的，字段声明（包括枚举常量）。
（3）.LOCAL_VARIABLE：用于描述局部变量。
（4）.METHOD：用于描述方法。
（5）.PACKAGE：包声明。
（6）.PARAMETER：参数声明。
（7）.TYPE：类、接口（包括注释类型）或枚举声明 。
 (8)  .ANNOTATION_TYPE：注释类型声明，只能用于注释注解。
官方解释：指示注释类型所适用的程序元素的种类。如果注释类型声明中不存在 Target 元注释，则声明的类型可以用在任一程序元素上。如果存在这样的元注释，则编译器强制实施指定的使用限制。 例如，此元注释指示该声明类型是其自身，即元注释类型。它只能用在注释类型声明上:

    @Target(ElementType.ANNOTATION_TYPE)
    public @interface MetaAnnotationType {

    }

此元注释指示该声明类型只可作为复杂注释类型声明中的成员类型使用。它不能直接用于注释：

   @Target({}) 
   public @interface MemberType {
              ...
  }
这是一个编译时错误，它表明一个 ElementType 常量在 Target 注释中出现了不只一次。例如，以下元注释是非法的：

 @Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})
  public @interface Bogus {
              ...
  }

@Retention： 
定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。来源于java.lang.annotation.RetentionPolicy的枚举类型值： 
（1）.SOURCE:在源文件中有效（即源文件保留）编译成class文件将舍弃该注解。 
（2）.CLASS:在class文件中有效（即class保留） 编译成dex文件将舍弃该注解。 
（3）.RUNTIME:在运行时有效（即运行时保留） 运行时可见。 
也就是说注解处理器能处理这三类的注解,我们通过反射的话只能处理RUNTIME类型的注解.

官方解释：指示注释类型的注释要保留多久。如果注释类型声明中不存在 Retention 注释，则保留策略默认为 RetentionPolicy.CLASS。只有元注释类型直接用于注释时，Target 元注释才有效。如果元注释类型用作另一种注释类型的成员，则无效。

@Documented： 
指示某一类型的注释将通过 javadoc 和类似的默认工具进行文档化。应使用此类型来注释这些类型的声明：其注释会影响由其客户端注释的元素的使用。如果类型声明是用 Documented 来注释的，则其注释将成为注释元素的公共 API 的一部。Documented是一个标记注解，没有成员。

@Inherited： 
元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。 注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

官方解释：指示注释类型被自动继承。如果在注释类型声明中存在 Inherited 元注释，并且用户在某一类声明中查询该注释类型，同时该类声明中没有此类型的注释，则将在该类的超类中自动查询该注释类型。此过程会重复进行，直到找到此类型的注释或到达了该类层次结构的顶层 (Object) 为止。如果没有超类具有该类型的注释，则查询将指示当前类没有这样的注释。 
注意，如果使用注释类型注释类以外的任何事物，此元注释类型都是无效的。还要注意，此元注释仅促成从超类继承注释；对已实现接口的注释无效。

@Repeatable： 
Repeatable可重复性，Java 1.8新特性，其实就是把标注的注解放到该元注解所属的注解容器里面。可重复性的意思还是用demo来解释一下吧：

 //定义了一个 注解里面属性的返回值是其他注解的数组
      @Target(ElementType.FIELD)
      @Retention(RetentionPolicy.RUNTIME)
      public @interface MyCar {
          MyTag[] value();        ----MyTag  这里就是MyTag注解的容器。
      }
      //另外一个注解 就是上一个注解返回的注解
      @Target({ElementType.METHOD,ElementType.FIELD})
      @Retention(RetentionPolicy.CLASS)
      @Repeatable(MyCar.class)    --------这里添加这个属性之后 我们的这个注解就可以重复的添加到我们定义的容器中了，注意里面的值时  我们定义的容器注解的class对象.
      public @interface MyTag {       ........MyTag

          String name () default "" ;

          int size () default 0 ;
      }
      //使用
          @MyTag(name = "BWM", size = 100)
          @MyTag()
          public Car car;
           //如果我们的注解没有@Repeatable的话,这样写的话是报错的,加上之后就是这样的了  

这个注解是很特殊的，我们的注解中有@Repeatable(MyCar.class)这样的元注解的话，就是说当前标注的注解（MyTag注解）放到我们的值（MyCar.class）这个注解容器里面。那么我们再处理注解的时候获取到的是我们最后的注解容器（MyCar注解）,这样说有点生硬下面看demo：

 使用:
      public class HomeActivity extends AppCompatActivity {
          @MyTag(name = "BWM", size = 100)
          @MyTag(name = "大众"  ,size = 200)  ......这里用了它的重复性.
          Car car;
          @Override
          protected void onCreate(Bundle savedInstanceState) {
              super.onCreate(savedInstanceState);
              setContentView(R.layout.activity_home);
              AnnotationProccessor.instance().inject(this);   //这里去处理注解
            //  Log.e("WANG", "HomeActivity.onCreate." + car.toString());
          }
      }
      处理过程:
      Class<?> aClass = o.getClass();
              Field[] declaredFields = aClass.getDeclaredFields();
              for (Field field:declaredFields) {
                  if(field.getName().equals("car")){
                      Annotation[] annotations = field.getAnnotations();
                      for (int i = 0; i <annotations.length; i++) {
                          Annotation annotation = annotations[i];
                          //我们获取的该字段上面的注解只有一个  那就是 MyCar注解,看结果1的打印.
                          //但是我们明明标注的是 MyTag. 为什么获取的是注解容器呢.
                          //这就是@Repeatable的强大之处.

                          Class<? extends Annotation> aClass1 = annotation.annotationType();
                          Log.e("WANG","AnnotationProccessor.MyCar"+aClass1 );
                      }
                      MyCar annotation = field.getAnnotation(MyCar.class);
                      MyTag[] value = annotation.value();
                      for (int i = 0; i <value.length; i++) {
                          MyTag myTag = value[i];
                          Log.e("WANG","AnnotationProccessor.MyTag   name  value   is  "+myTag.name() );
                      }
                  }      

      结果是:
      AnnotationProccessor.MyCarinterface cn.example.wang.routerdemo.annotation.MyCar.1
      AnnotationProccessor.MyTag   name  value   is  BWM.2
      AnnotationProccessor.MyTag   name  value   is  大众.3

三 自定义运行时注解

通过以上的学习我们知道@interface是声明注解的关键字,每个注解需要注明生命周期以及作用范围.你可以给注解定义值.也就是再注解内部定义我们需要的方法.这样注解就可以再自己的生命周期内为我们做事.这里我们就自定义一个为一个对象属性初始化的注解吧，类似于Dagger的功能。

public @interface MyTag {

}
注解里面的定义也是有规定的：

注解方法不能带有参数。
注解方法返回值类型限定为：基本类型、String、Enums、Annotation或者这些类型的数组。
注解方法可以有默认值。
注解本身能够包含元注解，元注解被用来注解其他注解。
我们就来试一下吧！

public @interface MyTag {
  //声明返回值类型，这里可没有大括号啊，可以设置默认返回值，然后就直接";"了啊。
    String name () default "" ;
    int size () default 0 ；
}
定义好了注解我们就来规定我们自定义的注解要在哪里用？要何时用？因为我们这里使用了反射来处理注解，反射就是在代码的运行的时候通过class对象反相的去获取类内部的东西，不熟悉反射机制的请移步这里Android开发者必须了解的反射基础，所以我们定义该注解的生命周期在运行时，并且该注解的的目的是为自定义属性赋值，那么我们的作用域就是FIELD。这里面定义了我们要初始化的bean的基本属性，给了默认值。这样我们就可以用该注解去创建我们需要的bean对象。

@Target(ElementType.FIELD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
    String name () default "" ;
    int size () default 0 ;
}
好了接下来看怎么使用我们的这个自定义的注解！

public class HomeActivity extends AppCompatActivity {
    @MyTag(name = "BMW",size = 100)
    Car car;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_home);
        //这里我们要首先注册一下这个类
        AnnotationCar.instance().inject(this);
      //当程序运行的时候这里将会输出该类Car的属性值。
        Log.e("WANG","Car is "+car.toString());
    }
}
注解如果没有注解处理器，那么该注解将毫无意义。这里呢我们在这个Activity里面定义了一个Car类的属性，然后再car这个变量上面定义我们的注解，并且给我们的注解赋值。然后我们再onCreate方法里面初始化我们的注解处理器。然后运行代码，log日志将打印Car类的信息，先来看下结果吧

cn.example.wang.routerdemo E/WANG: Car is Car [name=BMW, size=100]
这样我们的自定义注解就有作用了，下面是”注解处理器“的代码，这里都是我们自己编写的处理注解的代码，其实系统是自带注解处理器的，不过它一般用来处理源码注释和编译时注释。

//自定义的类
public class AnnotationCar {
    private static AnnotationCar annotationCar;
    public static AnnotationCar instance(){
        synchronized (AnnotationCar.class){
            if(annotationCar == null){
                annotationCar = new AnnotationCar();
            }
            return annotationCar;
        }
    }

    public void inject(Object o){
        Class<?> aClass = o.getClass();
        Field[] declaredFields = aClass.getDeclaredFields();
        for (Field field:declaredFields) {
            if(field.getName().equals("car") && field.isAnnotationPresent(MyTag.class)) {
                MyTag annotation = field.getAnnotation(MyTag.class);
                Class<?> type = field.getType();
                if(Car.class.equals(type)) {
                    try {
                        field.setAccessible(true);
                        field.set(o, new Car(annotation.name(), annotation.size()));
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }
}
这就说明了为什么注解和反射是同时进入我们的知识圈里面的吧！这里呢我们先获取到类里面所有的属性，然后去找到被我们的注解MyTag修饰的那个属性，然后找到之后，先取我们注解里面的值，然后赋值给我们类里面的属性！这样我们就用注解去初始化了一个属性值。就是这么简单！

四 总结

运行时注解是我们比较好理解的，知道反射和注解基础之后就可以写出来个小demo了。但是运行时注解是是我们最不常用的注解，因为反射再运行时的操作是十分的耗时的，我们不会因为一些代码的简洁而影响app的性能。所以呢运行时注解只是大家认识注解的一个入口，接下来我将陆续的介绍注解的通用写法，CLASS注解和SOURCE注解，让我们来完成属于自己的BufferKnife！

 

顾名思义注解处理器就是javac包中专门用来处理注解的工具。所有的注解处理器都必须继承抽象类AbstractProcessor然后重写它的几个方法。注解处理器是运行在它自己的JVM中。javac启动一个完整Java虚拟机来运行注解处理器，这意味着你可以使用任何你在其他java应用中使用的的东西。其中抽象方法process是必须要重写的，再该方法中注解处理器可以遍历所有的源文件，然后通过RoundEnvironment类获取我们需要处理的注解所标注的所有的元素，这里的元素可以代表包，类，接口，方法，属性等，具体的解释放在下一章节，因为这里面牵扯到的东西实在是太多了。再处理的过程中可以利用特定的工具类自动生成特定的.java文件或者.class文件，来帮助我们处理自定义注解。

下面开始搭建
1.创建

首先注解处理器需要javax包的支持，我们的Android环境下是访问不到javax包的，除非我们自己配置。

//app:build.gradle中加入依赖,一定要使用provided files来引入.
provided files('/Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/jre/lib/rt.jar')
所以我们需要创建Java Library包来提供javax环境，另外注解处理器要被打包进jar包里面才能被系统识别，这就是选用ava Library的原因，目前注解注解框架均是如此。

创建好Module之后就可以写我们的自定义的注解处理器了。首先需要继承抽象类AbstractProcessor，然后重写process（）方法。该方法是核心方法，该方法将遍历源代码，找出我们想要注解标注的元素。单单重写这一个方法是不够的， 在我们的开发中往往需要重写init（），getSupportedSourceVersion（），getSupportedAnnotationTypes（）这几个方法就可以了。另外再Java7及其以后我们还可以使用注解@SupportedSourceVersion()和@SupportedAnnotationTypes() 去替代上面的方法，见于该注解有Java版本的限制，所以还是建议直接重写方法为好。

public class AnnotationTwoProcessor extends AbstractProcessor {

    private Messager messager; //用于打印日志
    private Elements elementUtils; //用于处理元素
    private Filer filer;  //用来创建java文件或者class文件

    //该方法再编译期间会被注入一个ProcessingEnvironment对象，该对象包含了很多有用的工具类。
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        messager = processingEnvironment.getMessager();
        elementUtils = processingEnvironment.getElementUtils();
        filer = processingEnvironment.getFiler();
    }

    /**
     * 该方法将一轮一轮的遍历源代码
     * @param set  该方法需要处理的注解类型
     * @param roundEnvironment 关于一轮遍历中提供给我们调用的信息.
     * @return  改轮注解是否处理完成 true 下轮或者其他的注解处理器将不会接收到次类型的注解.用处不大.
     */
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {

        return false;
    }

    /**
     * 返回我们Java的版本.
     * @return
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latest();
    }

    /**
     * 返回我们将要处理的注解
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> annotataions = new LinkedHashSet<>();
        annotataions.add(MyAnnotion.class.getCanonicalName());
        return annotataions;
    }
}

2.注册

注册注解处理器的方法有两种:

第一种： 处理器必须被打包进一个jar包里面，这也是为什么要建立一个Java Module。该jar包需要有一个特定路径resources/META-INF/services的文件javax.annotation.processing.Processor，该文件的路径和名称都是特定的，然后将我们声明注解处理器的全路径写到该文件中，这样Java虚拟机会自动找该路径下中我们声明的处理器。

我们再创建文件夹的时候一定要确定其命名的准确性。创建文件的时候直接右键->new file，保证我们的文件的名字为javax.annotation.processing.Processor。 

创建成功之后我们将自定义的注解处理器的全路径写到该文件里面。

这样问题来了，如我我们写了多个注解处理器该怎么声明呢？接着看。如果我们一个Module里面声明了多个注解处理器，再该文件中声明的时候每个注解处理器要换行声明，运行的顺序就按声明的顺序去执行。这里需要对注解处理器的运行顺序解释一下，再编译期间并不是一个注解处理器完全的处理结束再开始下一个的，而是在扫描一轮源代码 的时候注册的第一个处理器先执行一轮，然后注册的第二个处理器开始执行然后。。。三个。。四个。第二轮的时候还是注册的第一个处理器先执行，然后第二个。。。三个。。。这里面的深刻解释会在下一篇讲解，这篇只是使用。

cn.example.wang.processor.AnnotationProcessor
cn.example.wang.processorAnnotationTwoProcessor

第二种：当觉得第一种方法配置繁琐的时候就会有新的更简洁的方式出现。谷歌公司推出的使用注解去注册注解处理器。

添加依赖，可以去GitHub上面查找最新版本。

implementation 'com.google.auto.service:auto-service:1.0-rc4'
1
我们就可以使用了，它的作用和我们手写的作用是一样的。不过注释的处理器的处理顺序跟你类创建的顺序是一致的，跟方法一中文件声明的顺序不一样。

@AutoService(Processor.class)
public class AnnotationTwoProcessor extends AbstractProcessor {
}

总的来说方式1的注册方式目前仅在EventBus里面有用到，方式2还是推荐使用的，比如：Arouter，BufferKnife等流行框架都是采用的这种方式注册的，方便快捷。

3.APP引用注解处理器

再引用注解处理器的Module的时候坑其实挺多的。首先我们得确保处理器所在的jar包会添加到我们运行的项目中，注解处理器才会被得到执行，这里呢因为源码不清楚，所以只好自己去试了。Application引入注解处理器包的时候并不像我们引入其它的Android Module一样，这里列举三种种引入方法。

plugin: 'com.android.application'

我们可以使用implementation，compile，api直接引用注解处理器的module，但是会有一个编译错误：

Error:Execution failed for task ':app:javaPreCompileDebug'.
> Annotation processors must be explicitly declared now.  The following dependencies on the compile classpath are found to contain annotation processor.  Please add them to the annotationProcessor configuration.
  - annotation_processor.jar (project :annotation_processor)
Alternatively, set android.defaultConfig.javaCompileOptions.annotationProcessorOptions.includeCompileClasspath = true to continue with previous behavior.  Note that this option is deprecated and will be removed in the future.
See https://developer.android.com/r/tools/annotation-processor-error-message.html for more details.

我们需要加一段代码，代码位置如下所示，这样就可以愉快的引入注解处理器了：

android {
  defaultConfig {
      javaCompileOptions {
          annotationProcessorOptions {
              includeCompileClasspath = true
          }
      }
  }
}
另外我们可以用annotationProcessor引入注解处理器，这个引入方式是为了替换Gradle版本2.2之前的apt引入方法。该引入方式专门用来处理注解处理器。使用该引入方式的时候不会出现错误提示，也是Android中推荐使用的引入方法，该方式也是主流方式。

annotationProcessor project(':annotation_processor')
apply plugin: 'com.android.library'

前提module一定要被android application引入。module里面引入注解处理器的module的话，基本跟android application中一致，这里说一下两个不同点annotationProcessor和implementation方式的引入都不会执行注解处理器，真实的原理并不清楚，只能猜测是application才能正真的处理注解，所以得把依赖暴露出去。这点再android library的module中一定得注意。不太建议该方式引入。

apply plugin: 'java-library'

前提java library一定要被android application引入。声明这样的module 的话我们就可以直接引入注解处理器了，也不用担心用什么方式引入。不过这种场景不太多。

如何确保你的注解处理器已经注册成功了。首先你已经自定义好了一个注解，并且该注解已经用到了你的代码里面。如下代码所示，你已经设置了我们要处理的是那种类型的注解（代码1所示），然后再我们的process方法里面打上日志（代码2所示），然后点击Android Studio的Make Project按钮，之后打开Gradle Console窗口看build信息，当你发现信息中打印了代码2所示的信息之后就表明你的注解处理器已经运行起来了。如果没有打印信息的话尝试 clean一下项目然后重新Make Project。如果发现没有打印日志的话，尝试查看注解处理器是否已经注册和注解处理器所在的module是否被android application成功引入。

@AutoService(Processor.class)
public class AnnotationProcessor extends AbstractProcessor {

    private Messager messager;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        messager = processingEnvironment.getMessager();
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        //代码2
        messager.printMessage(Diagnostic.Kind.NOTE,"日志开始---------------");
        return false;
    }

    //代码1
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> supportedOptions = new HashSet<>();
        supportedOptions.add(MyAnnotion.class.getCanonicalName());
        return supportedOptions;
    }

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

4.自动生成Java文件

走到该步骤的时候，你要确保你的注解处理器已经正常的运行。我们使用注解处理器处理源码注解的目的，就是再编译期间完成我们对某个注解的处理工作。比如：BufferKnife再编译期间会在使用特定注解的文件路径生成*—ViewBinding的源文件去处理特定注解。这里用一个Demo去演示如何生成代码：

先看我的注解：

@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD,ElementType.LOCAL_VARIABLE})
public @interface MyAnnotion {
    String value() default "ssssss";

}

在我的MainActivity上面使用注解：

@MyAnnotion()
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

接着使用注解处理器去处理注解，生成对应的MainActivity_ViewBinding源文件。

public class AnnotationProcessor extends AbstractProcessor {

    private Messager messager;
    private Elements elementUtils;
    private Filer filer;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        messager = processingEnvironment.getMessager();
        elementUtils = processingEnvironment.getElementUtils();
        filer = processingEnvironment.getFiler();

    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        messager.printMessage(Diagnostic.Kind.NOTE,"日志开始---------------");

        Set<? extends Element> elementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(MyAnnotion.class);
        for (Element element:elementsAnnotatedWith) {
            if(element.getKind() == ElementKind.CLASS){
                TypeElement typeElement = (TypeElement) element;
                PackageElement packageElement = elementUtils.getPackageOf(element);
                String packagePath = packageElement.getQualifiedName().toString();
                String className = typeElement.getSimpleName().toString();
                try {
                    JavaFileObject sourceFile = filer.createSourceFile(packagePath + "." + className + "_ViewBinding", typeElement);
                    Writer writer = sourceFile.openWriter();
                    writer.write("package  "+packagePath +";\n");
                    writer.write("import  "+packagePath+"."+className+";\n");
                    writer.write("public class "+className+"_ViewBinding"+"  { \n");
                    writer.write("\n");
                    writer.append("       public "+className +"  targe;\n");
                    writer.write("\n");
                    writer.append("}");
                    writer.flush();
                    writer.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }

            }
        }

        messager.printMessage(Diagnostic.Kind.NOTE,"日志结束---------------");
        return false;
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> supportedOptions = new HashSet<>();
        supportedOptions.add(MyAnnotion.class.getCanonicalName());
        return supportedOptions;
    }

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

结果展示：

注意一下生成的位置！我们可以直接再我们正常的代码中应用到该文件，因为该文件是会生成class文件的。

5.总结

该文章只是介绍了如何搭建起一个Java注解处理器，没有更深入的去讲解AbstractProcessor类以及我们再处理注解的过程中用到的各种类的API。当然接下来的文章就会详细的介绍注解处理器所使用到的类，方法，属性等的用法和意义，这一定是史上最全的注解处理器API。之后你会更加随心所欲的去构建自己的注解框架。

 

--------------------- 
作者：那个人_ 
来源：CSDN 
原文：https://blog.csdn.net/jsonchumpklutz/article/details/81747839 
版权声明：本文为博主原创文章，转载请附上博文链接！