在组件化开发过程中，我们经常会遇到一个问题，一些全局变量如何共享，如Application的全局功效，还有在应用初始化过程中能否同时对组件进行初始化操作。诚然，通过每次使用手动编写，或者维护一个组件初始化表通过反射方式进行动态初始化操作都是可以的。那有没有一个更效率更方便的方式实现呢，答案是有多，接下来我们就通过Demo了解APT的使用及组件初始化的实现逻辑。
一 创建项目
首先我们先创建一个MyAnnotation的项目。同时添加两个Java-lib的Module。
其中AnnotationLib作为注解类。ProcessLib作为解析类。
-w461
二 创建注解
然后我们在AnnotationLib下添加注解类InitAppliation 代码如下
package kt.dongdong.annotationlib;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface InitAppliation {
}
其中元注解@Target和@Retention分别表示作用对象为class，留存范围为源码阶段。其他相关参数意义可以自行查询。
这样我们注解就完成了，接下来我们处理对于多解析类。
解析配置
在创建解析类前，我们先在ProcessLib中做一些相关引用。
implementation project(":AnnotationLib")
implementation 'com.google.auto.service:auto-service:1.0-rc4'
然后我们需要创建一个解析类InitProcess。并在类上添加注解与父类。
@AutoService(Processor.class)
public class InitProcess extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
return false;
}
}
其中@AutoService表示注册此解析类，只有注册了才能用。
然后继承AbstractProcessor并实现相关方法。
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
这个方法返回执行的java版本，一般直接返回SourceVersion.latestSupported()即可，当然也可以指定版本如：SourceVersion.RELEASE_7则定义为java7.
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> setTypes = new HashSet<>();
setTypes.add(InitAppliation.class.getCanonicalName());
return setTypes;
}
getSupportedAnnotationTypes返回需要处理的注解的集合。其中InitAppliation.class.getCanonicalName()表示拿到注解类的完整路径。
ps：以上两个方法配置都可以用注解的形式实现。
接下来我们就需要实现自动生成类的部分了
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
// 参数annotations表示需要处理的注解的集合
// 参数roundEnv通过getElementsAnnotatedWith方法可以获取对应使用注解的类
if (annotations.isEmpty()) {
return false;
}
for (TypeElement typeElement : annotations) {
//判断是否是要解析的注解类
if (typeElement.toString().equals(InitApplication.class.getCanonicalName())) {
//获取对应列表
Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(typeElement);
StringBuilder strImpory = new StringBuilder();
StringBuilder strNew = new StringBuilder();
for (Element element : elements) {
strImpory.append("import " + element.toString() + ";\n");
strNew.append(element.getSimpleName() + " "
+ element.getSimpleName().toString() + "C = new "
+ element.getSimpleName() + "();\n");
strNew.append(element.getSimpleName().toString() + "C.init(application);\n");
}
try {
//通过processingEnv.getFiler()创建类文件并写入。
JavaFileObject fileObject = processingEnv.getFiler().createSourceFile("kt.dongdong.annotationlib.AllInit");
Writer writer = fileObject.openWriter();
writer.write("package kt.dongdong.annotationlib;\n\n");
writer.write("import android.app.Application;\n");
writer.write(strImpory.toString() + "\n\n\n");
writer.write("public class AllInit{\n\n");
writer.write("public AllInit(Application application){\n");
writer.write(strNew.toString());
writer.write("}\n}\n");
writer.close();//注意需要关闭流 不然文件没有内容
} catch (IOException e) {
e.printStackTrace();
}
}
}
return false;
}
- 在上面代码中我写了些注释，主要流程是：
- 通过roundEnv.getElementsAnnotatedWith（）获取使用了对应注解多所有类信息。
- 通过循环这些类编写对应import和初始化的代码串。
- 通过processingEnv.getFiler().createSourceFile（）创建指定名称的类文件。
- 然后开启流编写包名，引用，类名，初始化并调用方法等信息
- 然后关闭流 writer.close()很重要 不然生成的类没有内容。
生成文件
先在App项目中添加引用
implementation project(":AnnotationLib")
annotationProcessor project(":ProcessLib")
这里要注意的是解析Lib引用使用annotationProcessor关键字
创建AppliationA，AppliationB类并添加注解。然后执行Build 》ReBuild Project。
-w412
便能在该目录下生成文件了。
文件内容为我们在解析类里面写入的内容
package kt.dongdong.annotationlib;
import android.app.Application;
import kt.dongdong.myannotation.AppliationA;
import kt.dongdong.myannotation.AppliationB;
public class AllInit{
public AllInit(Application application){
AppliationA AppliationAC = new AppliationA();
AppliationAC.init(application);
AppliationB AppliationBC = new AppliationB();
AppliationBC.init(application);
}
}
PS：这里有几点需要注意的
如果你的Gradle版本高于5，也许会因为不兼容无法生成类文件。这时候需要在注解类的Lib里面添加下面的引用
implementation 'com.google.auto.service:auto-service:1.0-rc4'
annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'
或者你可以把gradle版本降低至4.6 ，这时候生成类的地址变为build>generated>source>apt下
使用方式
在上面我们知道可以生成对于的类文件，但是在开发中我们未编译时又如何去使用对应的生成类呢。这时候我们就需要通过一个中间类以反射的形式进行初始化了。
package kt.dongdong.myannotation;
import android.app.Application;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
public class TestAppInit {
public static void init(Application application) {
try {
Class<?> clazz = Class.forName("kt.dongdong.annotationlib.AllInit");
Class[] parameterTypes = {Application.class};
Constructor constructor = clazz.getConstructor(parameterTypes);
Object object = constructor.newInstance(application);
} catch (ClassNotFoundException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InstantiationException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
}
其中Class.forName的类名就是我们在解析类里生成文件的名称。
然后在Application中进行调研
public class App extends Application {
@Override
public void onCreate() {
super.onCreate();
TestAppInit.init(this);
}
}
运行起来后查看日志
-w551
OK 致此通过注解形式初始化组件与APT的使用方式大致了解了就。
网友评论