APT技術

2019-11-09 17:49:54

字體：大中小

來源：轉載

供稿：網友

官方文檔：Getting Started with the Annotation PRocessing Tool (apt)

Annotation

如果想學習APT，那么就必須先了解Annotation的基礎，這里附加我另外一篇文章的地址： Annotation - QQ_20198405的博客 - 博客頻道 - CSDN.NET

APT

APT(Annotation Processing Tool)是一種處理注解的工具,它對源代碼文件進行檢測找出其中的Annotation，使用Annotation進行額外的處理。 Annotation處理器在處理Annotation時可以根據源文件中的Annotation生成額外的源文件和其它的文件(文件具體內容由Annotation處理器的編寫者決定),APT還會編譯生成的源文件和原來的源文件，將它們一起生成class文件。

創建Annotation Module

新建一個名稱為annotation的java Library，主要放置一些項目中需要使用到的Annotation和關聯代碼。這里簡單自定義了一個注解：

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

配置build.gradle

apply plugin: 'java'dependencies { compile fileTree(dir: 'libs', include: ['*.jar'])}sourceCompatibility = "1.7"targetCompatibility = "1.7"

創建Compiler Module

新建一個名為compiler的Java Library，這個類將會寫代碼生成的相關代碼。核心就是在這里。

配置build.gradle

apply plugin: 'java'tasks.withType(JavaCompile) { options.encoding = "UTF-8"}dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) compile 'com.google.auto.service:auto-service:1.0-rc2' compile 'com.squareup:javapoet:1.7.0' compile project(':annotation')}sourceCompatibility = "1.7"targetCompatibility = "1.7"AutoService 主要的作用是注解 processor 類，并對其生成 META-INF 的配置信息。JavaPoet 這個庫的主要作用就是幫助我們通過類調用的形式來生成代碼。tasks.withType是設置編碼格式，避免AptProcesser 中的中文注釋報錯依賴上面創建的annotation Module。

定義Processor類

生成代碼相關的邏輯就放在這里。

@AutoService(Processor.class) public class AptProcesser extends AbstractProcessor { @Override public Set<String> getSupportedAnnotationTypes() { return Collections.singleton(AptAnnotation.class.getCanonicalName()); } @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { return false; } }

生成第一個類

我們接下來要生成下面這個HelloWorld的代碼：

package com.example.helloworld; public final class HelloWorld { public static void main(String[] args) { System.out.println("Hello, JavaPoet!"); } }

修改上述AptProcesser 的process方法

@Override public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) { 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.example.helloworld", helloWorld) .build(); try { javaFile.writeTo(processingEnv.getFiler()); } catch (IOException e) { e.printStackTrace(); } return false; }

在app中使用

配置項目根目錄的build.gradle

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

配置app的build.gradle

apply plugin: 'com.android.application'apply plugin: 'com.neenbedankt.android-apt'//...dependencies { //.. compile project(':annotation') apt project(':compiler')}

編譯使用

@AptAnnotationpublic class MainActivity extends AppCompatActivity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); }}

點擊Android Studio的ReBuild Project，可以在在app的 build/generated/source/apt/debug 目錄下，即可看到生成的代碼。

基于注解的View注入：DIActivity

到目前我們還沒有使用注解，上面的@AptAnnotation 也沒有實際用上，下面我們做一些更加實際的代碼生成。實現基于注解的View，代替項目中的findByView 。這里僅僅是學習怎么用APT，如果真的想用DI框架，推薦使用ButterKnife，功能全面。

第一步，在annotation module創建@DIActivity、@DIView注解。

@Target(ElementType.TYPE)@Retention(RetentionPolicy.CLASS)public @interface DIActivity {}@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)public @interface DIView { int value() default 0;}

第二步，創建Diprocessor方法

@AutoService(Processor.class)public class DIProcessor extends AbstractProcessor { private Elements elementUtils; @Override public Set<String> getSupportedAnnotationTypes() { // 規定需要處理的注解 return Collections.singleton(DIActivity.class.getCanonicalName()); } @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { System.out.println("DIProcessor"); Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(DIActivity.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) { DIView diView = item.getAnnotation(DIView.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; }}

第三步，使用DIActivity

@AptAnnotation@DIActivitypublic class MainActivity extends AppCompatActivity { @DIView(R.id.text1) TextView textView1; @DIView(R.id.text2) TextView textView2; @DIView(R.id.text3) TextView textView3; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); DIMainActivity.bindView(this); textView1.setText("text1"); textView2.setText("text2"); textView3.setText("text3"); }}

實際上就是通過apt生成以下代碼：

public final class DIMainActivity { public static void bindView(MainActivity activity) { activity.textView1 = (android.widget.TextView) activity.findViewById(2131427413); activity.textView2 = (android.widget.TextView) activity.findViewById(2131427414); activity.textView3 = (android.widget.TextView) activity.findViewById(2131427415); }}

常用方法

常用Element子類

TypeElement：類ExecutableElement：成員方法

VariableElement：成員變量

通過包名和類名獲取TypeName

TypeName targetClassName = ClassName.get("PackageName", "ClassName");通過Element獲取TypeNameTypeName type = TypeName.get(element.asType());獲取TypeElement的包名String packageName = processingEnv.getElementUtils().getPackageOf(type).getQualifiedName().toString();獲取TypeElement的所有成員變量和成員方法List<? extends Element> members = processingEnv.getElementUtils().getAllMembers(typeElement);

總結：

推薦閱讀dagger2、dbflow、ButterKnife等基于apt的開源項目代碼。JavaPoet 也有很多例子可以學習。

源碼傳送參考： Android APT（編譯時代碼生成）最佳實踐 - 推酷 例子：代碼傳送（稍加注釋） Android 利用 APT 技術在編譯期生成代碼 - hb707934728的博客 - 博客頻道 - CSDN.NET

相關文章： android-apt 翻譯 - 簡書原文hvisser / android-apt — Bitbucket Annotation-Processing-Tool詳解 | qiushao http://qiushao.net/2015/07/07/Annotation-Processing-Tool%E8%AF%A6%E8%A7%A3/ AndroidSutdio 編譯時自動生成源代碼 | Septenary http://www.septenary.cn/2015/12/19/AndroidSutdio-%E7%BC%96%E8%AF%91%E6%97%B6%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90%E6%BA%90%E4%BB%A3%E7%A0%81/

Android 打造編譯時注解解析框架這只是一個開始 - Hongyang - 博客頻道 - CSDN.NET http://blog.csdn.net/lmj623565791/article/details/43452969 Android 如何編寫基于編譯時注解的項目 - Hongyang - 博客頻道 - CSDN.NET http://blog.csdn.net/lmj623565791/article/details/51931859

bug解決： Android Studio出現Error:No service of type Factor… - 簡書 http://www.jianshu.com/p/c4f4894ad215 Android Studio Error—Gradle: 錯誤:編碼 GBK 的不可映射字符的 - 黑暗領域 - 博客頻道 - CSDN.NET http://blog.csdn.net/sljjyy/article/details/11976099

上一篇：ListView使用SimpleAdapter顯示數據

下一篇：第一次用