Android 利用 APT 技術在編譯期產生代碼_Android

APT(Annotation Processing Tool 的簡稱)，可以在代碼編譯期解析註解，並且產生新的 Java 檔案，減少手動的代碼輸入。現在有很多主流庫都用上了 APT，比如 Dagger2, ButterKnife, EventBus3 等，我們要緊跟潮流，與時俱進呐！ (ง •̀_•́)ง

下面通過一個簡單的 View 注入項目 ViewFinder 來介紹 APT 相關內容，簡單實現了類似於ButterKnife 中的兩種註解 @BindView 和 @OnClick 。

項目地址：https://github.com/brucezz/ViewFinder

大概項目結構如下：

1. viewFinder-annotation - 註解相關模組
2. viewFinder-compiler - 註解處理器模組
3. viewfinder - API 相關模組
4. sample - 樣本 Demo 模組
   

實現目標

在通常的 Android 項目中，會寫大量的介面，那麼就會經常重複地寫一些代碼，比如：

TextView text = (TextView) findViewById(R.id.tv);text.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) {  // on click }});

天天寫這麼冗長又無腦的代碼，還能不能愉快地玩耍啦。所以，我打算通過 ViewFinder 這個項目替代這重複的工作，只需要簡單地標註上註解即可。通過控制項 id 進行註解，並且@OnClick 可以對多個控制項註解同一個方法。就像下面這樣子咯：

@BindView(R.id.tv) TextView mTextView;@OnClick({R.id.tv, R.id.btn})public void onSomethingClick() { // on click}

定義註解

建立 module viewFinder-annotation ，類型為 Java Library，定義項目所需要的註解。

在 ViewFinder 中需要兩個註解 @BindView 和 @OnClick 。實現如下：

@Retention(RetentionPolicy.CLASS)@Target(ElementType.FIELD)public @interface BindView { int value();}

@Retention(RetentionPolicy.CLASS)@Target(ElementType.METHOD)public @interface OnClick { int[] value();}

@BindView 需要對成員變數進行註解，並且接收一個 int 類型的參數； @OnClick 需要對方法進行註解，接收一組 int 型別參數，相當於給一組 View 指定點擊響應事件。

編寫 API

建立 module viewfinder，類型為 Android Library。在這個 module 中去定義 API，也就是去確定讓別人如何來使用我們這個項目。

首先需要一個 API 主入口，提供靜態方法直接調用，就比如這樣：

ViewFinder.inject(this);

同時，需要為不同的目標（比如 Activity、Fragment 和 View 等）提供重載的注入方法，最終都調用 inject() 方法。其中有三個參數：

1. host 表示註解 View 變數所在的類，也就是註解類
2. source 表示尋找 View 的地方，Activity & View 自身就可以尋找，Fragment 需要在自己的 itemView 中尋找
3. provider 是一個介面，定義了不同對象（比如 Activity、View 等）如何去尋找目標 View，項目中分別為 Activity、View 實現了 Provider 介面。

public class ViewFinder { private static final ActivityProvider PROVIDER_ACTIVITY = new ActivityProvider(); private static final ViewProvider PROVIDER_VIEW = new ViewProvider(); public static void inject(Activity activity) {  inject(activity, activity, PROVIDER_ACTIVITY); } public static void inject(View view) {  // for view  inject(view, view); } public static void inject(Object host, View view) {  // for fragment  inject(host, view, PROVIDER_VIEW); } public static void inject(Object host, Object source, Provider provider) {  // how to implement ? }}

那麼 inject() 方法中都寫一些什麼呢？

首先我們需要一個介面 Finder，然後為每一個註解類都產生一個對應的內部類並且實現這個介面，然後實現具體的注入邏輯。在 inject() 方法中首先找到調用者對應的 Finder 實作類別，然後調用其內部的具體邏輯來達到注入的目的。

介面 Finder 設計如下 ：

public interface Finder<T> { void inject(T host, Object source, Provider provider);}

舉個例子，為 MainActivity 產生 MainActivity$$Finder，對其註解的 View 進行初始化和設定點擊事件，這就跟我們平常所寫的重複代碼基本相同。

public class MainActivity$$Finder implements Finder<MainActivity> { @Override public void inject(final MainActivity host, Object source, Provider provider) {  host.mTextView = (TextView) (provider.findView(source, 2131427414));  host.mButton = (Button) (provider.findView(source, 2131427413));  host.mEditText = (EditText) (provider.findView(source, 2131427412));  View.OnClickListener listener;  listener = new View.OnClickListener() {   @Override   public void onClick(View view) {    host.onButtonClick();   }  };  provider.findView(source, 2131427413).setOnClickListener(listener);  listener = new View.OnClickListener() {   @Override   public void onClick(View view) {    host.onTextClick();   }  };  provider.findView(source, 2131427414).setOnClickListener(listener); }}

好了，所有註解類都有了一個名為 xx$$Finder 的內部類。我們首先通過註解類的類名，得到其對應內部類的 Class 對象，然後執行個體化拿到具體對象，調用注入方法。

public class ViewFinder { // same as above private static final Map<String, Finder> FINDER_MAP = new HashMap<>(); public static void inject(Object host, Object source, Provider provider) {  String className = host.getClass().getName();  try {   Finder finder = FINDER_MAP.get(className);   if (finder == null) {    Class<?> finderClass = Class.forName(className + "$$Finder");    finder = (Finder) finderClass.newInstance();    FINDER_MAP.put(className, finder);   }   finder.inject(host, source, provider);  } catch (Exception e) {   throw new RuntimeException("Unable to inject for " + className, e);  } }}

另外代碼中使用到了一點反射，所以為了提高效率，避免每次注入的時候都去找 Finder 對象，這裡用一個 Map 將第一次找到的對象緩衝起來，後面用的時候直接從 Map 裡面取。

到此，API 模組的設計基本搞定了，接下來就是去通過註解處理器為每一個註解類產生 Finder內部類。

建立註解處理器

建立 module viewFinder-compiler，類型為 Java Library，實現一個註解處理器。

這個模組需要添加一些依賴：

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

1. 因為要用到前面定義的註解，當然要依賴 viewFinder-annotation。
2. javapoet 是方塊公司出的又一個好用到爆炸的褲子，提供了各種 API 讓你用各種姿勢去產生 Java 代碼檔案，避免了徒手拼接字串的尷尬。
3. auto-service 是 Google 家的褲子，主要用於註解 Processor，對其產生 META-INF 配置資訊。
   

下面就來建立我們的處理器 ViewFinderProcessor。

@AutoService(Processor.class)public class ViewFinderProcesser extends AbstractProcessor { /**  * 使用 Google 的 auto-service 庫可以自動產生 META-INF/services/javax.annotation.processing.Processor 檔案  */ private Filer mFiler; //檔案相關的輔助類 private Elements mElementUtils; //元素相關的輔助類 private Messager mMessager; //日誌相關的輔助類 @Override public synchronized void init(ProcessingEnvironment processingEnv) {  super.init(processingEnv);  mFiler = processingEnv.getFiler();  mElementUtils = processingEnv.getElementUtils();  mMessager = processingEnv.getMessager(); } /**  * @return 指定哪些註解應該被註解處理器註冊  */ @Override public Set<String> getSupportedAnnotationTypes() {  Set<String> types = new LinkedHashSet<>();  types.add(BindView.class.getCanonicalName());  types.add(OnClick.class.getCanonicalName());  return types; } /**  * @return 指定使用的 Java 版本。通常返回 SourceVersion.latestSupported()。  */ @Override public SourceVersion getSupportedSourceVersion() {  return SourceVersion.latestSupported(); } @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {  // to process annotations   return false; }}

用 @AutoService 來註解這個處理器，可以自動組建組態資訊。

在 init() 可以初始化拿到一些實用的工具類。

在 getSupportedAnnotationTypes() 方法中返回所要處理的註解的集合。

在 getSupportedSourceVersion() 方法中返回 Java 版本。

這幾個方法寫法基本上都是固定的，重頭戲在 process() 方法。

這裡插播一下 Element 元素相關概念，後面會用到不少。

Element 元素，原始碼中的每一部分都是一個特定的元素類型，分別代表了包、類、方法等等，具體看 Demo。

package com.example;public class Foo { // TypeElement private int a; // VariableElement private Foo other; // VariableElement public Foo() {} // ExecuteableElement public void setA( // ExecuteableElement   int newA // TypeElement ) { }}

這些 Element 元素，相當於 XML 中的 DOM 樹，可以通過一個元素去訪問它的父元素或者子項目。

element.getEnclosingElement();// 擷取父元素
 element.getEnclosedElements();// 擷取子項目

註解處理器的整個處理過程跟普通的 Java 程式沒什麼區別，我們可以使用物件導向的思想和設計模式，將相關邏輯封裝到 model 中，使得流程更清晰簡潔。分別將註解的成員變數、點擊方法和整個註解類封裝成不同的 model。

public class BindViewField { private VariableElement mFieldElement; private int mResId; public BindViewField(Element element) throws IllegalArgumentException {  if (element.getKind() != ElementKind.FIELD) {   throw new IllegalArgumentException(    String.format("Only fields can be annotated with @%s", BindView.class.getSimpleName()));  }  mFieldElement = (VariableElement) element;  BindView bindView = mFieldElement.getAnnotation(BindView.class);  mResId = bindView.value(); } // some getter methods}

主要就是在初始化時校正了一下元素類型，然後擷取註解的值，在提供幾個 get 方法。OnClickMethod 封裝類似。

public class AnnotatedClass { public TypeElement mClassElement; public List<BindViewField> mFields; public List<OnClickMethod> mMethods; public Elements mElementUtils; // omit some easy methods  public JavaFile generateFinder() {  // method inject(final T host, Object source, Provider provider)  MethodSpec.Builder injectMethodBuilder = MethodSpec.methodBuilder("inject")   .addModifiers(Modifier.PUBLIC)   .addAnnotation(Override.class)   .addParameter(TypeName.get(mClassElement.asType()), "host", Modifier.FINAL)   .addParameter(TypeName.OBJECT, "source")   .addParameter(TypeUtil.PROVIDER, "provider");  for (BindViewField field : mFields) {   // find views   injectMethodBuilder.addStatement("host.$N = ($T)(provider.findView(source, $L))", field.getFieldName(),    ClassName.get(field.getFieldType()), field.getResId());  }  if (mMethods.size() > 0) {   injectMethodBuilder.addStatement("$T listener", TypeUtil.ANDROID_ON_CLICK_LISTENER);  }  for (OnClickMethod method : mMethods) {   // declare OnClickListener anonymous class   TypeSpec listener = TypeSpec.anonymousClassBuilder("")    .addSuperinterface(TypeUtil.ANDROID_ON_CLICK_LISTENER)    .addMethod(MethodSpec.methodBuilder("onClick")     .addAnnotation(Override.class)     .addModifiers(Modifier.PUBLIC)     .returns(TypeName.VOID)     .addParameter(TypeUtil.ANDROID_VIEW, "view")     .addStatement("host.$N()", method.getMethodName())     .build())    .build();   injectMethodBuilder.addStatement("listener = $L ", listener);   for (int id : method.ids) {    // set listeners    injectMethodBuilder.addStatement("provider.findView(source, $L).setOnClickListener(listener)", id);   }  }  // generate whole class   TypeSpec finderClass = TypeSpec.classBuilder(mClassElement.getSimpleName() + "$$Finder")   .addModifiers(Modifier.PUBLIC)   .addSuperinterface(ParameterizedTypeName.get(TypeUtil.FINDER, TypeName.get(mClassElement.asType())))   .addMethod(injectMethodBuilder.build())   .build();  String packageName = mElementUtils.getPackageOf(mClassElement).getQualifiedName().toString();  // generate file  return JavaFile.builder(packageName, finderClass).build(); }}

AnnotatedClass 表示一個註解類，裡面放了兩個列表，分別裝著註解的成員變數和方法。在generateFinder() 方法中，按照上一節設計的模板，利用 JavaPoet 的 API 產生代碼。這部分沒啥特別的姿勢，照著 JavaPoet 文檔 來就好了，文檔寫得很細緻。

有很多地方需要用到對象的類型，普通類型可以用

ClassName get(String packageName, String simpleName, String... simpleNames)

傳入包名、類名、內部類名，就可以拿到想要的類型了（可以參考 項目中TypeUtil 類）。

用到泛型的話，可以用
ParameterizedTypeName get(ClassName rawType, TypeName... typeArguments)

傳入具體類和泛型型別就好了。

這些 model 都確定好了之後，process() 方法就很清爽啦。使用 RoundEnvironment 參數來查詢被特定註解標註的元素，然後解析成具體的 model，最後產生代碼輸出到檔案中。

@AutoService(Processor.class)public class ViewFinderProcesser extends AbstractProcessor { private Map<String, AnnotatedClass> mAnnotatedClassMap = new HashMap<>(); @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {  // process() will be called several times  mAnnotatedClassMap.clear();  try {   processBindView(roundEnv);   processOnClick(roundEnv);  } catch (IllegalArgumentException e) {   error(e.getMessage());   return true; // stop process  }  for (AnnotatedClass annotatedClass : mAnnotatedClassMap.values()) {   try {    info("Generating file for %s", annotatedClass.getFullClassName());    annotatedClass.generateFinder().writeTo(mFiler);   } catch (IOException e) {    error("Generate file failed, reason: %s", e.getMessage());    return true;   }  }  return true; } private void processBindView(RoundEnvironment roundEnv) throws IllegalArgumentException {  for (Element element : roundEnv.getElementsAnnotatedWith(BindView.class)) {   AnnotatedClass annotatedClass = getAnnotatedClass(element);   BindViewField field = new BindViewField(element);   annotatedClass.addField(field);  } } private void processOnClick(RoundEnvironment roundEnv) {  // same as processBindView() } private AnnotatedClass getAnnotatedClass(Element element) {  TypeElement classElement = (TypeElement) element.getEnclosingElement();  String fullClassName = classElement.getQualifiedName().toString();  AnnotatedClass annotatedClass = mAnnotatedClassMap.get(fullClassName);  if (annotatedClass == null) {   annotatedClass = new AnnotatedClass(classElement, mElementUtils);   mAnnotatedClassMap.put(fullClassName, annotatedClass);  }  return annotatedClass; }}

首先解析註解元素，並放到對應的註解類對象中，最後調用方法組建檔案。model 的代碼中還會加入一些校正代碼，來判斷註解元素是否合理，資料是否正常，然後拋出異常，處理器接收到之後可以列印出錯誤提示，然後直接返回 true 來結束處理。

至此，註解處理器也基本完成了，具體細節參考項目代碼。

實際項目使用

建立 module sample，普通的 Android module，來示範 ViewFinder 的使用。

在整個項目下的 build.gradle 中添加

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

然後在 sample module 下的 build.gradle 中添加

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

同時添加依賴：

compile project(':viewfinder-annotation')compile project(':viewfinder')apt project(':viewfinder-compiler')

然後隨便建立個布局，隨便添加幾個控制項，就能體驗註解啦。

public class MainActivity extends AppCompatActivity { @BindView(R.id.tv) TextView mTextView; @BindView(R.id.btn) Button mButton; @BindView(R.id.et) EditText mEditText; @OnClick(R.id.btn) public void onButtonClick() {  Toast.makeText(this, "onButtonClick", Toast.LENGTH_SHORT).show(); } @OnClick(R.id.tv) public void onTextClick() {  Toast.makeText(this, "onTextClick", Toast.LENGTH_SHORT).show(); } @Override protected void onCreate(Bundle savedInstanceState) {  super.onCreate(savedInstanceState);  setContentView(R.layout.activity_main);  ViewFinder.inject(this); }}

這個時候 build 一下項目，就能看到產生的 MainActivity$$Finder 類了，再運行項目就跑起來了。每次改變註解之後，build 一下項目就好啦。

all done ~

這個項目也就是個玩具級的 APT 項目，藉此來學習如何編寫 APT 項目。感覺 APT 項目更多地是考慮如何去設計架構，類之間如何調用，需要產生什麼樣的代碼，提供怎樣的 API 去調用。最後才是利用註解處理器去解析註解，然後用 JavaPoet 去產生具體的代碼。

思路比實現更重要，設計比代碼更巧妙。

參考

1. Annotation-Processing-Tool詳解 （大力推薦）
2. Android 如何編寫基於編譯時間註解的項目
3. JavaPoet 文檔
4. ButterKnife （代碼結構設計很棒）

 通過此文，希望能協助大家開發Android應用程式，謝謝大家對本站的支援！