大家好毅否,我是走川。只有十分鐘蝇刀,沒時(shí)間廢話了螟加!我要發(fā)車了!!@μ健甸昏!
所有Android開發(fā)一定都了解或使用過 Butterknife、Dragger等編譯期生成代碼的框架徐许,今天的學(xué)習(xí)就是入門 Annotation Processor Tools(注解處理工具)施蜜,在簡(jiǎn)單的學(xué)習(xí)之后,你能有以下收獲
1. 學(xué)習(xí)代碼輔助生成的方式
2. 成功通過APT生成以下代碼
public class MainActivity_SayHi{
public void sayHi(String content){
System.out.println(content);
}
}
好了雌隅,在開始之前翻默,我們先準(zhǔn)備好原材料:新建一個(gè)Android工程 (′?ω?`)
0x1
新建一個(gè) Java Module,并讓app工程依賴于這個(gè)lib
0x2 在這個(gè)lib庫中新增一個(gè)自定義注解
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface SayHi {
}
0x3 在app工程中MainActivity增加SayHi注解
@SayHi
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
}
0x4 在這個(gè)lib庫中新增一個(gè)自定義 注解處理器
注解處理器在使用前需要先向JVM注冊(cè),在module的META-INF目錄下新建services目錄恰起,并創(chuàng)建一個(gè)名為javax.annotation.processing.Processor的文件修械,在此文件內(nèi)逐行聲明注解處理器。同樣地检盼,此處需要聲明的也是處理器類的完全限定名肯污。
另一個(gè)簡(jiǎn)便的方法是使用Google提供的auto-services庫,在build.gradle中引入com.google.auto.service:auto-service:1.0-rc2吨枉,并在處理器類上添加注解@AutoService(Processor.class)蹦渣,auto-services也是一個(gè)注解處理器,會(huì)在編譯時(shí)為該module生成聲明文件貌亭。
@AutoService(Processor.class)
public class SayHiProcessor extends AbstractProcessor {
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> types = new HashSet<>();
types.add(SayHi.class.getCanonicalName());
return types;
}
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
/*roundEnv.getRootElements()會(huì)返回工程中所有的Class
在實(shí)際應(yīng)用中需要對(duì)各個(gè)Class先做過濾以提高效率柬唯,避免對(duì)每個(gè)Class的內(nèi)容都進(jìn)行掃描*/
for (Element element : roundEnvironment.getRootElements()) {
if (element.getAnnotation(SayHi.class) == null) { //過略掉沒有添加SayHi注解的class
return true;
}
String enclosingName = ((TypeElement) element).getQualifiedName().toString(); //獲取類的全限定類名
String packageName = enclosingName.substring(0, enclosingName.lastIndexOf('.')); //獲取包名
String clazzName = element.getSimpleName() + "_SayHi"; //生成類的名字
try {
JavaFileObject javaFileObject = processingEnv.getFiler().createSourceFile(clazzName); //創(chuàng)建文件
Writer writer = javaFileObject.openWriter();
//以下都是對(duì)文件的文件流操作,對(duì)下面的插入字符可以對(duì)照上面的生成代碼
PrintWriter printWriter = new PrintWriter(writer);
printWriter.println("package " + packageName + ";");
printWriter.println("\npublic class " + clazzName + "{");
printWriter.println("\n\tpublic void sayHi(String content){");
printWriter.println("\n\t\tSystem.out.println(content);");
printWriter.println("\n\t}");
printWriter.println("\n}");
printWriter.flush();
printWriter.close();
writer.close();
} catch (IOException e) {
e.printStackTrace();
}
}
return true;
}
}
0x5 添加APT插件
- 修改project的build.gradle
- 修改app的build.gradle
0x6 運(yùn)行結(jié)果
-
點(diǎn)擊 Build -> Rebuild Project
- 打開 build -> generated -> source -> debug 查看生成文件
參考鏈接:
http://www.reibang.com/p/f85e5212be55
https://yq.aliyun.com/articles/59493
https://www.2cto.com/kf/201608/536317.html