前言
在前面的Android6.0權限處理不再復雜文章中，介紹過一個開源框架PermissionsDispatcher(權限調度者)，在使用這個框架提供的@RuntimePermissions Annotation標簽時，Make Project會自動在add -> build -> intermediates -> classes -> debug -> 包名路徑 -> 文件名下，會生成一個名字為【文件名 + PermissionsDispatcher】的class文件，圖片如下：
那今天的主要內容就來講一下，我們實現在編輯器編譯時，怎么上述效果去動態生成class文件。
Annotation（注解）
現在越來越多的開源框架使用的是Annotation來進行注解配置，我在前面的一篇文章有過簡單的介紹注解的配置與使用，請前往查看Android進階之Annotation(注解)的使用文章進行了解。
如果了解過Annotation，至少知道有這樣的一個知識點，那也可以繼續往下看。
我們今天就是更深入的講一下注解的內容，運用注解APT中的AbstractProcessor來實現我們想要的效果。
1，創建項目名為【myProcessor】的空項目，如下：
2，在項目路徑下，創建名為【processor】的Module，如下：
PS：
一定要是【Java Library】，后面編譯的時候，會直接打成組件jar包，才能提供使用。
3，查看processor中的build.gradle文件
apply plugin: 'java'
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
}
sourceCompatibility = "1.7"
targetCompatibility = "1.7"
據了解，目前Android對Java 8的語言特性支持并不完善，所以在編譯的時候可能會有問題，這里使用的是1.7的版本，建議使用。
4，模擬PermissionsDispatcher創建注解
在processor模塊中，創建名為【RuntimePermissions】的注解，如下：
代碼如下：
package com.example;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 運行時權限 2017/4/19 10:55
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface RuntimePermissions {
}
5，繼承AbstractProcessor，創建注解處理器，如下：
代碼如下：
package com.example;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;
/**
* 在編譯時生成代碼 2017/4/19 11:02
*/
public class PermissionsProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> set,
RoundEnvironment roundEnvironment) {
return true;
}
}
6，指定注解處理器處理的注解類型，如下：
package com.example;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
/**
* 在編譯時生成代碼 2017/4/19 11:02
*/
@SupportedAnnotationTypes("com.example.RuntimePermissions")
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class PermissionsProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> set,
RoundEnvironment roundEnvironment) {
// 在這里做處理，例如生成Java文件
return true;
}
}
PS：
當編譯時，系統會掃描AbstractProcessor下的所有子類，然后回調其中的process方法。
7，在process中，生成Java代碼，如下：
package com.example;
import java.io.IOException;
import java.io.Writer;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.JavaFileObject;
/**
* 在編譯時生成代碼 2017/4/19 11:02
*/
@SupportedAnnotationTypes("com.example.RuntimePermissions")
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class PermissionsProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> set,
RoundEnvironment roundEnvironment) {
/**
* 循環有使用@RuntimePermissions的類 2017/4/19 11:10
*/
for (Element element : roundEnvironment.getElementsAnnotatedWith(RuntimePermissions.class)) {
String objectType = element.getSimpleName().toString(); // 類名 2017/4/19 11:11
StringBuilder builder = new StringBuilder()
.append("package com.example.chenchubin.myprocessor;\n\n")
.append("public class " + objectType + "PermissionsDispatcher" + " {\n\n")
.append("\tpublic String withCheck() {\n")
.append("\t\treturn \"");
builder.append(objectType + "PermissionsDispatcher").append(" create successfully!!!\\n");
builder.append("\";\n")
.append("\t}\n")
.append("}\n");
// 寫入Java文件 2017/4/19 11:10
try {
JavaFileObject source = processingEnv.getFiler()
.createSourceFile("com.example.chenchubin.myprocessor." + objectType + "PermissionsDispatcher");
Writer writer = source.openWriter();
writer.write(builder.toString());
writer.flush();
writer.close();
} catch (IOException e) {
}
}
return true;
}
}
8，配置注解處理器的資源服務
在processor -> src -> main中，創建resources文件夾，在其中再創建META-INF.services文件夾。
在services文件夾下，創建名字為【javax.annotation.processing.Processor】的文件，內容為注解處理器的絕對路徑，因為這樣做的目的是為了在編譯時，告知注解處理器的位置所在，如下：
processor的最后目錄結構如下：
9，配置APT插件
打開Top-Level的build.gradle文件，配置如下信息：
dependencies {
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
打開app:build.gradle文件，配置如下信息：
apply plugin: 'com.neenbedankt.android-apt'
10，編譯processor.jar包
processor編譯后，在build -> libs下面會生成processor.jar文件，將該jar復制到app -> libs目錄，重新編譯即可使用。
PS：
或者在app:build.gradle文件，配置如下信息：
// 創建復制jar包的任務 2017/4/19 11:14
task processorTask(type: Exec) {
commandLine 'cp', '../processor/build/libs/processor.jar', 'libs/'
}
// 構建時，執行 2017/4/19 11:14
processorTask.dependsOn(':processor:build')
preBuild.dependsOn(processorTask)
上面的代碼就是先將processor.jar包復制到libs目錄下后，再編譯。
11，使用@RuntimePermissions注解
在MainActivity中，使用@RuntimePermissions注解，重新編譯即可，代碼如下：
package com.example.chenchubin.myprocessor;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import com.example.MainActivityPermissionsDispatcher;
import com.example.RuntimePermissions;
@RuntimePermissions
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
}
PS，重新編譯后，查看如下：
MainActivityPermissionsDispatcher文件代碼如下：
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.example.chenchubin.myprocessor;
public class MainActivityPermissionsDispatcher {
public MainActivityPermissionsDispatcher() {
}
public String withCheck() {
return "MainActivityPermissionsDispatcher create successfully!!!\n";
}
}
在MainActivity.onCreate中使用，如下：
@RuntimePermissions
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
System.out.println("====== " + new MainActivityPermissionsDispatcher().withCheck());
}
}
到這里，所有的配置以及代碼就都寫好了，如果按照上面的流程，DEMO應該是沒問題的，但有另一個問題就是，我們經常會使用到調試，那我們怎么在使用processor.jar的情況下，進入調試狀態呢？
12，調試Processor代碼
請參考Debugging-an-Annotator-Processor-in-your-project。
創建Remote，選擇Edit Configurations，如下：
選擇【+】-> 【Remote】，如下：
創建【Remote】，配置信息全部默認，如下：
打開Terminal終端，輸入./gradlew --stop，先關閉gradle daemon，信息如下：
再啟動daemon后臺線程，代碼如下：
./gradlew --no-daemon -Dorg.gradle.debug=true :app:clean :app:compileDebugJavaWithJavac
運行結果如下：
選擇需要調試的【PermissionsProcessor】類，打上斷點，如下：
選擇【Processor】后，點擊Debug啟動，如下：
成功啟動結果如下：
稍等10秒左右，會進入調試模式，跳轉到打斷點處，如下：
這樣子就可以進行正常的調試了。
總結
到這里，我們就已經正常的模擬出PermissionsDispatcher，在使用@RuntimePermissions注解時，進行編譯后，會自動生成【類名 + PermissionsDispatcher】的代碼文件了。
其實上面的生成Java代碼用的JavaFileObject類是比較簡單的，現在比較好用的是JavaPoet這個框架，如果需要生成比較復雜的代碼的話，建議使用這個框架。例如在PermissionsDispatcher中，它就是使用該框架生成的類，在如下的目錄中：
有興趣的朋友可以前往PermissionsDispatcher--processor進行查看源碼，不過作者是使用kotlin寫這塊代碼的，所以。。。想讀懂的話，那就得去學一下kotlin的基本語法了。
好了，對于注解APT的AbstractProcessor就介紹到這里了，希望這篇文章對你有所幫助。
謝謝支持哈~~~
