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的詳細介紹。
另外，使用apt的代碼庫 Dagger2 , Butterknife 大家可自行深入研究了。