一、AbstractProcessor

1，概述

注解分為編譯時注解和運行時注解，現在流行的主流框架ButterKnife，Retrofit，Dragger都是編譯時注解。編譯時注解的核心依賴APT(Annotation Processing Tools)實現的，原理是在某些代碼元素上（如類型、函數、字段等）添加注解，在編譯時編譯器會檢查AbstractProcessor的子類，并且調用process函數，然后將添加了注解的所有元素都傳遞到process函數中，使得開發人員可以在編譯器進行相應的處理。

二、創建步驟

1，首先使用Android Studio創建一個Android的project。然后開始創建一個名為processor的java library。 點擊file->new->new module如圖

Paste_Image.png

2，兼容性配置

在app的工程下的build.gradle,進行配置

Paste_Image.png

加入這句話

compileOptions {
sourceCompatibility JavaVersion.VERSION_1_7
targetCompatibility JavaVersion.VERSION_1_7
}

如圖：

Paste_Image.png

3，創建Annotation

創建annotation的Java moduel，里面放置注解類，如圖：

Paste_Image.png

4，創建注解處理器

在process模塊下創建一個處理器，這個繼承AbstractProcessor，如圖：

Paste_Image.png

Paste_Image.png

這個類上可以添加注解：
@SupportedAnnotationTypes的值為當前類支持的注解的完整類路徑，支持通配符。如圖也就是注解類的類路徑
@SupportedSourceVersion 標識該處理器支持的源碼版本
該類的源碼：

@SupportedAnnotationTypes("com.example.BindView")
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class ButterKnifeProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        StringBuilder builder = new StringBuilder()
                .append("package com.example.generated;\n\n")
                .append("public class GeneratedClass {\n\n") // open class
                .append("\tpublic String getMessage() {\n") // open method
                .append("\t\treturn \"");


        // for each javax.lang.model.element.Element annotated with the CustomAnnotation
        for (Element element : roundEnv.getElementsAnnotatedWith(BindView.class)) {
            String objectType = element.getSimpleName().toString();
            // this is appending to the return statement
            builder.append(objectType).append(" says hello!\\n");
        }

        builder.append("\";\n") // end return
                .append("\t}\n") // close method
                .append("}\n"); // close class

        try { // write the file
            JavaFileObject source = processingEnv.getFiler().createSourceFile("com.example.generated.GeneratedClass");
            Writer writer = source.openWriter();
            writer.write(builder.toString());
            writer.flush();
            writer.close();
        } catch (IOException e) {
            // Note: calling e.printStackTrace() will print IO errors
            // that occur from the file already existing after its first run, this is normal
        }
        return true;
    }
}```

***這里的process方法生成了一個Java文件，在上面的方法中我們想在這個生成這個類和類中的方法，也就是上面StringBuilder 里面連接的字符串，用來測試,這里先不要管這個類是怎么生成的后面會說的***

package com.example.generated;

public class GeneratedClass {

public String getMessage() {
    return "mTextView says hello!\nmTextView1 says hello!\n";
}

}```

5，創建resource文件

創建好注解處理器后，我們需要告訴編譯器在編譯的時候使用哪個注解處理器，這里就需要創建javax.annotation.processing.Processor文件在processor模塊下，main目錄中創建一個resources文件夾，然后下邊在創建META-INF/services，最后里邊一個javax.annotation.processing.Processor文件，如下：

Paste_Image.png

這個txt文件下寫下注解器的路徑，如：

Paste_Image.png

選擇上圖中紅色部分，就能將這個類的路徑copy出來

6，添加android-apt

在project下的build.gradle中添加apt插件

Paste_Image.png

添加依賴：

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

再在app的build.gradle中添加

apply plugin: 'com.neenbedankt.android-apt'

Paste_Image.png

7，設置build的依賴

注解處理器編譯生成一個jar，然后把這個jar包復制到app模塊下。然后讓app依賴引用這個jar。
首先配置app的build.gradle依賴項

dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
exclude group: 'com.android.support', module: 'support-annotations'
})
compile 'com.android.support:appcompat-v7:25.3.0'
compile 'com.android.support.constraint:constraint-layout:1.0.0-beta5'
compile project(':annotation')
apt project(':processor')
testCompile 'junit:junit:4.12'
}

然后我們編寫一個gradle task，把生成的jar文件復制到app/libs目錄中。

task processorTask(type: Copy) {
from '../processor/build/libs/processor.jar' into 'libs/'
}
processorTask.dependsOn(':processor:build')
preBuild.dependsOn(processorTask)

這里的processor是Java moduel的名字，換成你自己的名字即可
完整的build：

Paste_Image.png

8，使用注解

Paste_Image.png

先執行Clean Project，然后再執行ReBuild Project,如果BUILD SUCCESSFUL
當然也可以在libs中看到生成的jar文件
如圖：

Paste_Image.png

然后我們可以在下述位置查看到生成的Java文件

app/build/generated/source/apt/debug/package/GeneratedClass.java

如圖：

Paste_Image.png

此時這個類的代碼是這個樣的

Paste_Image.png

是不是在此時，覺得很神奇，怎么在ButterKnifeProcessor 中process中StringBuilder連接的字符串怎么在這里生成了，
返回去看那個類的源碼，是不是思路一下的就清晰啦，通過反射注解，編譯器在 rebuild的時候就會檢查ButterKnifeProcessor 這個類，調用process方法，所以效率是很高的

9，驗證是否能使用

在app中的MainActivity中使用，代碼如下：

public class MainActivity extends AppCompatActivity {
    @BindView(R.id.textView)
    TextView mTextView;
    @BindView(R.id.textView1)
    TextView mTextView1;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
          setContentView(R.layout.activity_main);
    
     showMessage();

    }

    private void showMessage() {
        GeneratedClass generatedClass = new GeneratedClass();
        String message = generatedClass.getMessage();
        AlertDialog.Builder builder = new AlertDialog.Builder(this);
        builder.setMessage(message)
                .setTitle("測試編譯時")
                .setPositiveButton("ok", null).show();
    }
}

Paste_Image.png