APT(Annotation Processing Tool)

? APT是處理Java代碼的注解的工具漾狼，它對源代碼文件進行監(jiān)測找出其中的Annotation鸠蚪，根據(jù)注解從而自動生成代碼今阳，如果想要自定義的注解處理器能夠正常運行，必須要通過APT工具來進行處理邓嘹。也可以這樣理解酣栈，只要通過聲明APT工具后险胰，程序在編譯期自定義的注解解釋器才能執(zhí)行汹押。

? 簡單點：根據(jù)規(guī)則，自動生成代碼起便、生成Class類文件

第三方框架

? 如果用過以下框架棚贾，都有用到注解聲明。分別在變量榆综、函數(shù)妙痹、接口類上等....

• xUtils
  • @Event(value=R.id.xxx，type=View.OnClickListener.class)
• Butternife
  • @BindView(R.id.xxx)
• EventBus
  • @Subscribe(threadMode = ThreadMode.MainThread) 事件接受通知
• Dagger2
  • @inject @Component @name
• Arouter
  • @Route（path = "/app/xxxActivity"）

APT結(jié)構(gòu)思路

對于java源文件來說鼻疮，它同樣也是一種結(jié)構(gòu)體語言：

package com.netease.apt;    // PackageElement 包元素/節(jié)點

public class Main{          // TypeElement 類元素/節(jié)點
    
    private int x;          // VariableElement 屬性元素/節(jié)點 
    
    private Main(){         // ExecuteableElement 方法元素/節(jié)點
    
    }
    
   private void print(String msg){} 
}
    

PackageElement

? 表示一個包程序元素怯伊，提供對有關包及其成員的信息的訪問

ExecutableElement

? 表示某個類或接口的方法、構(gòu)造方法或初始化程序（靜態(tài)或?qū)嵗?/p>

TypeElement

? 表示一個類或接口程序元判沟，提供對有關類型及其成員的信息的訪問

VariableElement

? 表示一個字段耿芹、enum 常量崭篡、方法或構(gòu)造方法參數(shù)、局部變量或異常參數(shù)

API

#   getEnclosedElements() 

    ?返回該元素直接包含的子元素 

#   getEnclosingElement() 

    ?返回包含該element的父element吧秕，與上一個方法相反 getKind() 返回element的類型琉闪，判斷是哪種element 

#   getModifiers() 

    ?獲取修飾關鍵字,入public static final等關鍵字 

#   getSimpleName() 

    ?獲取名字，不帶包名

#   getQualifiedName()砸彬、

    ?獲取全名颠毙，如果是類的話，包含完整的包名路徑 

#   getParameters() 

    ?獲取方法的參數(shù)元素砂碉，每個元素是一個VariableElement 

#   getReturnType() 

    ?獲取方法元素的返回值 

#   getConstantValue()

    ?如果屬性變量被final修飾蛀蜜，則可以使用該方法獲取它的值

java代碼生成器

傳統(tǒng)方案-JavaFileObject

? 在EventBus中，是通過JavaFileObject + BufferedWriter 以行代碼塊的方式從上到下的順序進行編寫生成

JavaPoet

? Square推出的開源java代碼生成框架增蹭，提供了java Api生成.java源文件涵防，這個框架功能非常實用，也是面向?qū)ο?code>OOP思想沪铭，可以很優(yōu)雅的自動化生成代碼方式蹬竖。

? 不死板靈活性高膝捞，函數(shù)(實現(xiàn)) -> Class & interface -> 包裝類

? Github - JavaPoet

?

# MethodSpec
    代表一個構(gòu)造函數(shù)或方法聲明 
# TypeSpec 
    代表一個類，接口，或者枚舉聲明 
# FieldSpec 
    代表一個成員變量唤殴，一個字段聲明 
# JavaFile 
    包含一個頂級類的Java文件 
# ParameterSpec 
    用來創(chuàng)建參數(shù) 
# AnnotationSpec 
    用來創(chuàng)建注解 
# ClassName 
    用來包裝一個類 
# TypeName 
    類型，如在添加返回值類型是使用 TypeName.VOID 
   
$S 字符串橄维，如：$S, ”hello” 
 
$T 類枣接、接口，如：$T, MainActivity

**假設要生成的 Hello JavaPoet Class **

package com.example.helloworld;

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

JavaPoet格式

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(filer);
} catch (IOException e) {
    e.printStackTrace();
}

?

用JavaPoet生成Class

1. 創(chuàng)建App
2. 新建java-Library硕旗，annotations 定義注解
3. 新建java-Library窗骑，annotations-compiler 并且繼承 AbstractProcessor 注解解析器
4. 在函數(shù) process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) JavaPoet結(jié)構(gòu)體

注解（補）

可以將注解看成一種特殊的接口，一種特殊的屬性元素漆枚，注解本質(zhì)是接口创译。

例如 butterknife 的一段注解，@BindView(R2.id.test_tv)

package butterknife;

import androidx.annotation.IdRes;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Target(FIELD)  //作用屬性字段墙基、枚舉的常量
@Retention(RUNTIME)  //運行期
public @interface BindView {
  /** View ID to which the field will be bound. */
  @IdRes int value();
}

元注解

元注解是在注解中的注解聲明软族，作用在注解之上，方便實現(xiàn)需實現(xiàn)的功能残制。

@Target立砸、@Retention、@Document初茶、@Inherited颗祝、@Repeatable（jdk1.8加入）

Target 表示該注解打在代碼的什么范圍之上

• @Target(ElementType.TYPE) 作用接口、類、枚舉螺戳、注解

• @Target(ElementType.FIELD) 作用屬性字段规揪、枚舉的常量

• @Target(ElementType.METHOD) 作用方法

• @Target(ElementType.PARAMETER) 作用方法參數(shù)

• @Target(ElementType.CONSTRUCTOR) 作用構(gòu)造函數(shù)

• @Target(ElementType.LOCAL_VARIABLE) 作用局部變量

• @Target(ElementType.ANNOTATION_TYPE) 作用于注解（@Retention注解中就使用該屬性）

• @Target(ElementType.PACKAGE) 作用于包

• @Target(ElementType.TYPE_PARAMETER) 作用于類型泛型，即泛型方法温峭、泛型類猛铅、泛型接口 (jdk1.8)

• @Target(ElementType.TYPE_USE) 類型使用.可以用于標注任意類型除了 class (jdk1.8)

Retention 表示當該注解保留的執(zhí)行周期

注意：并且存在生命周期：SOURCE(編寫期) < CLASS(編譯期) < RUNTIME(運行期)

• @Retention(RetentionPolicy.SOURCE) 編寫期，常用語監(jiān)測 例如范圍凤藏，not-null
• @Retention(RetentionPolicy.CLASS)奸忽， 默認的保留策略，java代碼編譯成Class時候的揖庄，配合JavaPoet使用
• @Retention(RetentionPolicy.RUNTIME)栗菜， 程序運行時候，注解會在class字節(jié)碼文件中存在蹄梢，通常配合反射Hook機制進行獲取疙筹，對代碼的操作AOP

Documented 文檔，夠?qū)⒆⒔庵械脑匕?Javadoc 中去

Inherited 繼承禁炒，子注解沒有打注解可以繼承父類的元注解

Repeatable 可重復而咆，可以同時作用一個對象多次，但是每次作用注解又可以代表不同的含義

通過注解解析器用JavaPoet生成Class

工程結(jié)構(gòu)

App -- build.gradle

plugins {
    id 'com.android.application'
}

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.2"

    defaultConfig {
        applicationId "com.example.myjavapoet"
        minSdkVersion 28
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

        // 注解解析器時候可以接受在傳遞的參數(shù) 
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [key: 'hello App']
            }
        }
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {

    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'com.google.android.material:material:1.2.1'
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
    //依賴注解定義
    implementation project(":annotations")
    // 依賴注解處理器
    annotationProcessor project(":annotations-compiler")
}

@MyHelloCls 創(chuàng)建 annotations 定義注解：

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

}

注解解析器annotations-compiler

builder.gradle

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

    //Google apt Service
    compileOnly 'com.google.auto.service:auto-service:1.0-rc4'
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'
    //JavaPoet
    implementation "com.squareup:javapoet:1.9.0"
    //依賴注解定義
    implementation project(":annotations")

}

注解處理器：MyProcessor

package com.example.annotationscompiler;

import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;

import java.io.IOException;
import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedOptions;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;
import javax.tools.Diagnostic;

@AutoService(Processor.class) // 啟用服務
@SupportedAnnotationTypes({"com.example.annotations.MyHelloCls"}) // 注解
@SupportedSourceVersion(SourceVersion.RELEASE_8) // 環(huán)境的版本
@SupportedOptions("key") //App-Gradle定義
public class MyProcessor extends AbstractProcessor {

    // 操作Element的工具類（類幕袱，函數(shù)暴备，屬性，其實都是Element）
    private Elements elementTool;
    // type(類信息)的工具類们豌，包含用于操作TypeMirror的工具方法
    private Types typeTool;
    // Message用來打印 日志相關信息
    private Messager messager;
    // 文件生成器涯捻， 類 資源 等，就是最終要生成的文件 是需要Filer來完成的
    private Filer filer;

    private String value;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);

        elementTool = processingEnv.getElementUtils();
        messager = processingEnv.getMessager();
        filer = processingEnv.getFiler();
        value = processingEnv.getOptions().get("key");

        // Gradle中答應日志望迎，NOTE輸出
        messager.printMessage(Diagnostic.Kind.NOTE, "init >>>>>>>>>>>>>>>>>>>>>>" + value);
    }


    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        messager.printMessage(Diagnostic.Kind.NOTE, "process >>>>>>>>>>>>>>>>>>>>>>");

        if (annotations.isEmpty()) {
            return false;
        }

        //JavaPoet API OOP編寫
        
        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(filer);
            messager.printMessage(Diagnostic.Kind.NOTE, "try: -------------- ok");
        } catch (IOException e) {
            e.printStackTrace();
            messager.printMessage(Diagnostic.Kind.NOTE, "生成Test文件時失敗障癌，異常:" + e.getMessage());
        }

        return true;
    }
}

• init 函數(shù)初始化，獲取操作對象

• @SupportedOptions("key") //App-Gradle定義 是App-build.gradle 定義的參數(shù)辩尊，可在解析器做參數(shù)判斷

• Messager messager 為輸出日志涛浙，Gradle構(gòu)建時候輸出

• process 掃描全工程注解需要執(zhí)行解析的

生成結(jié)果