Java注解解析-搭建⾃⼰的注解处理器（CLASS注解使⽤篇）写在前⾯
该⽂章是继之后，使⽤注解处理器处理CLASS注解的⽂章。通过完整的Demo例⼦介绍整个注解处理器的搭建流程以及注意事项，你将知道如何去搭建⾃⼰的注解处理器。前提是你知道如何去写⾃定义注解，不清楚的可以点击我上⾯的链接哦～
介绍
顾名思义注解处理器就是javac包中专门⽤来处理注解的⼯具。所有的注解处理器都必须继承抽象类AbstractProcessor然后重写它的⼏个⽅法。注解处理器是运⾏在它⾃⼰的JVM中。javac启动⼀个完整Java虚拟机来运⾏注解处理器，这意味着你可以使⽤任何你在其他java应⽤中使⽤的的东西。其中抽象⽅法process是必须要重写的，再该⽅法中注解处理器可以遍历所有的源⽂件，然后通过RoundEnvironment类获取我们需要处理的注解所标注的所有的元素，这⾥的元素可以代表包，类，接⼝，⽅法，属性等，具体的解释放在下⼀章节，因为这⾥⾯牵扯到的东西实在是太多了。再处理的过程中可以利⽤特定的⼯具类⾃动⽣成特定的.java⽂件或者.class⽂件，来帮助我们处理⾃定义注解。
下⾯开始搭建
1.创建
⾸先注解处理器需要javax包的⽀持，我们的Android环境下是访问不到javax包的，除⾮我们⾃⼰配置。
//adle中加⼊依赖,⼀定要使⽤provided files来引⼊.
provided files('/Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/jre/lib/rt.jar')
所以我们需要创建Java Library包来提供javax环境，另外注解处理器要被打包进jar包⾥⾯才能被系统识别，这就是选⽤java 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 = Messager();
elementUtils = ElementUtils();
filer = Filer();
}
/**
* 该⽅法将⼀轮⼀轮的遍历源代码
* @param t 该⽅法需要处理的注解类型
* @param roundEnvironment 关于⼀轮遍历中提供给我们调⽤的信息.
* @return 改轮注解是否处理完成 true 下轮或者其他的注解处理器将不会接收到次类型的注解.⽤处不⼤.
珍珠龟
*/
@Override
public boolean process(Set<?extends TypeElement> t, RoundEnvironment roundEnvironment){
return fal;
}
/**
* 返回我们Java的版本.
* @return
*/
@Override
public SourceVersion getSupportedSourceVersion(){
return SourceVersion.latest();
}
/**
* 返回我们将要处理的注解
* @return
*/
@Override
public Set<String>getSupportedAnnotationTypes(){
Set<String> annotataions =new LinkedHashSet<>();
annotataions.add(CanonicalName());
return annotataions;
}
}
2.注册
注册注解处理器的⽅法有两种:
第⼀种： 处理器必须被打包进⼀个jar包⾥⾯，这也是为什么要建⽴⼀个Java Module。该jar包需要有⼀个特定路径resources/META-
INF/rvices的⽂件javax.annotation.processing.Processor，该⽂件的路径和名称都是特定的，然后将我们声明注解处理器的全路径写到该⽂件中，这样Java虚拟机会⾃动找该路径下中我们声明的处理器。
我们再创建⽂件夹的时候⼀定要确定其命名的准确性。创建⽂件的时候直接右键->new file，保证我们的⽂件的名字
为javax.annotation.processing.Processor。
创建成功之后我们将⾃定义的注解处理器的全路径写到该⽂件⾥⾯。
这样问题来了，如我我们写了多个注解处理器该怎么声明呢？接着看。如果我们⼀个Module⾥⾯声明了多个注解处理器，再该⽂件中声明的时候每个注解处理器要换⾏声明，运⾏的顺序就按声明的顺序去执⾏。这⾥需要对注解处理器的运⾏顺序解释⼀下，再编译期间并不是⼀个注解处理器完全的处理结束再开始下⼀个的，⽽是在扫描⼀轮源代码 的时候注册的第⼀个处理器先执⾏⼀轮，然后注册的第
⼆个处理器开始执⾏然后。。。三个。。四个。第⼆轮的时候还是注册的第⼀个处理器先执⾏，然后第⼆个。。。三个。。。这⾥⾯的深刻解释会在下⼀篇讲解，这篇只是使⽤。
**第⼆种：**当觉得第⼀种⽅法配置繁琐的时候就会有新的更简洁的⽅式出现。⾕歌公司推出的使⽤注解去注册注解处理器。
1. 添加依赖，可以去GitHub上⾯查找最新版本。
implementation 'le.auto.rvice:auto-rvice:1.0-rc4'
2. 我们就可以使⽤了，它的作⽤和我们⼿写的作⽤是⼀样的。不过注释的处理器的处理顺序跟你类创建的顺序是⼀致的，跟⽅法⼀中⽂
件声明的顺序不⼀样。
@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 proce ssor. Plea add them to the annotationProcessor configuration.
- annotation_processor.jar (project :annotation_processor)
Alternatively, t android.defaultConfig.javaCompileOptions.annotationProcessorOptions.includeCompileClasspath =true to continue with previous b ehavior. Note that this option is deprecated and will be removed in the future.
See /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的话，基本跟an
droid 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 = Messager();
}
@Override
public boolean process(Set<?extends TypeElement> t, RoundEnvironment roundEnvironment){
虾仁西兰花//代码2
messager.printMessage(Diagnostic.Kind.NOTE,"⽇志开始---------------");
return fal;
}
//代码1
@Override
public Set<String>getSupportedAnnotationTypes(){
Set<String> supportedOptions =new HashSet<>();
supportedOptions.add(CanonicalName());
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上⾯使⽤注解：
