摘要:執行完成之后,在的目錄下,即可看到咱們的代碼,如圖總結代碼的生成是定義編譯期的注解,再通過繼承實現代碼生成邏輯,實現了編譯期生成代碼的邏輯。學習資料附上一篇標準的編譯期代碼生成,以及關于的詳細介紹。
現在 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 SetgetSupportedAnnotationTypes() { 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的詳細介紹。
Annotation實戰【自定義AbstractProcessor】
Java Annotation 及幾個常用開源項目注解原理簡析
另外,使用apt的代碼庫Dagger2, Butterknife大家可自行深入研究了。
轉載請注明原文鏈接: http://alighters.com/blog/2016/05/10/apt-code-generate/
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/65914.html
摘要:使用實現功能運行期注解案例使用簡單的注解,便可以設置布局,等效于使用實現路由綜合型案例比較全面的介紹從零起步,一步一步封裝簡易的路由開源庫。申明注解用的就是。返回值表示這個注解里可以存放什么類型值。 YCApt關于apt方案實踐與總結 目錄介紹 00.注解系列博客匯總 01.什么是apt 02.annotationProcessor和apt區別 03.項目目錄結構 04.該案例作用 ...
摘要:楊充一定時間內該點擊事件只能執行一次用來修飾這是一個什么類型的注解。楊充自定義編譯器獲取遍歷,并生成代碼配置文件文件配置的作用是向系統注冊自定義注解處理器,執行編譯時使用進行處理。 目錄介紹 01.創建項目步驟 1.1 項目搭建 1.2 項目功能 02.自定義注解 03.創建Processor 04.compiler配置文件 05.編譯jar 06.如何使用 07.編譯生成代...
閱讀 2953·2021-09-26 10:18
閱讀 5281·2021-09-22 15:02
閱讀 2796·2019-08-30 15:53
閱讀 1841·2019-08-29 18:41
閱讀 2692·2019-08-27 10:58
閱讀 2623·2019-08-26 13:49
閱讀 2750·2019-08-26 12:17
閱讀 901·2019-08-26 11:49