摘要：執(zhí)行完成之后，在的目錄下，即可看到咱們的代碼，如圖總結(jié)代碼的生成是定義編譯期的注解，再通過(guò)繼承實(shí)現(xiàn)代碼生成邏輯，實(shí)現(xiàn)了編譯期生成代碼的邏輯。學(xué)習(xí)資料附上一篇標(biāo)準(zhǔn)的編譯期代碼生成，以及關(guān)于的詳細(xì)介紹。

現(xiàn)在 Android 主流庫(kù)中使用 apt 的越來(lái)越多，如Dagger2，ButterKnife，DBflow等。不研究一下其怎么玩的，心里實(shí)在是不舒服斯基，所以就有了這篇apt代碼簡(jiǎn)單生成的文章。文章的末尾，會(huì)附上一些關(guān)于注解的基礎(chǔ)知識(shí)，有興趣的童鞋可以再去看看。

首先，我們得需要新建一個(gè)名稱(chēng)為annotation的Java Library。這里簡(jiǎn)單的建一個(gè)@interfact的注解類(lèi)即可。如下：

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

可以看到的是，這是編譯時(shí)期的注解，主要作用于Class。之后，在調(diào)用的地方就是需要使用我們的這個(gè)注解。

這里，也使用的是Java Library，我們把報(bào)名定為 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")
}

代碼中，引入兩個(gè)庫(kù)，AutoService主要的作用是注解processor類(lèi)，并對(duì)其生成 META-INF 的配置信息。

JavaPoet這個(gè)庫(kù)的主要作用就是幫助我們通過(guò)類(lèi)調(diào)用的形式來(lái)生成代碼。

建立一個(gè)名稱(chēng)為TestProcessor的類(lèi)，如下：

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

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

    @Override
    public boolean process(Set annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

其中要注意的是使用AutoSerivce的注解，這樣就不用再手動(dòng)配置 META-INF文件了。方法getSupportedAnnotationTypes則是定義我們針對(duì)生成的注解類(lèi)，方法process則是我們的重頭戲，其中則是我們生成代碼的主要邏輯之處：

@Override
public boolean process(Set annotations, RoundEnvironment roundEnv) {
  Set 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;
}

這里簡(jiǎn)單使用JavaPoet文檔中的第一個(gè)example, 生成一個(gè)簡(jiǎn)單的HelloWorld類(lèi)。大家可自己行去查看JavaPoet的更多用法，支持各種姿勢(shì)生成Java的代碼，并與Processor完美契合。

準(zhǔn)備工作都完成之后，接下來(lái)就在我們的主目錄app下面，通過(guò)添加注解，來(lái)查看我們的代碼生成邏輯。

在根目錄的build.gradle文件中的dependencies節(jié)點(diǎn)下面添加如下代碼：

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")
}

這里，就偷一個(gè)小懶，在MainActivity上，添加注解Test，格式如下：

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

注意，這里定義的注解為編譯期的注解，所以代碼的生成，只需要通過(guò)執(zhí)行Rebuild即可。執(zhí)行完成之后，在app的build/generated/source/apt目錄下，即可看到咱們的代碼，如圖:

apt代碼的生成是定義編譯期的注解，再通過(guò)繼承Proccesor實(shí)現(xiàn)代碼生成邏輯，實(shí)現(xiàn)了編譯期生成代碼的邏輯。相對(duì)于在運(yùn)行期通過(guò)反射來(lái)說(shuō)，提高了程序的運(yùn)行速度。這里只是簡(jiǎn)單引導(dǎo)大家搭建自己的apt處理器，更多的內(nèi)容期待大家各自玩出花來(lái)。

附上一篇標(biāo)準(zhǔn)的編譯期代碼生成，以及trinea關(guān)于annotation的詳細(xì)介紹。

Annotation實(shí)戰(zhàn)【自定義AbstractProcessor】

Java Annotation 及幾個(gè)常用開(kāi)源項(xiàng)目注解原理簡(jiǎn)析

另外，使用apt的代碼庫(kù)Dagger2, Butterknife大家可自行深入研究了。

轉(zhuǎn)載請(qǐng)注明原文鏈接: http://alighters.com/blog/2016/05/10/apt-code-generate/