快捷導(dǎo)航

Android自定義processor實(shí)現(xiàn)bindView功能的實(shí)例

更新時(shí)間：2017年12月19日 13:40:59 作者：帥氣的碼農(nóng)

下面小編就為大家分享一篇Android自定義processor實(shí)現(xiàn)bindView功能的實(shí)例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧

一、簡(jiǎn)介

在現(xiàn)階段的Android開發(fā)中，注解越來越流行起來，比如ButterKnife，Retrofit，Dragger，EventBus等等都選擇使用注解來配置。按照處理時(shí)期，注解又分為兩種類型，一種是運(yùn)行時(shí)注解，另一種是編譯時(shí)注解，運(yùn)行時(shí)注解由于性能問題被一些人所詬病。編譯時(shí)注解的核心依賴APT(Annotation Processing Tools)實(shí)現(xiàn)，原理是在某些代碼元素上（如類型、函數(shù)、字段等）添加注解，在編譯時(shí)編譯器會(huì)檢查AbstractProcessor的子類，并且調(diào)用該類型的process函數(shù)，然后將添加了注解的所有元素都傳遞到process函數(shù)中，使得開發(fā)人員可以在編譯器進(jìn)行相應(yīng)的處理，例如，根據(jù)注解生成新的Java類，這也就是EventBus，Retrofit，Dragger等開源庫(kù)的基本原理。

Java API已經(jīng)提供了掃描源碼并解析注解的框架，你可以繼承AbstractProcessor類來提供實(shí)現(xiàn)自己的解析注解邏輯。下邊我們將學(xué)習(xí)如何在Android Studio中通過編譯時(shí)注解生成java文件。

二、概念

注解處理器是一個(gè)在javac中的，用來編譯時(shí)掃描和處理的注解的工具。你可以為特定的注解，注冊(cè)你自己的注解處理器。

注解處理器可以生成Java代碼，這些生成的Java代碼會(huì)組成 .java 文件，但不能修改已經(jīng)存在的Java類（即不能向已有的類中添加方法）。而這些生成的Java文件，會(huì)同時(shí)與其他普通的手寫Java源代碼一起被javac編譯。

AbstractProcessor位于javax.annotation.processing包下，我們自己寫processor需要繼承它：

public class LProcessor extends AbstractProcessor
{
 @Override
 public synchronized void init(ProcessingEnvironment processingEnvironment)
 {
 super.init(processingEnvironment);
 }
 
 @Override
 public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment)
 {
 return false;
 }
 
 @Override
 public Set<String> getSupportedAnnotationTypes()
 {
 return super.getSupportedAnnotationTypes();
 }
 
 @Override
 public SourceVersion getSupportedSourceVersion()
 {
 return super.getSupportedSourceVersion();
 }
}

對(duì)上面代碼方法簡(jiǎn)單講解

init(ProcessingEnvironment processingEnvironment): 每一個(gè)注解處理器類都必須有一個(gè)空的構(gòu)造函數(shù)。然而，這里有一個(gè)特殊的init()方法，它會(huì)被注解處理工具調(diào)用，并輸入ProcessingEnviroment參數(shù)。ProcessingEnviroment提供很多有用的工具類Elements,Types和Filer。后面我們將看到詳細(xì)的內(nèi)容。

process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment): 這相當(dāng)于每個(gè)處理器的主函數(shù)main()。你在這里寫你的掃描、評(píng)估和處理注解的代碼，以及生成Java文件。輸入?yún)?shù)RoundEnviroment，可以讓你查詢出包含特定注解的被注解元素。后面我們將看到詳細(xì)的內(nèi)容。

getSupportedAnnotationTypes(): 這里你必須指定，這個(gè)注解處理器是注冊(cè)給哪個(gè)注解的。注意，它的返回值是一個(gè)字符串的集合，包含本處理器想要處理的注解類型的合法全稱。換句話說，你在這里定義你的注解處理器注冊(cè)到哪些注解上。

getSupportedSourceVersion(): 用來指定你使用的Java版本。通常這里返回SourceVersion.latestSupported()。然而，如果你有足夠的理由只支持Java 7的話，你也可以返回SourceVersion.RELEASE_7。注意：在Java 7以后，你也可以使用注解來代替getSupportedAnnotationTypes()和getSupportedSourceVersion()。

我們先創(chuàng)建一個(gè)java module LProcessor

@AutoService(Processor.class)
public class LProcessor extends AbstractProcessor {
 private Elements elementUtils;
 @Override
 public Set<String> getSupportedAnnotationTypes() {
  // 規(guī)定需要處理的注解
  return Collections.singleton(LActivity.class.getCanonicalName());
 }
 @Override
 public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
  System.out.println("DIProcessor");
  Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(LActivity.class);
  for (Element element : elements) {
   // 判斷是否Class
   TypeElement typeElement = (TypeElement) element;
   List<? extends Element> members = elementUtils.getAllMembers(typeElement);
   MethodSpec.Builder bindViewMethodSpecBuilder = MethodSpec.methodBuilder("bindView")
     .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
     .returns(TypeName.VOID)
     .addParameter(ClassName.get(typeElement.asType()), "activity");
   for (Element item : members) {
    LView diView = item.getAnnotation(LView.class);
    if (diView == null){
     continue;
    }
    bindViewMethodSpecBuilder.addStatement(String.format("activity.%s = (%s) activity.findViewById(%s)",item.getSimpleName(),ClassName.get(item.asType()).toString(),diView.value()));
   }
   TypeSpec typeSpec = TypeSpec.classBuilder("DI" + element.getSimpleName())
     .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
     .addMethod(bindViewMethodSpecBuilder.build())
     .build();
   JavaFile javaFile = JavaFile.builder(getPackageName(typeElement), typeSpec).build();
   try {
    javaFile.writeTo(processingEnv.getFiler());
   } catch (IOException e) {
    e.printStackTrace();
   }
  }
  return true;
 }
 private String getPackageName(TypeElement type) {
  return elementUtils.getPackageOf(type).getQualifiedName().toString();
 }
 @Override
 public synchronized void init(ProcessingEnvironment processingEnv) {
  super.init(processingEnv);
  elementUtils = processingEnv.getElementUtils();
 }
 @Override
 public SourceVersion getSupportedSourceVersion() {
  return SourceVersion.RELEASE_7;
 }
}

這里面我們引入了兩個(gè)庫(kù)

compile 'com.google.auto.service:auto-service:1.0-rc2'
compile 'com.squareup:javapoet:1.7.0'

我們?cè)賱?chuàng)建一個(gè)java module anotation

可見，是兩個(gè)注解類：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface LActivity {
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LView {
 int value() default 0;
}

之后我們主工程引入這兩個(gè)module 就可以在我們主工程下面用這個(gè)注解了，我們make project之后會(huì)在工程目錄下build/generated/source/apt下生成對(duì)應(yīng)的java源文件，比如我在下面的activity類使用了定義的注解：

@LActivity
public class TestProcessorActivity extends Activity {
 @LView(R.id.et_input)
 EditText inputView;
 @LView(R.id.button)
 Button buttonView;
 
 @Override
 protected void onCreate(@Nullable Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
 
  setContentView(R.layout.activity_processor);
  DITestProcessorActivity.bindView(this);
  buttonView.setOnClickListener(new View.OnClickListener() {
   @Override
   public void onClick(View v) {
    Toast.makeText(TestProcessorActivity.this , inputView.getText().toString() , Toast.LENGTH_SHORT).show();
   }
  });
 }
}

則在build/generated/source/apt下生成DITestProcessorActivity.java

public final class DITestProcessorActivity {
 public static void bindView(TestProcessorActivity activity) {
 activity.inputView = (android.widget.EditText) activity.findViewById(2131165237);
 activity.buttonView = (android.widget.Button) activity.findViewById(2131165220);
 }
}

<span style="font-size: 14px;">代碼已經(jīng)自動(dòng)生成好了，我們就不需要再寫findViewById()了：</span>
@LView(R.id.et_input)
EditText inputView;
@LView(R.id.button)
Button buttonView;

三、需要了解

我們上面例子主要運(yùn)用了javapoet和auto-service，具體詳細(xì)使用可以參考源碼https://github.com/square/javapoet, 而AutoService比較簡(jiǎn)單，就是在使用Java APT的時(shí)候，使用AutoService注解，可以自動(dòng)生成meta信息。網(wǎng)上有很多相關(guān)文章，可以好好整理學(xué)習(xí)下。

以上這篇Android自定義processor實(shí)現(xiàn)bindView功能的實(shí)例就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: