Android开发之APT技术

Android_Banner.jpg

简介

• APT（Annotation Processing Tool）技术就是通过编译期解析注解，然后根据一定的规则去生产Java代码的一种技术。
  在生成代码的时候我们通常使用JavaPoet技术来生成代码。
• 在介绍APT技术之前，我们需要了解APT技术中关键的两个点 Element和SPI机制
• 下面就分别来介绍Element和SPI机制

Element

什么是Element

• Element存在于javax.lang.model.element包下，指的是一系列与之相关的接口集合（有很多子类，TypeElement、VariableElement）。
• Element可以代表一个元素，这个元素可以表示类、接口、方法、局部参数，成员变量，方法形参等元素（比如 TypeElement就是用来表示类、接口，VariableElement就是用来表示成员变量的）
• Element所代表的元素只能在编译期间可见，用于保存元素在编译期间的各种状态。

SPI机制

什么是SPI

• SPI 全称是 Service Provider Interface ，接口服务的提供者，就是为接口寻找服务的实现，在项目中通过配置文件为接口提供服务实现

配置文件的创建步骤

• 在main包下新建一个resources目录
• 接着在resources目录下创建META-INF的目录
• 在目录META-INF下创建services目录
• 然后在services目录下创建一个名字叫做javax.annotation.processing.Processor的文件
• 最终在创建的文件的内容就是为接口寻找服务实现的全类名
• 其实上述的几个步骤可以使用Google官方提供的 autor-service组件中的@AutoService注解来实现的

APT技术的使用

• 通常我们使用APT技术就是在编译期间为我们生成通用的代码，然后在运行期间去调用这些代码。

APT技术的使用步骤

• 创建注解模块，在注解模块中自定义注解（CLASS（编译期间），RUNTINE（运行期间））
• 创建注解处理器模块，在该模块中自定义注解处理器（通常都是 继承AbstractProcessor 重写process()放啊）
• 在上述步骤中其实在编译期间已经就能为我们生成好需要的代码，不过我们通常还需要一个API模块，用来调用编译期间生成的代码或者说是初始化。

实战

• 下面我们通过APT+JavaPoet+@AutoService 实现在编译期间生成一个打印HelloWorld的代码文件
• 自定义注解

//作用于类上
@Target(ElementType.TYPE)
//编译期间工作
@Retention(RetentionPolicy.CLASS)
public @interface Test {
}

• 自定义注解处理器

// 注册注解处理器，相当于SPI技术 为接口提供实现的服务
@AutoService(Processor.class)
//指定Java的版本
@SupportedSourceVersion(SourceVersion.RELEASE_7)
//指定当前注解处理器能处理的注解
@SupportedAnnotationTypes({"com.dashingqi.annotation.Test"})
public class HelloWorldCompiler extends AbstractProcessor {

    private Messager mMessager;
    private Filer mFiler;
    private Types mTypeUtils;
    ProcessingEnvironment mProcessingEnvironment;

    //初始化方法，能获取到一些工具里方法
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        mProcessingEnvironment = processingEnvironment;
       //日志信息打印
        mMessager = processingEnv.getMessager();
        ////返回实现Filer接口的对象，用于创建文件、类和辅助文件
        mFiler = processingEnv.getFiler();
        mTypeUtils = processingEnv.getTypeUtils();
    }

    //重头戏，我们生成代码的逻辑以及文件的创建都在process方法中
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        //获取到注解Test作用的元素，得到一个集合
        Set<? extends Element> elementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(Test.class);
      //遍历的到的元素集合
        for (Element element:elementsAnnotatedWith) {
        //下面就是我们构造Java代码文件

          //构造了一个方法
          /**
            * public static void main(String [] args){Systrem.out.println("Hello world")}
            *
            */
            MethodSpec main = MethodSpec.methodBuilder("main")
                    .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                    .returns(void.class)
                    .addParameter(String[].class, "args")
                    .addStatement("$T.out.println($S)", System.class, "Hello, World!")
                    .build();
            //构造了一个类文件 HelloWorld 并且将我们构造好的方法添加进去
           /**
            * public class HelloWorld {
            *       public static void main(String [] args){Systrem.out.println("Hello world")}
            * }
            *
            */
            TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
                    .addModifiers(Modifier.PUBLIC)
                    .addMethod(main)
                    .build();
            //创建当前构造好的类，并生成文件，存在到 com,dashingqi.master包下，
            JavaFile javaFile = JavaFile.builder("com.dashingqi.master", helloWorld)
                    .build();
            try {
                // 创建好的文件流写入到日志中
                javaFile.writeTo(System.out);
                //将文件流写成文件存在到磁盘中
                javaFile.writeTo(mProcessingEnvironment.getFiler());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        // 返回true代表当前的process方法已经处理注解，后面的注解处理器不需要处理了，返回false 置反
        return true;
    }
}

• 运行结果如下
  日志信息中

  
  WX20200715-004907.png
  

  编译期间生成的代码

  
  WX20200715-004928.png