APT(Annotation Processing Tool)是一種處理注解的工具,它對源代碼文件進行檢測找出其中的Annotation,根據注解自動生成代碼,如果想要自定義的注解處理器能夠正常運行,必須要通過APT工具來進行處理。也可以這樣理解,只有通過聲明APT工具后,程序在編譯期間自定義注解解釋器來能執行。
通俗理解:根據規則,幫我們生成代碼、生成類文件
element組成的結構體
對于java源文件來說,java也是一種結構體語言
Element程序元素
PackageElement:
表示一個包程序元素。提供對有關包及其成員的信息的訪問
ExecutableElement:
表示某個類或接口的方法、構造方法或初始化程序(靜態或實例)
TypeElement:
表示一個類或接口程序元素。提供對有關類型及其成員的信息的訪問。
VariableElement:
表示一個字段、enum常量、方法或構造方法參數、局部變量或異常參數
需要掌握的API
自定義注解
定義格式:
元注解
public @interface 注解名稱{
格式1: 修飾符 數據類型 屬性名( );
格式2: 修飾符 數據類型 屬性名( ) default 默認值 ;
}注解的屬性:
1.作用: 使用注解時可以傳遞參數 , 讓注解功能更強大.
2.屬性使用的數據類型: 四類八種 , String類型 , Class 類型 , 枚舉 , 注解類型.
3.特殊屬性Value : 當只有一個屬性 && 名稱是value , 可以直接給屬性值.使用格式:
沒有屬性: @注解名稱
有 屬 性 : @注解名稱(屬性名 = 屬性值 , 屬性名 = 屬性值 … )
value屬性: @注解名稱(屬性值) ;
元注解@Target:
- @Target(ElementType.TYPE) // 接口、類、枚舉、注解
- @Target(ElementType.FIELD) // 屬性、枚舉的常量
- @Target(ElementType.METHOD) // 方法
- @Target(ElementType.PARAMETER) // 方法參數
- @Target(ElementType.CONSTRUCTOR) // 構造函數
- @Target(ElementType.LOCAL_VARIABLE)// 局部變量
- @Target(ElementType.ANNOTATION_TYPE)// 該注解使用在另一個注解上
- @Target(ElementType.PACKAGE) // 包
元注解@Retention:
- @Retention(RetentionPolicy.RUNTIME) //注解會在class字節碼文件中存在,jvm加載時可以通過反射獲取到該注解的內容
- @Retention(RetentionPolicy.CLASS) // 要在編譯時進行一些預處理操作。注解會在class文件中存在
- @Retention(RetentionPolicy.SOURCE) //做一些檢查性的操作,注解僅存在源碼級別,在編譯的時候丟棄該注解
生命周期:SOURCE < CLASS < RUNTIME
1、一般如果需要在運行時去動態獲取注解信息,用RUNTIME注解
2、要在編譯時進行一些預處理操作,如ButterKnife,用CLASS注解。注解會在class文件中存在,但是在運行時會被丟棄
3、做一些檢查性的操作,如@Override,用SOURCE源碼注解。注解僅存在源碼級別,在編譯的時候丟棄該注解
開發環境兼容
APT的使用
1、創建annotation的Module與自定義注解
@Target(ElementType.TYPE)//該注解作用在類之上
@Retention(RetentionPolicy.CLASS)//要在編譯時進行一些預處理操作。注解會在class文件中存在
public @interface ARouter {
//詳細路由路徑(必填)
String path();
// 路由組名(選填,如果開發者不填寫,可以從path中截取出來)
String group() default "";
}
2、創建注解處理器的Module
/ 超級實用:很多時候經常被墻,強烈推薦阿里云鏡像更新
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
apply plugin: 'java-library'
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
//auto-service是谷歌為我們提供的處理注解的服務,主要是注冊注解并對其生成一個文件
// As-3.4.1 + gradle5.1.1-all + auto-service:1.0-rc4
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控制臺輸出中文亂碼
tasks.withType(JavaCompile) {
options.encoding = "UTF-8"
}
// jdk編譯版本1.7
sourceCompatibility = "7"
targetCompatibility = "7"
import com.google.auto.service.AutoService;
import com.migill.annotation.ARouter;
import java.io.IOException;
import java.io.Writer;
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.Element;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;
import javax.tools.Diagnostic;
import javax.tools.JavaFileObject;
//AutoService是固定的寫法,用來注冊
@AutoService(Processor.class)
//允許/支持的注解處理器類型,讓注解處理器處理
@SupportedAnnotationTypes("com.migill.annotation.ARouter")
//指定DJK編譯版本
@SupportedSourceVersion(SourceVersion.RELEASE_7)
//注解處理器接收的參數
@SupportedOptions("content")
public class ARouterProcessor extends AbstractProcessor {
//操作Elememts工具類(類、函數、屬性都是Element)
private Elements elementUtils;
//type(類信息)工具類,包含用于操作TypeMirror的工具方法
private Types typeUtils;
//Messager用來報告錯誤,警告和其他提示信息
private Messager messager;
//文件生成器 類/資源,Filter用于創建新的源文件,class文件預計輔助文件
private Filer filer;
//主要用于一些初始化的操作,通過該方法的參數processingEnvironment可以獲取一些有用的工具類
@Override
public synchronized void init(ProcessingEnvironment processingEnvironment) {
super.init(processingEnvironment);
elementUtils = processingEnvironment.getElementUtils();
messager = processingEnvironment.getMessager();
filer = processingEnvironment.getFiler();
//通過processingEnvironment去獲取build.gradle傳過來的參數
String content = processingEnvironment.getOptions().get("content");
messager.printMessage(Diagnostic.Kind.NOTE,content);
}
/**
* 相當于main函數,開始處理注解
* 注解處理器的核心方法,處理具體的注解,生成Java文件
* @param set 使用了支持處理注解的節點集合(類 上面寫了注解)
* @param roundEnvironment 當前或是之前的運行環境,可以通過該對象查找找到的注解
* @return true 表示后續處理器不會再處理(已經處理完畢)
*/
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
if(set.isEmpty()) return false;
Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(ARouter.class);
for(Element element : elements) {
//通過類節點獲取包節點
String packageName = elementUtils.getPackageOf(element).getQualifiedName().toString();
//獲取簡單類名
String className = element.getSimpleName().toString();
messager.printMessage(Diagnostic.Kind.NOTE,"備注注解的類:"+packageName+"."+className);
// 最終想生成的類文件名
String finalClassName = className + "$$ARouter";
try{
JavaFileObject sourceFile = filer.createSourceFile(packageName+"."+finalClassName);
Writer writer = sourceFile.openWriter();
writer.write("package " + packageName + ";\n");
writer.write("public class " + finalClassName + " {\n");
writer.write("public static Class<?> findTargetClass(String path) {\n");
ARouter aRouter = element.getAnnotation(ARouter.class);
writer.write("if (path.equals(\"" + aRouter.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 false;
}
}
apply plugin: 'com.android.application'
android {
...
defaultConfig {
...
// 在gradle文件中配置選項參數值(用于APT傳參接收)
// 切記:必須寫在defaultConfig節點下
javaCompileOptions {
annotationProcessorOptions {
arguments = [content: 'hello apt']
}
}
}
...
}
dependencies {
...
//依賴注解
implementation project(":annotation")
//依賴注解處理器
annotationProcessor project(":compiler")
}
注解處理器寫完了,配置也完成了,現在編譯,就可以生成對應的文件了,如下圖,就是生成的文件與文件的內容
效果如下