进阶注解处理器 processor （一）

什么是 processor

processor 顾名思义，就是一个处理器，java中有对注解做处理的注解处理器，我们知道，如果一个注解定义了，而没被使用，其就相当于一个普通的注释，而注解又分不同的生命周期

1
2
3

RetentionPolicy.SOURCE
RetentionPolicy.CLASS
RetentionPolicy.RUNTIME

SOURCE 生命周期的注解在编译期就会被丢弃，CLASS 生命周期的注解在类加载的时候被丢弃，RUNTIME 生命周期的注解始终不丢弃。
用过spring boot系列的同学就都知道，其ioc就是通过运行期注解来实现的，本文中学习注解处理器使用的是编译期注解，在编译期来做一些事儿~

怎么使用 processor

1、新建一个要捕捉的编译期注解

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 MyAnn {
}

2、新建一个处理器，通过实现AbstractProcessor的process方法

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
import java.util.Set;

@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SupportedAnnotationTypes("com.jack.annotation.MyAnn")
public class MyProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, 
                           RoundEnvironment roundEnv) {
        // TODO
        return false;
    }
}

SupportedSourceVersion 中指定支持的jdk版本。
SupportedAnnotationTypes 中指定要捕捉的注解类。

3、配置pom文件，maven打包插件

4、配置处理器暴露文件
在 resources 目录下新建 META-INF/services 目录，在 META-INF/services 目录下新建 javax.annotation.processing.Processor 文件，在此文件中写入自定义处理器 processor 的全路径，换行分隔。

1	com.jack.processor.MyProcessor

5、编译打包

1	mvn clean install -DskipTest=true

6、在另一个工程中引入上面生成的 jar 包，使用其注解，然后编译代码即可。

tip：
如果不想通过打包 jar 来使用，也可以通过在一个工程中直接使用，但要求 processor 的编译一定要在使用此注解的编译之前，并且编译该类，要显示指定使用此注解处理器。

1
2
3

javac java/com/jack/annotation/MyAnn.java
javac java/com/jack/processor/MyProcessor.java
javac -processor com.jack.processor.MyProcessor com/jack/test/Test.java

结语

以上是与注解处理器的初次会面，后续逐步进阶~