簡介
APT，就是Annotation Processing Tool 的簡稱，簡單來說就是通過編碼來動態(tài)得到解析Annotation的工具。一般分為兩類：
1.運行時注解：比如大名鼎鼎的retrofit就是用運行時注解，通過動態(tài)代理來生成網(wǎng)絡(luò)請求
2.編譯時注解：比如Dagger2, ButterKnife, EventBus3
代碼實現(xiàn)
這里我們要實現(xiàn)一個怎樣的功能呢？第一個就是給我們的activity添加一個@Flag，然后當我們編譯的時候就會生成一個java main函數(shù)。第二個就是我簡易版的butterknife。2個注解都是寫在用一個插件中。好了下面直接開始。
Annotation module
首先我們創(chuàng)建一個my_annotation的java module，這個項目只放我們的注解文件，不涉及到注解處理等其他邏輯，關(guān)于注解處理我們會新建一個module來處理。項目結(jié)構(gòu)如下：
其中build.gradle中基本不用修改，保持默認的配置就可以，如下：
Flag注解
就是這么簡單，關(guān)于注解中元注解的解釋請參考我的另一篇文章：元注解簡介
關(guān)于注解module就到這了。
注解處理 module
首先我們創(chuàng)建一個my_compiler的java module。項目結(jié)構(gòu)如下：
build.gradle的配置如下：
簡單解釋下幾個dependencies
auto-service:這是google推出的方便我們編寫annotation插件，在沒有這個這個庫之前，我們需要對我們的插件做很多的配置才能使用，有了這個庫以后就方便多了，下文會看到怎么用，這里就不介紹了。官網(wǎng)
javapoet:這是方便我們在編譯時動態(tài)生成class文件的，下文也會有具體怎么使用，這里不做過多解釋。官網(wǎng)
關(guān)于上面2個庫大家感興趣可以去查找相關(guān)資料進行進一步了解。下面我們看下真正的注解處理類：
/**
* @author Jin
*/
//來自auto-service 只要添加這個注解以后就不需要做其他配置，現(xiàn)在已經(jīng)可以在項目中直接使用了
@AutoService(Processor.class)
public class FlagAnnotationProcessor extends AbstractProcessor {
/**
* getSupportedSourceVersion()方法返回 Java 版本 默認為Java6
*
* @return Java 版本
*/
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
/**
* 返回要處理的注解的結(jié)合 這里只處理RouterAnnotion類型的注解
*
* @return
*/
@Override
public Set<String> getSupportedAnnotationTypes() {
LinkedHashSet<String> types = new LinkedHashSet<>();
types.add(Flag.class.getCanonicalName());
return types;
}
/**
* 注解的具體處理類
*
* @param annotations
* @param roundEnv
* @return
*/
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
//來自javapoet 動態(tài)生成方法
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();
//來自javapoet 動態(tài)生成類
TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(main)
.build();
//來自javapoet 動態(tài)生成文件
JavaFile javaFile = JavaFile.builder("com.jin.helloworld", helloWorld)
.build();
try {
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
return true;
}
}
注解處理類已經(jīng)寫好了，下面我們看下怎么關(guān)聯(lián)到我們的項目中。
注解使用
AndroidStudio3.0使用annotationProcessor來處理注解。
添加我們的@Flag注解。ok。大功告成，下面重新編譯（rebuild project）一下我們的項目，就會在build目錄下看到自動生成的代碼了。
你可能會說，生成一個HelloWorld main函數(shù)并木有什么卵用啊，是的，但是你起碼掌握了最基本的關(guān)于Annotation項目的創(chuàng)建、編譯、使用了是不是，麻雀雖小但是五臟俱全啊。
下面進入我們的另一個demo，簡易版butterknife。
簡易版butterknife
下面我直接添上注解和處理代碼(相關(guān)解釋會在注釋中)：
DIAnnotationProcessor
@AutoService(Processor.class)
public class DIAnnotationProcessor extends AbstractProcessor {
private Filer mFiler;
private Elements elementUtils;
/**
* init()方法可以初始化拿到一些使用的工具，
* 比如文件相關(guān)的輔助類 Filer;元素相關(guān)的輔助類Elements;日志相關(guān)的輔助類Messager;
*
* @param processingEnv
*/
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
mFiler = processingEnv.getFiler();
elementUtils = processingEnv.getElementUtils();
}
/**
* getSupportedSourceVersion()方法返回 Java 版本 默認為Java6
*
* @return Java 版本
*/
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
/**
* 返回要處理的注解的結(jié)合 這里只處理RouterAnnotion類型的注解
*
* @return
*/
@Override
public Set<String> getSupportedAnnotationTypes() {
LinkedHashSet<String> types = new LinkedHashSet<>();
types.add(BindActivity.class.getCanonicalName());
return types;
}
/**
* 注解的具體處理類
*
* @param annotations
* @param roundEnv
* @return
*/
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
System.out.println("DIAnnotationProcessor");
//得到所有被Bind添加注解的類
Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(BindActivity.class);
for (Element element : elements) {
//強制轉(zhuǎn)換成TypeElement 判斷是否是Class
TypeElement typeElement = (TypeElement) element;
//得到typeElement類中所有成員變量和成員方法
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) {
BindMyView bindView = item.getAnnotation(BindMyView.class);
if (bindView == null) {
continue;
}
bindViewMethodSpecBuilder.addStatement(String.format("activity.%s = (%s) activity.findViewById(%s)", item.getSimpleName(), ClassName.get(item.asType()).toString(), bindView.value()));
}
TypeSpec typeSpec = TypeSpec.classBuilder("DI" + element.getSimpleName())
.superclass(TypeName.get(typeElement.asType()))
.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();
}
}
DI Annotation使用
注意此時一定要先rebuild project生成如下文件
然后在我們的代碼中寫上
這里ButterKnife.bind(this)是用來對比，請大家注意， DIMainActivity.bindView(this)才是我們直接生成的文件。
調(diào)試（AndroidStudio3.0）已解決
如果過你也像我一樣按照網(wǎng)上的教程操作，但是始終報錯：Unable to open debugger port (localhost:5006): java.net.ConnectException "Connection refused: connect"
配置如下：
上面的配置代碼記得在全局的gradle.properties中添加 該文件一般位于C:\Users\Jin.gradle下 如果沒有親手動創(chuàng)建
控制臺輸入：gradlew --daemon
然后
點擊調(diào)試
