APT介紹與使用(含demo)

1 什么是APT

APT(Annotation Processing Toll)，是一種處理注解的工具，它對(duì)源代碼文件進(jìn)行檢測(cè)找出其中的Annotation，根據(jù)注解自動(dòng)生成代碼，如果想要自定義的注解處理器能夠正常運(yùn)行，必須要通過(guò)APT工具進(jìn)行處理。簡(jiǎn)單來(lái)說(shuō)就是在編譯期，通過(guò)注解生成 .java 文件。

APT也是AOP(Aspect-Oriented Programming)的一種實(shí)現(xiàn)方式。

使用到的APT的框架：DataBinding、Dagger2、ButterKnife、EventBus3、ARouter等

2 什么是Annotation

2.1 注解分為三類

  • 標(biāo)準(zhǔn) Annotation
    包括 Override, Deprecated, SuppressWarnings，是java自帶的幾個(gè)注解，他們由編譯器來(lái)識(shí)別，不會(huì)進(jìn)行編譯， 不影響代碼運(yùn)行

  • 元 Annotation
    @Retention, @Target, @Inherited, @Documented，它們是用來(lái)定義 Annotation 的 Annotation。

  • 自定義 Annotation
    使用@interface自定義注解時(shí)，自動(dòng)繼承了java.lang.annotation.Annotation接口，由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)，不能繼承其他的注解或接口。@interface用來(lái)聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱，返回值類型就是參數(shù)類型（只能是基本類型、Class、String、enum）。可以通過(guò)default來(lái)聲明參數(shù)的默認(rèn)值。

2.2 自定義的注解也分為三類

  • @Retention(RetentionPolicy.SOURCE)
    源碼時(shí)注解，一般用來(lái)作為編譯器標(biāo)記。如Override, Deprecated, SuppressWarnings。

  • @Retention(RetentionPolicy.RUNTIME)
    運(yùn)行時(shí)注解，在運(yùn)行時(shí)通過(guò)反射去識(shí)別的注解。運(yùn)行時(shí)注解的實(shí)質(zhì)是，在代碼中通過(guò)注解進(jìn)行標(biāo)記，運(yùn)行時(shí)通過(guò)反射尋找標(biāo)記進(jìn)行某種處理。而運(yùn)行時(shí)注解中使用到了反射，對(duì)性能會(huì)有一定的影響。

  • @Retention(RetentionPolicy.CLASS)
    編譯時(shí)注解，在編譯時(shí)被識(shí)別并處理的注解。編譯時(shí)按照一定策略生成代碼，避免編寫重復(fù)代碼，提高開(kāi)發(fā)效率，且不影響性能。

3 APT相關(guān)API

3.1 AbstractProcessor

其中五個(gè)比較常用的方法

3.1.1 init(ProcessingEnvironment): void

該方法主要用于一些初始化的操作，通過(guò)該方法的參數(shù)ProcessingEnvironment可以獲取一些有用的工具類，如

  • Elements： 操作Element工具類 (類、函數(shù)、屬性都是Element)
  • Types：type(類信息)工具類，包含用于操作TypeMirror的工具方法
  • Messager：用來(lái)報(bào)告錯(cuò)誤，警告和其他提示信息
  • Filer：文件生成器 類/資源，F(xiàn)ilter用來(lái)創(chuàng)建新的源文件，class文件以及輔助文件

3.1.2 process(Set< ? extends TypeElement >,RoundEnvironment): boolean

注解處理器的核心方法，處理具體的注解，生成Java文件。
參數(shù)set：使用了支持處理的注解的節(jié)點(diǎn)集合（被注解標(biāo)記的類的集合）。
參數(shù)roundEnvironment：當(dāng)前或是之前的運(yùn)行環(huán)境,可以通過(guò)該對(duì)象查找指定注解的集合。
返回值：true 表示已經(jīng)處理完成，后續(xù)處理器不會(huì)再處理

3.1.3 getSupportedSourceVersion(): SourceVersion

指定JDK編譯版本

3.1.4 getSupportedAnnotationTypes(): Set< String >

指定這個(gè)注解處理器允許/支持的注解類型

3.1.5 getSupporteOptions(): Set< String >

注解處理器接收的參數(shù)

3.1.6 后面的三個(gè)方法可以通過(guò)注解的形式完成

// 通過(guò)auto-service中的@AutoService可以自動(dòng)生成AutoService注解處理器，用來(lái)注冊(cè)
// 用來(lái)生成 META-INF/services/javax.annotation.processing.Processor 文件
@AutoService(Processor.class)
// 允許/支持的注解類型，讓注解處理器處理
@SupportedAnnotationTypes({"com.jokerwan.annotation.JRouter"})
// 指定JDK編譯版本
@SupportedSourceVersion(SourceVersion.RELEASE_8)
// 注解處理器接收的參數(shù)
@SupportedOptions("content")
public class ARouterProcessor extends AbstractProcessor {

}

4 APT練手demo實(shí)現(xiàn)ARouter生成路由輔助類

4.1 新建名為annotation的java library

定義標(biāo)記類的路由地址的注解JRouter

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

    /**
     * 詳細(xì)路由路徑（必填），如："/app/MainActivity"
     */
    String path();

    /**
     * 路由組名（選填，如果開(kāi)發(fā)者不填寫，可以從path中截取出來(lái)）
     */
    String group() default "";
}

該注解是作用在類之上，所以Target是ElementType.TYPE，我們想要通過(guò)該注解在編譯時(shí)生成一些輔助路由的文件，所以Retention是RetentionPolicy.CLASS，定義了注解的兩個(gè)參數(shù)path和group，前者必填，后者選填，后者可截取一級(jí)路徑，即第一個(gè)"/"和第二個(gè)"/"直接的路徑名。

4.2 模擬APT生成后的代碼XXXActivity$$ARouter 

public class XXXActivity$$ARouter {

    public static Class<?> findTargetClass(String path) {
        if (path.equals("/app/MainActivity")) {
            return MainActivity.class;
        }
        return null;
    }
}

此類是我們要通過(guò)APT生成的代碼，類中有一個(gè)findTargetClass(String)方法，通過(guò)傳入path獲取到對(duì)應(yīng)的Class。

4.3 新建名為compiler的java library

4.3.1 修改build.gradle文件如下

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    compileOnly'com.google.auto.service:auto-service:1.0-rc4'
    annotationProcessor'com.google.auto.service:auto-service:1.0-rc4'

    // 引入annotation，讓注解處理器-處理注解
    implementation project(':annotation')
}

// java控制臺(tái)輸出中文亂碼
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}

// jdk編譯版本1.8
sourceCompatibility = "8"
targetCompatibility = "8"

這里引用 auto-service的目的是注冊(cè)注解，并對(duì)其生成META-INF的配置信息，需要注意的是這里引用 auto-service 和 gradle 版本號(hào)有坑，編譯的時(shí)候會(huì)出錯(cuò)，目前沒(méi)有問(wèn)題的兩種版本號(hào)配置對(duì)應(yīng)如下

  • As-3.2.1 + gradle4.10.1-all + auto-service:1.0-rc2
  • As-3.4.1 + gradle5.1.1-all + auto-service:1.0-rc4

4.3.2 實(shí)現(xiàn)注解處理器

兩種方式

  • 手動(dòng)生成java代碼
  • 通過(guò)JavaPoet自動(dòng)生成java代碼（推薦，不易出錯(cuò)）
方式一：手動(dòng)生成java代碼
// 通過(guò)auto-service中的@AutoService可以自動(dòng)生成AutoService注解處理器
// 用來(lái)生成 META-INF/services/javax.annotation.processing.Processor 文件
@AutoService(Processor.class)
// 允許/支持的注解類型，讓注解處理器處理
@SupportedAnnotationTypes({"com.jokerwan.annotation.JRouter"})
// 指定JDK編譯版本
@SupportedSourceVersion(SourceVersion.RELEASE_8)
// 注解處理器接收的參數(shù)
@SupportedOptions("content")
public class JRouterProcessor extends AbstractProcessor {

    // 操作Element工具類 (類、函數(shù)、屬性都是Element)
    private Elements elementUtils;

    // type(類信息)工具類，包含用于操作TypeMirror的工具方法
    private Types typeUtils;

    // Messager用來(lái)報(bào)告錯(cuò)誤，警告和其他提示信息
    private Messager messager;

    // 文件生成器 類/資源，F(xiàn)ilter用來(lái)創(chuàng)建新的源文件，class文件以及輔助文件
    private Filer filer;

    /**
     * 初始化
     *
     * @param processingEnvironment 通過(guò)該方法的參數(shù)ProcessingEnvironment可以獲取一些有用的工具類
     */
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        elementUtils = processingEnvironment.getElementUtils();
        messager = processingEnvironment.getMessager();
        filer = processingEnvironment.getFiler();
        typeUtils = processingEnvironment.getTypeUtils();
        // 通過(guò)ProcessingEnvironment去獲取build.gradle傳過(guò)來(lái)的參數(shù)
        String content = processingEnvironment.getOptions().get("content");
        // 有坑：Diagnostic.Kind.ERROR，異常會(huì)自動(dòng)結(jié)束，這里打印日志用Diagnostic.Kind.NOTE
        messager.printMessage(Diagnostic.Kind.NOTE, content);
    }

    /**
     * 處理具體的注解，生成Java文件
     *
     * @param set              使用了支持處理注解的節(jié)點(diǎn)集合（被注解標(biāo)記的類的集合）
     * @param roundEnvironment 當(dāng)前或是之前的運(yùn)行環(huán)境,可以通過(guò)該對(duì)象查找找到的注解
     * @return true            表示已經(jīng)處理完成，后續(xù)處理器不會(huì)再處理
     */
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        if (set.isEmpty()) {
            return false;
        }

        // 獲取所有帶JRouter注解的 類節(jié)點(diǎn)
        Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(JRouter.class);
        // 遍歷所有類節(jié)點(diǎn)
        for (Element element : elements) {
            // 通過(guò)類節(jié)點(diǎn)獲取包節(jié)點(diǎn)（全路徑：com.jokerwan.xxx）
            String packageName = elementUtils.getPackageOf(element).getQualifiedName().toString();
            // 獲取簡(jiǎn)單類名
            String className = element.getSimpleName().toString();
            messager.printMessage(Diagnostic.Kind.NOTE, "被注解的類有：" + className);
            // 最終想生成的類文件名
            String finalClassName = className + "$$ARouter";

            // 創(chuàng)建一個(gè)新的源文件（Class），并返回一個(gè)對(duì)象以允許寫入它
            try {
                JavaFileObject sourceFile = filer.createSourceFile(packageName + "." + finalClassName);
                // 定義Writer對(duì)象，開(kāi)啟寫入
                Writer writer = sourceFile.openWriter();
                writer.write("package " + packageName + ";\n");
                writer.write("public class " + finalClassName + " {\n");
                writer.write("public static Class<?> findTargetClass(String path) {\n");
                // 獲取類之上的@JRouter注解
                JRouter jRouter = element.getAnnotation(JRouter.class);
                writer.write("if (path.equals(\""+ jRouter.path() +"\")) {\n");
                writer.write("return " + className + ".class;\n}\n");
                writer.write("return null;\n");
                writer.write("}\n}");

                writer.close();
            } catch (IOException e) {
                e.printStackTrace();
            }

        }
        return true;
    }
}

通過(guò)手動(dòng)方式生成java文件需要嚴(yán)格按照java文件中的格式，注意空格、分號(hào)、換行，大部分編譯不通過(guò)都是在寫java文件的時(shí)候一些小細(xì)節(jié)出錯(cuò)了。

方式二：通過(guò)JavaPoet自動(dòng)生成java代碼

在compiler模塊的build.gradle中添加依賴JavaPoet依賴

implementation "com.squareup:javapoet:1.10.0"

注解處理器代碼如下

// 通過(guò)auto-service中的@AutoService可以自動(dòng)生成AutoService注解處理器
// 用來(lái)生成 META-INF/services/javax.annotation.processing.Processor 文件
@AutoService(Processor.class)
// 允許/支持的注解類型，讓注解處理器處理
@SupportedAnnotationTypes({"com.jokerwan.annotation.JRouter"})
// 指定JDK編譯版本
@SupportedSourceVersion(SourceVersion.RELEASE_8)
// 注解處理器接收的參數(shù)
@SupportedOptions("content")
public class JRouterProcessor extends AbstractProcessor {

    // 操作Element工具類 (類、函數(shù)、屬性都是Element)
    private Elements elementUtils;

    // type(類信息)工具類，包含用于操作TypeMirror的工具方法
    private Types typeUtils;

    // Messager用來(lái)報(bào)告錯(cuò)誤，警告和其他提示信息
    private Messager messager;

    // 文件生成器 類/資源，F(xiàn)ilter用來(lái)創(chuàng)建新的源文件，class文件以及輔助文件
    private Filer filer;

    /**
     * 初始化
     *
     * @param processingEnvironment 通過(guò)該方法的參數(shù)ProcessingEnvironment可以獲取一些有用的工具類
     */
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        elementUtils = processingEnvironment.getElementUtils();
        messager = processingEnvironment.getMessager();
        filer = processingEnvironment.getFiler();
        typeUtils = processingEnvironment.getTypeUtils();
        // 通過(guò)ProcessingEnvironment去獲取build.gradle傳過(guò)來(lái)的參數(shù)
        String content = processingEnvironment.getOptions().get("content");
        // 有坑：Diagnostic.Kind.ERROR，異常會(huì)自動(dòng)結(jié)束，這里打印日志用Diagnostic.Kind.NOTE
        messager.printMessage(Diagnostic.Kind.NOTE, content);
    }

    /**
     * 處理具體的注解，生成Java文件
     *
     * @param set              使用了支持處理注解的節(jié)點(diǎn)集合（被注解標(biāo)記的類的集合）
     * @param roundEnvironment 當(dāng)前或是之前的運(yùn)行環(huán)境,可以通過(guò)該對(duì)象查找找到的注解
     * @return true            表示已經(jīng)處理完成，后續(xù)處理器不會(huì)再處理
     */
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        if (set.isEmpty()) {
            return false;
        }

        // 獲取所有帶JRouter注解的 類節(jié)點(diǎn)
        Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(JRouter.class);
        // 遍歷所有類節(jié)點(diǎn)
        for (Element element : elements) {
            // 通過(guò)類節(jié)點(diǎn)獲取包節(jié)點(diǎn)（全路徑：com.jokerwan.xxx）
            String packageName = elementUtils.getPackageOf(element).getQualifiedName().toString();
            // 獲取簡(jiǎn)單類名
            String className = element.getSimpleName().toString();
            messager.printMessage(Diagnostic.Kind.NOTE, "被注解的類有：" + className);
            // 最終想生成的類文件名
            String finalClassName = className + "$$ARouter";

            // 獲取類之上@JRouter注解的path值
            JRouter jRouter = element.getAnnotation(JRouter.class);
            // 構(gòu)建方法體
            MethodSpec methodSpec = MethodSpec.methodBuilder("findTargetClass")// 方法名
                    .addModifiers(Modifier.PUBLIC, Modifier.STATIC)// 修飾符
                    .addParameter(String.class, "path")// 參數(shù)
                    .addStatement("return path.equals($S) ? $T.class : null",
                            jRouter.path(), ClassName.get((TypeElement) element))// 代碼語(yǔ)句拼接
                    .returns(Class.class)// 返回值類型
                    .build();
            // 構(gòu)建類
            TypeSpec typeSpec = TypeSpec.classBuilder(finalClassName)
                    .addModifiers(Modifier.PUBLIC)
                    .addMethod(methodSpec)// 添加方法體
                    .build();
            // 在指定的包名下，生成Java類文件
            JavaFile javaFile = JavaFile.builder(packageName, typeSpec).build();
            try {
                javaFile.writeTo(filer);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return true;
    }
}

4.3.3 app模塊分別依賴annotation和compiler模塊

修改app模塊build.gradle文件如下

apply plugin: 'com.android.application'

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.2"
    defaultConfig {
        applicationId "com.jokerwan.apt_demo"
        minSdkVersion 21
        targetSdkVersion 29
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

        // 在gradle文件中配置選項(xiàng)參數(shù)值（用于APT傳參接收）
        // 切記：必須寫在defaultConfig節(jié)點(diǎn)下
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [content : 'jokerwan apt']
            }
        }
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test:runner:1.2.0'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'

    // 依賴注解
    implementation project(':annotation')
    // 依賴注解處理器
    annotationProcessor project(':compiler')

}

注意javaCompileOptions這里是給注解處理器JRouterProcessor上的注解@SupportedOptions("content")傳遞參數(shù)

rebuild一下工程，Build成功之后會(huì)打印如下信息


可以看到我們通過(guò)messager打印的信息已經(jīng)出來(lái)了，一個(gè)是我們?cè)賏pp模塊的build.gradle中傳入的jokerwan apt，接著打印了被注解的類

看一下APT生成的類文件路徑：

app/build/intermediates/javac/debug/compileDebugJavaWithJavac/classes/com/jokerwan/apt_demo/MainActivity$$ARouter.class

打開(kāi)class文件，Android Studio已經(jīng)幫我們反編譯為java文件


可以看到，跟我們之前模擬的類一樣，通過(guò)該類調(diào)用findTargetClass(String)方法傳入標(biāo)記在類上的注解中的path，就可以拿到該類的Class對(duì)象，由于是在編譯器生成類，不會(huì)對(duì)性能產(chǎn)生影響。

demo地址如下
https://github.com/isJoker/APT_Demo

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容