android apt編譯時期自動生成程式碼
阿新 • • 發佈：2019-02-17
最近新了一個架構，之前用dagger2時候，每當新增新activity還要修改或者新建component來完成dagger的注入。用了apt以後，在activity上標註一個註解就可以了。
本文章用最簡單的方法最直白的話 來搭建一個簡單的apt編譯時期生成程式碼
首先是新建一個android專案。就不說了
然後然後是新建立一個java的Module。注意是javalib。這個lib用來專門寫註解就好。為啥要單獨後面會說。
這個lib裡面就先放一個註解，叫TestAnno
import java.lang.annotation.ElementType;
import java.lang RetentionPolicy.CLASS表示編譯時候註解。。
你需要關係的就是@Target(ElementType.TYPE)這個type是類的註解，可以有方法的，屬性的等等。
然後這個javalib的gradle檔案要這麼寫
apply plugin: 'java'
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
}
sourceCompatibility = "1.7"
targetCompatibility = "1.7"
註解庫弄好了，在弄新建一個java lib 叫inject_comiler。這個是就是核心程式碼了，在編譯時候，執行這個個庫裡面的程式碼，然後 生成程式碼。這個工程 三個類。一個是註解註解處理器的核心。一個是定義生成java檔案的，方法拼接。還有一個就是常量包名類名了。
先看這個的gradle檔案
apply plugin: 'java'
sourceCompatibility = "1.7"
targetCompatibility = "1.7"
dependencies {
compile fileTree(include: ['*.jar'], dir: 'libs')
compile 'com.google.auto.service:auto-service:1.0-rc2'//谷歌的幫助我們快速實現註解處理器
compile project(':inject_annotation')//自己定義的註解的java lib
compile 'com.squareup:javapoet:1.7.0'//用來生成java檔案的，避免字串拼接的尷尬
}//這個註解是谷歌提供了，快速實現註解處理器，會幫你生成配置檔案啥的 。直接用就好
@AutoService(Processor.class)
public class ActivityInjectProcesser extends AbstractProcessor {
private Filer mFiler; //檔案相關的輔助類
private Elements mElementUtils; //元素相關的輔助類 許多元素
private Messager mMessager; //日誌相關的輔助類
private Map<String, AnnotatedClass> mAnnotatedClassMap;
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
mFiler = processingEnv.getFiler();
mElementUtils = processingEnv.getElementUtils();
mMessager = processingEnv.getMessager();
mAnnotatedClassMap = new TreeMap<>();
}
//這個方法是核心方法，在這裡處理的你的業務。檢測類別引數，勝場java檔案等
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
mAnnotatedClassMap.clear();
try {
processActivityCheck(roundEnv);
} catch (Exception e) {
e.printStackTrace();
error(e.getMessage());
}
for (AnnotatedClass annotatedClass : mAnnotatedClassMap.values()) {
try {
annotatedClass.generateActivityFile().writeTo(mFiler);
} catch (Exception e) {
error("Generate file failed, reason: %s", e.getMessage());
}
}
return true;
}
private void processActivityCheck(RoundEnvironment roundEnv) throws IllegalArgumentException, ClassNotFoundException {
//check ruleslass forName(String className
for (Element element : roundEnv.getElementsAnnotatedWith((Class<? extends Annotation>) Class.forName(TypeUtil.ANNOTATION_PATH))) {
if (element.getKind() == ElementKind.CLASS) {
getAnnotatedClass(element);
} else
error("ActivityInject only can use in ElementKind.CLASS");
}
}
private AnnotatedClass getAnnotatedClass(Element element) {
// tipe . can not use chines so ....
// get TypeElement element is class's --->class TypeElement typeElement = (TypeElement) element
// get TypeElement element is method's ---> TypeElement typeElement = (TypeElement) element.getEnclosingElement();
TypeElement typeElement = (TypeElement) element;
String fullName = typeElement.getQualifiedName().toString();
AnnotatedClass annotatedClass = mAnnotatedClassMap.get(fullName);
if (annotatedClass == null) {
annotatedClass = new AnnotatedClass(typeElement, mElementUtils, mMessager);
mAnnotatedClassMap.put(fullName, annotatedClass);
}
return annotatedClass;
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
//這個個方法返回你要處理註解的型別
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> types = new LinkedHashSet<>();
types.add(TypeUtil.ANNOTATION_PATH);
return types;
}
private void error(String msg, Object... args) {
mMessager.printMessage(Diagnostic.Kind.ERROR, String.format(msg, args));
}
private void log(String msg, Object... args) {
mMessager.printMessage(Diagnostic.Kind.NOTE, String.format(msg, args));
}
}然後是生成java檔案的輔助類
public class AnnotatedClass {
private TypeElement mTypeElement;//activity //fragmemt
private Elements mElements;
private Messager mMessager;//日誌列印
public AnnotatedClass(TypeElement typeElement, Elements elements, Messager messager) {
mTypeElement = typeElement;
mElements = elements;
this.mMessager = messager;
}
public JavaFile generateActivityFile() {
// build inject method
MethodSpec.Builder injectMethod = MethodSpec.methodBuilder(TypeUtil.METHOD_NAME)
.addModifiers(Modifier.PUBLIC)
.addParameter(TypeName.get(mTypeElement.asType()), "activity", Modifier.FINAL);
injectMethod.addStatement("android.widget.Toast.makeText" +"(activity, $S,android.widget.Toast.LENGTH_SHORT).show();", "from build");
//generaClass
TypeSpec injectClass = TypeSpec.classBuilder(mTypeElement.getSimpleName() + "$$InjectActivity")
.addModifiers(Modifier.PUBLIC)
.addMethod(injectMethod.build())
.build();
String packgeName = mElements.getPackageOf(mTypeElement).getQualifiedName().toString();
return JavaFile.builder(packgeName, injectClass).build();
}
}這裡就生成了一個 類名+$$的類，有一個方法叫inject引數是這個類本身，彈出一個toast。
最後一個就是一個字元常量類
public class TypeUtil {
public static final String METHOD_NAME = "inject";
public static final String ANNOTATION_PATH = "com.example.TestAnno";
}好了lib工程完畢。然後是主工程引用
首先是在工程的gradle裡面配置下apt
dependencies {
classpath 'com.android.tools.build:gradle:2.3.2'
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}然後在app的gradle裡面配置如下
apply plugin: 'com.neenbedankt.android-apt'
……
compile project(':inject_annotation')
apt project(':inject_comiler')這樣就行了。
注意是apt 。為什麼要新建立javalib。因為javalib不能在引用adnroidlib，。而註解處理器是javalib來完成，app裡面，可以這引用這2個，apt如果換成complie 會提示錯誤，但不會影響啥。
配置都好了，就是最後的使用了
總結構
在我們MainActivity 上面加上註解，使用下
@TestAnno
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
InjectActivity.inject(this);//呼叫build生成的類
}
}最後一個類就是我們的使用這個在執行時，呼叫生成build的類
public class InjectActivity {
private static final ArrayMap<String, Object> injectMap = new ArrayMap<>();
public static void inject(AppCompatActivity activity) {
String className = activity.getClass().getName();
try {
Object inject = injectMap.get(className);
if (inject == null) {
//載入build生成的類
Class<?> aClass = Class.forName(className + "$$InjectActivity");
inject = aClass.newInstance();
injectMap.put(className, inject);
}
//反射執行方法
Method m1 = inject.getClass().getDeclaredMethod("inject", activity.getClass());
m1.invoke(inject, activity);
} catch (Exception e) {
e.printStackTrace();
}
}
}
這個類用了反射的方式查找了指定類執行了指定方法。有一個map來快取，不用每次都重新反射。
當然你可可以不用反射，在建立build生成類的時候，實現一個介面，這裡直接強轉為介面，直接呼叫介面的方法也可以。這裡簡單一些用的反射
通過一個註解，就自動生成彈出toast的程式碼看下自動 生成的程式碼
public class MainActivity$$InjectActivity {
public void inject(final MainActivity activity) {
android.widget.Toast.makeText(activity, "from build",android.widget.Toast.LENGTH_SHORT).show();;
}
}最後看下執行效果。
