Android自定義processor實現(xiàn)bindView功能的實例
一、簡介
在現(xiàn)階段的Android開發(fā)中,注解越來越流行起來,比如ButterKnife,Retrofit,Dragger,EventBus等等都選擇使用注解來配置。按照處理時期,注解又分為兩種類型,一種是運行時注解,另一種是編譯時注解,運行時注解由于性能問題被一些人所詬病。編譯時注解的核心依賴APT(Annotation Processing Tools)實現(xiàn),原理是在某些代碼元素上(如類型、函數(shù)、字段等)添加注解,在編譯時編譯器會檢查AbstractProcessor的子類,并且調(diào)用該類型的process函數(shù),然后將添加了注解的所有元素都傳遞到process函數(shù)中,使得開發(fā)人員可以在編譯器進行相應的處理,例如,根據(jù)注解生成新的Java類,這也就是EventBus,Retrofit,Dragger等開源庫的基本原理。
Java API已經(jīng)提供了掃描源碼并解析注解的框架,你可以繼承AbstractProcessor類來提供實現(xiàn)自己的解析注解邏輯。下邊我們將學習如何在Android Studio中通過編譯時注解生成java文件。
二、概念
注解處理器是一個在javac中的,用來編譯時掃描和處理的注解的工具。你可以為特定的注解,注冊你自己的注解處理器。
注解處理器可以生成Java代碼,這些生成的Java代碼會組成 .java 文件,但不能修改已經(jīng)存在的Java類(即不能向已有的類中添加方法)。而這些生成的Java文件,會同時與其他普通的手寫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(); } }
對上面代碼方法簡單講解
init(ProcessingEnvironment processingEnvironment): 每一個注解處理器類都必須有一個空的構(gòu)造函數(shù)。然而,這里有一個特殊的init()方法,它會被注解處理工具調(diào)用,并輸入ProcessingEnviroment參數(shù)。ProcessingEnviroment提供很多有用的工具類Elements,Types和Filer。后面我們將看到詳細的內(nèi)容。
process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment): 這相當于每個處理器的主函數(shù)main()。你在這里寫你的掃描、評估和處理注解的代碼,以及生成Java文件。輸入?yún)?shù)RoundEnviroment,可以讓你查詢出包含特定注解的被注解元素。后面我們將看到詳細的內(nèi)容。
getSupportedAnnotationTypes(): 這里你必須指定,這個注解處理器是注冊給哪個注解的。注意,它的返回值是一個字符串的集合,包含本處理器想要處理的注解類型的合法全稱。換句話說,你在這里定義你的注解處理器注冊到哪些注解上。
getSupportedSourceVersion(): 用來指定你使用的Java版本。通常這里返回SourceVersion.latestSupported()。然而,如果你有足夠的理由只支持Java 7的話,你也可以返回SourceVersion.RELEASE_7。注意:在Java 7以后,你也可以使用注解來代替getSupportedAnnotationTypes()和getSupportedSourceVersion()。
我們先創(chuàng)建一個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; } }
這里面我們引入了兩個庫
compile 'com.google.auto.service:auto-service:1.0-rc2' compile 'com.squareup:javapoet:1.7.0'
我們再創(chuàng)建一個java module anotation
可見,是兩個注解類:
@Target(ElementType.TYPE) @Retention(RetentionPolicy.CLASS) public @interface LActivity { }
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface LView { int value() default 0; }
之后我們主工程引入這兩個module 就可以在我們主工程下面用這個注解了,我們make project之后會在工程目錄下build/generated/source/apt下生成對應的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)自動生成好了,我們就不需要再寫findViewById()了:</span> @LView(R.id.et_input) EditText inputView; @LView(R.id.button) Button buttonView;
三、需要了解
我們上面例子主要運用了javapoet和auto-service,具體詳細使用可以參考源碼https://github.com/square/javapoet, 而AutoService比較簡單,就是在使用Java APT的時候,使用AutoService注解,可以自動生成meta信息。網(wǎng)上有很多相關(guān)文章,可以好好整理學習下。
以上這篇Android自定義processor實現(xiàn)bindView功能的實例就是小編分享給大家的全部內(nèi)容了,希望能給大家一個參考,也希望大家多多支持腳本之家。
- Linux內(nèi)核設備驅(qū)動之proc文件系統(tǒng)筆記整理
- VC++進度條process Bar的用法實例
- Android Studio 報錯“app:processDebugResources"解決方法
- Linux proc目錄下子文件或子文件夾的作用
- 詳解promise.then,process.nextTick, setTimeout 以及 setImmediate的執(zhí)行順序
- 對Python subprocess.Popen子進程管道阻塞詳解
- Python3多進程 multiprocessing 模塊實例詳解
- Python subprocess模塊詳細解讀
- Android為Tiny4412設備驅(qū)動在proc目錄下添加一個可讀版本信息的文件
相關(guān)文章
Android BottomSheet效果的兩種實現(xiàn)方式
這篇文章主要介紹了Android BottomSheet效果的兩種實現(xiàn)方式,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-08-08Android模塊化中數(shù)據(jù)傳遞/路由跳轉(zhuǎn)實現(xiàn)示例
這篇文章主要介紹了Android模塊化中數(shù)據(jù)傳遞/路由跳轉(zhuǎn)實現(xiàn)示例,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-07-07Android App開發(fā)中Gradle構(gòu)建過程的配置方法
這篇文章主要介紹了Android App開發(fā)中Gradle構(gòu)建過程的配置方法,包括在Gradle中配置manifest的方法,需要的朋友可以參考下2016-06-06使用Kotlin+RocketMQ實現(xiàn)延時消息的示例代碼
這篇文章主要介紹了使用Kotlin+RocketMQ實現(xiàn)延時消息的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2019-07-07android中ListView多次刷新重復執(zhí)行g(shù)etView的解決方法
以前倒是沒有注意listview的getView會重復執(zhí)行多次,在測試的時候去斷點跟蹤,發(fā)現(xiàn)同一條數(shù)據(jù)不斷的重復執(zhí)行,下面與大家分享下正確的解決方法,希望對你有所幫助2013-06-06android自定義toast(widget開發(fā))示例
這篇文章主要介紹了android自定義toast(widget開發(fā))示例,需要的朋友可以參考下2014-03-03Android實現(xiàn)瘋狂連連看游戲之狀態(tài)數(shù)據(jù)模型(三)
這篇文章主要為大家詳細介紹了Android實現(xiàn)瘋狂連連看游戲之狀態(tài)數(shù)據(jù)模型,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-03-03Android實現(xiàn)TextView字符串關(guān)鍵字變色的方法
這篇文章顯示給大家介紹了字符串中關(guān)鍵字變色的實現(xiàn)方法,而后又拓展介紹了在Android中如何實現(xiàn)搜索關(guān)鍵字變色,相信對各位Android開發(fā)者們具有一定的參考借鑒價值,感興趣的朋友們下面來一起看看吧。2016-10-10