Android编译期代码生成之apt实践入门

如今 Android 主流库中使用 apt 的愈来愈多，如Dagger2，ButterKnife，DBflow等。不研究一下其怎么玩的，内心实在是不舒服斯基，因此就有了这篇apt代码简单生成的文章。文章的末尾，会附上一些关于注解的基础知识，有兴趣的童鞋能够再去看看。

Annotation库-定义注解

首先，咱们得须要新建一个名称为annotation的Java Library。这里简单的建一个@interfact的注解类便可。以下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Test {
    String value();
}

能够看到的是，这是编译时期的注解，主要做用于Class。以后，在调用的地方就是须要使用咱们的这个注解。

Compiler库-注解处理器

1.使用库引入

这里，也使用的是Java Library，咱们把报名定为 compiler，先定义gradle文件：

apply plugin: 'java'

sourceCompatibility = 1.7
targetCompatibility = 1.7

dependencies {
    compile 'com.google.auto.service:auto-service:1.0-rc2'
    compile 'com.squareup:javapoet:1.7.0'
    compile project(':annotation')
}

代码中，引入两个库，AutoService主要的做用是注解processor类，并对其生成 META-INF 的配置信息。

JavaPoet这个库的主要做用就是帮助咱们经过类调用的形式来生成代码。

2. 定义Processor类

创建一个名称为TestProcessor的类，以下：

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

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Collections.singleton(Test.class.getCanonicalName());
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

其中要注意的是使用AutoSerivce的注解，这样就不用再手动配置 META-INF文件了。方法getSupportedAnnotationTypes则是定义咱们针对生成的注解类，方法process则是咱们的重头戏，其中则是咱们生成代码的主要逻辑之处：

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
  Set<? extends Element> set = roundEnv.getElementsAnnotatedWith(Test.class);
  for (Element element : set) {
    if (element.getKind() != ElementKind.CLASS) {
      processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "only support class");
    }
    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, JavaPoet!")
      .build();

    TypeSpec helloWorld =
      TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC, Modifier.FINAL).addMethod(main).build();
    JavaFile javaFile = JavaFile.builder("com.lighters.apt", helloWorld).build();

    try {
      javaFile.writeTo(processingEnv.getFiler());
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
  return false;
}

这里简单使用JavaPoet文档中的第一个example, 生成一个简单的HelloWorld类。你们可本身行去查看JavaPoet的更多用法，支持各类姿式生成Java的代码，并与Processor完美契合。

代码调用

准备工做都完成以后，接下来就在咱们的主目录app下面，经过添加注解，来查看咱们的代码生成逻辑。

1.添加依赖

在根目录的build.gradle文件中的dependencies节点下面添加以下代码：

classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

app的build.gradle中添加以下代码：

apply plugin: 'com.neenbedankt.android-apt'
dependencies {
    compile project(':annotation')
    apt project(':compiler')
}

2.添加注解

这里，就偷一个小懒，在MainActivity上，添加注解Test，格式以下：

@Test("haha")
public class MainActivity extends AppCompatActivity {
}

3.代码生成

注意，这里定义的注解为编译期的注解，因此代码的生成，只须要经过执行Rebuild便可。执行完成以后，在app的build/generated/source/apt目录下，便可看到我们的代码，如图:

总结

apt代码的生成是定义编译期的注解，再经过继承Proccesor实现代码生成逻辑，实现了编译期生成代码的逻辑。相对于在运行期经过反射来讲，提升了程序的运行速度。这里只是简单引导你们搭建本身的apt处理器，更多的内容期待你们各自玩出花来。

学习资料

附上一篇标准的编译期代码生成，以及trinea关于annotation的详细介绍。

• Annotation实战【自定义AbstractProcessor】

• Java Annotation 及几个经常使用开源项目注解原理简析

另外，使用apt的代码库Dagger2, Butterknife你们可自行深刻研究了。

转载请注明原文连接: http://alighters.com/blog/2016/05/10/apt-code-generate/