Android架构师-组件化-组件化APT生成路由Group和Path文件 7
上文 即组件化文章6中，我们遗留的问题是在app中通过RouterManager去add每一个Activity，这样操作很耗时，之前我们也说过，可以在ARouterProcessor，即注解处理器中动态扫描到添加了ARouter注解的文件，然后在process中动态解析，我们现在主要来完成这一步操作
目标：我们需要完成以下两个文件的生成
1：首先我们需要知道我们要通过注解处理器生成的目标文件
/**
* 路由组Group加载数据接口
*/
public interface ARouterLoadGroup {
/**
* 加载路由组Group数据
* 比如："app", ARouter$$Path$$app.class（实现了ARouterLoadPath接口）
*
* @return key:"app", value:"app"分组对应的路由详细对象类
*/
Map> loadGroup();
} 模拟ARouter路由组文件 ，实现了ARouterLoadGroup接口 ,在Map集合中添加对应的ARouter$$Path$$xx.class文件
/**
* 模拟ARouter路由器的组文件
*/
public class ARouter$$Group$$order implements ARouterLoadGroup {
@Override
public Map> loadGroup() {
Map> groupMap = new HashMap<>();
groupMap.put("order", ARouter$$Path$$order.class);
return groupMap;
}
} 还有ARouterLoadPath，
/**
* 路由组Group对应的详细Path加载数据接口
* 比如：app分组对应有哪些类需要加载
*/
public interface ARouterLoadPath {
/**
* 加载路由组Group中的Path详细数据
* 比如："app"分组下有这些信息：
*
* @return key:"/app/MainActivity", value:MainActivity信息封装到RouterBean对象中
*/
Map loadPath();
} 路由族文件继承自ARouterLoadpath文件
/**
* 模拟ARouter路由器的组文件，对应的路径文件
*/
public class ARouter$$Path$$order implements ARouterLoadPath {
@Override
public Map loadPath() {
Map pathMap = new HashMap<>();
pathMap.put("/order/Order_MainActivity",
RouterBean.create(RouterBean.Type.ACTIVITY, Order_MainActivity.class,
"/order/Order_MainActivity", "order"));
return pathMap;
}
} 那么组名是怎么传到注解处理器中的呢？
我们前面讲过，是通过build.gradle
还有一个问题，我们所有生成的APT文件都放到哪里呢？
我们建一个apt的包，把这些文件都归类到apt的包下面。
所以我们需要做两件事，第一件事通过build.gradle传子模块名（Group名字）
第二件事把apt生成的类文件归类到另外一个包下面来。
1：在每个子模块的build.gradle中将这两个参数传过来
首先在项目的config.gradle中定义apt类文件生成路径
// 包名，用于存放APT生成的类文件
packageNameForAPT = "com.netease.modular.apt"
// 在gradle文件中配置选项参数值（用于APT传参接收）
// 切记：必须写在defaultConfig节点下
javaCompileOptions {
annotationProcessorOptions {
arguments = [moduleName: project.getName(), packageNameForAPT: packageNameForAPT]
}
}第一个moduleName：子模块名字
第二个：apt生成在哪个包下面
我们在arouter_compiler中的常量类中添加两个常量
// 每个子模块的模块名
public static final String MODULE_NAME = "moduleName";
// 包名，用于存放APT生成的类文件
public static final String APT_PACKAGE = "packageNameForAPT";最后生成的效果如下：
2：我们需要在注解处理器中获取这两个参数
@Override
public synchronized void init(ProcessingEnvironment processingEnvironment) {
super.init(processingEnvironment);
elementUtils = processingEnvironment.getElementUtils();
typeUtils = processingEnvironment.getTypeUtils();
messager = processingEnvironment.getMessager();
filer = processingEnvironment.getFiler();
// 通过ProcessingEnvironment去获取对应的参数
Map options = processingEnvironment.getOptions();
if (!EmptyUtils.isEmpty(options)) {
moduleName = options.get(Constants.MODULE_NAME);
packageNameForAPT = options.get(Constants.APT_PACKAGE);
// 有坑：Diagnostic.Kind.ERROR，异常会自动结束，不像安卓中Log.e
messager.printMessage(Diagnostic.Kind.NOTE, "moduleName >>> " + moduleName);
messager.printMessage(Diagnostic.Kind.NOTE, "packageNameForAPT >>> " + packageNameForAPT);
}
// 必传参数判空（乱码问题：添加java控制台输出中文乱码）
if (EmptyUtils.isEmpty(moduleName) || EmptyUtils.isEmpty(packageNameForAPT)) {
throw new RuntimeException("注解处理器需要的参数moduleName或者packageName为空，请在对应build.gradle配置参数");
}
} 我们拿到具体的参数后，开始处理数据，通过APT+JavaPoet动态生成apt类文件
/**
* 相当于main函数，开始处理注解
* 注解处理器的核心方法，处理具体的注解，生成Java文件
*
* @param set 使用了支持处理注解的节点集合
* @param roundEnvironment 当前或是之前的运行环境,可以通过该对象查找的注解。
* @return true 表示后续处理器不会再处理（已经处理完成）
*/
@Override
public boolean process(Set set, RoundEnvironment roundEnvironment) {
// 一旦有类之上使用@ARouter注解
if (!EmptyUtils.isEmpty(set)) {
// 获取所有被 @ARouter 注解的 元素集合
Set elements = roundEnvironment.getElementsAnnotatedWith(ARouter.class);
if (!EmptyUtils.isEmpty(elements)) {
// 解析元素
try {
parseElements(elements);
return true;
} catch (IOException e) {
e.printStackTrace();
}
}
// 坑：必须写返回值，表示处理@ARouter注解完成
return true;
}
return false;
}
// 解析所有被 @ARouter 注解的 类元素集合
private void parseElements(Set elements) throws IOException {
// 通过Element工具类，获取Activity、Callback类型
TypeElement activityType = elementUtils.getTypeElement(Constants.ACTIVITY);
// 显示类信息（获取被注解节点，类节点）这里也叫自描述 Mirror
TypeMirror activityMirror = activityType.asType();
// 遍历节点
for (Element element : elements) {
// 获取每个元素类信息，用于比较
TypeMirror elementMirror = element.asType();
messager.printMessage(Diagnostic.Kind.NOTE, "遍历元素信息：" + elementMirror.toString());
// 获取每个类上的@ARouter注解中的注解值
ARouter aRouter = element.getAnnotation(ARouter.class);
// 路由详细信息，最终实体封装类
RouterBean bean = new RouterBean.Builder()
.setGroup(aRouter.group())
.setPath(aRouter.path())
.setElement(element)
.build();
// 高级判断：ARouter注解仅能用在类之上，并且是规定的Activity
// 类型工具类方法isSubtype，相当于instance一样
if (typeUtils.isSubtype(elementMirror, activityMirror)) {
bean.setType(RouterBean.Type.ACTIVITY);
} else {
// 不匹配抛出异常，这里谨慎使用！考虑维护问题
throw new RuntimeException("@ARouter注解目前仅限用于Activity类之上");
}
// 赋值临时map存储，用来存放路由组Group对应的详细Path类对象
valueOfPathMap(bean);
}
// routerMap遍历后，用来生成类文件
// 获取ARouterLoadGroup、ARouterLoadPath类型（生成类文件需要实现的接口）
TypeElement groupLoadType = elementUtils.getTypeElement(Constants.AROUTE_GROUP); // 组接口
TypeElement pathLoadType = elementUtils.getTypeElement(Constants.AROUTE_PATH); // 路径接口
// 第一步：生成路由组Group对应详细Path类文件，如：ARouter$$Path$$app
createPathFile(pathLoadType);
// 第二步：生成路由组Group类文件（没有第一步，取不到类文件），如：ARouter$$Group$$app
createGroupFile(groupLoadType, pathLoadType);
}建立一个临时map的存储，用来存放路由组Group对应的详细Path类对象，
//例如：
第一次扫描到一个文件:/app/MainActivity
此时的List
第二次扫描到一个文件/app/MySetActivity,此时List
/**
* 赋值临时map存储，用来存放路由组Group对应的详细Path类对象，生成路由路径类文件时遍历
*
* @param bean 路由详细信息，最终实体封装类
*/
private void valueOfPathMap(RouterBean bean) {
if (checkRouterPath(bean)) {
messager.printMessage(Diagnostic.Kind.NOTE, "RouterBean >>> " + bean.toString());
// 开始赋值Map
List routerBeans = tempPathMap.get(bean.getGroup());
// 如果从Map中找不到key为：bean.getGroup()的数据，就新建List集合再添加进Map
if (EmptyUtils.isEmpty(routerBeans)) {
routerBeans = new ArrayList<>();
routerBeans.add(bean);
tempPathMap.put(bean.getGroup(), routerBeans);
} else { // 找到了key，直接加入List集合
routerBeans.add(bean);
}
} else {
messager.printMessage(Diagnostic.Kind.ERROR, "@ARouter注解未按规范配置，如：/app/MainActivity");
}
} 这段是为了防止项目合作过程中出现ARouter注解填写不规范的情况
/**
* 校验@ARouter注解的值，如果group未填写就从必填项path中截取数据
*
* @param bean 路由详细信息，最终实体封装类
*/
private boolean checkRouterPath(RouterBean bean) {
String group = bean.getGroup();
String path = bean.getPath();
// @ARouter注解中的path值，必须要以 / 开头（模仿阿里Arouter规范）
if (EmptyUtils.isEmpty(path) || !path.startsWith("/")) {
messager.printMessage(Diagnostic.Kind.ERROR, "@ARouter注解中的path值，必须要以 / 开头");
return false;
}
// 比如开发者代码为：path = "/MainActivity"，最后一个 / 符号必然在字符串第1位
if (path.lastIndexOf("/") == 0) {
// 架构师定义规范，让开发者遵循
messager.printMessage(Diagnostic.Kind.ERROR, "@ARouter注解未按规范配置，如：/app/MainActivity");
return false;
}
// 从第一个 / 到第二个 / 中间截取，如：/app/MainActivity 截取出 app 作为group
String finalGroup = path.substring(1, path.indexOf("/", 1));
// @ARouter注解中的group有赋值情况
if (!EmptyUtils.isEmpty(group) && !group.equals(moduleName)) {
// 架构师定义规范，让开发者遵循
messager.printMessage(Diagnostic.Kind.ERROR, "@ARouter注解中的group值必须和子模块名一致！");
return false;
} else {
bean.setGroup(finalGroup);
}
return true;
}最后从临时Map集合中开始通过JavaPoet去生成
ARouter$$Path$$xx (--->ARouter$$Path$$app ) // APT生成的路由组Group类文件名
public static final String GROUP_FILE_NAME = "ARouter$$Group$$";
// APT生成的路由组Group对应的详细Path类文件名
public static final String PATH_FILE_NAME = "ARouter$$Path$$"; /**
* 生成路由组Group对应详细Path，如：ARouter$$Path$$app
*
* @param pathLoadType ARouterLoadPath接口信息
*/
private void createPathFile(TypeElement pathLoadType) throws IOException {
// 判断是否有需要生成的类文件
if (EmptyUtils.isEmpty(tempPathMap)) return;
TypeName methodReturns = ParameterizedTypeName.get(
ClassName.get(Map.class), // Map
ClassName.get(String.class), // Map
);
// 遍历分组，每一个分组创建一个路径类文件，如：ARouter$$Path$$app
for (Map.Entry> entry : tempPathMap.entrySet()) {
// 方法配置：public Map loadPath() {
MethodSpec.Builder methodBuidler = MethodSpec.methodBuilder(Constants.PATH_METHOD_NAME) // 方法名
.addAnnotation(Override.class) // 重写注解
.addModifiers(Modifier.PUBLIC) // public修饰符
.returns(methodReturns); // 方法返回值
// 遍历之前：Map pathMap = new HashMap<>();
//StringFormat形式
methodBuidler.addStatement("$T<$T, $T> $N = new $T<>()",
ClassName.get(Map.class),
ClassName.get(String.class),
ClassName.get(RouterBean.class),
Constants.PATH_PARAMETER_NAME,
HashMap.class);
// 一个分组，如：ARouter$$Path$$app。有很多详细路径信息，如：/app/MainActivity、/app/OtherActivity
List pathList = entry.getValue();
// 方法内容配置（遍历每个分组中每个路由详细路径）
for (RouterBean bean : pathList) {
// 类似String.format("hello %s net163 %d", "net", 163)通配符
// pathMap.put("/app/MainActivity", RouterBean.create(
// RouterBean.Type.ACTIVITY, MainActivity.class, "/app/MainActivity", "app"));
methodBuidler.addStatement(
"$N.put($S, $T.create($T.$L, $T.class, $S, $S))",
Constants.PATH_PARAMETER_NAME, // pathMap.put
bean.getPath(), // "/app/MainActivity"
ClassName.get(RouterBean.class), // RouterBean
ClassName.get(RouterBean.Type.class), // RouterBean.Type
bean.getType(), // 枚举类型：ACTIVITY
ClassName.get((TypeElement) bean.getElement()), // MainActivity.class
bean.getPath(), // 路径名
bean.getGroup() // 组名
);
}
// 遍历之后：return pathMap;
methodBuidler.addStatement("return $N", Constants.PATH_PARAMETER_NAME);
// 最终生成的类文件名
String finalClassName = Constants.PATH_FILE_NAME + entry.getKey();
messager.printMessage(Diagnostic.Kind.NOTE, "APT生成路由Path类文件：" +
packageNameForAPT + "." + finalClassName);
// 生成类文件：ARouter$$Path$$app
JavaFile.builder(packageNameForAPT, // 包名
TypeSpec.classBuilder(finalClassName) // 类名
.addSuperinterface(ClassName.get(pathLoadType)) // 实现ARouterLoadPath接口
.addModifiers(Modifier.PUBLIC) // public修饰符
.addMethod(methodBuidler.build()) // 方法的构建（方法参数 + 方法体）
.build()) // 类构建完成
.build() // JavaFile构建完成
.writeTo(filer); // 文件生成器开始生成类文件
// 非常重要一步！！！！！路径文件生成出来了，才能赋值路由组tempGroupMap
//例如：tempGroupMap.put("app","ARouter$$Path$$app");
tempGroupMap.put(entry.getKey(), finalClassName);
}
}
.writeTo(filer); // 文件生成器开始生成类文件
} 我们可以看到，在生成Path路径集合后，又向临时的group集合中添加了数据,然后开始创建路由group文件
/**
* 生成路由组Group文件，如：ARouter$$Group$$app
*
* @param groupLoadType ARouterLoadGroup接口信息
* @param pathLoadType ARouterLoadPath接口信息
*/
private void createGroupFile(TypeElement groupLoadType, TypeElement pathLoadType) throws IOException {
// 判断是否有需要生成的类文件
if (EmptyUtils.isEmpty(tempGroupMap) || EmptyUtils.isEmpty(tempPathMap)) return;
TypeName methodReturns = ParameterizedTypeName.get(
ClassName.get(Map.class), // Map
ClassName.get(String.class), // Map
// 某某Class是否属于ARouterLoadPath接口的实现类
ParameterizedTypeName.get(ClassName.get(Class.class),
WildcardTypeName.subtypeOf(ClassName.get(pathLoadType)))
);
// 方法配置：public Map> loadGroup() {
MethodSpec.Builder methodBuidler = MethodSpec.methodBuilder(Constants.GROUP_METHOD_NAME) // 方法名
.addAnnotation(Override.class) // 重写注解
.addModifiers(Modifier.PUBLIC) // public修饰符
.returns(methodReturns); // 方法返回值
// 遍历之前：Map> groupMap = new HashMap<>();
methodBuidler.addStatement("$T<$T, $T> $N = new $T<>()",
ClassName.get(Map.class),
ClassName.get(String.class),
ParameterizedTypeName.get(ClassName.get(Class.class),
WildcardTypeName.subtypeOf(ClassName.get(pathLoadType))),
Constants.GROUP_PARAMETER_NAME,
HashMap.class);
// 方法内容配置
for (Map.Entry entry : tempGroupMap.entrySet()) {
// 类似String.format("hello %s net163 %d", "net", 163)通配符
// groupMap.put("main", ARouter$$Path$$app.class);
methodBuidler.addStatement("$N.put($S, $T.class)",
Constants.GROUP_PARAMETER_NAME, // groupMap.put
entry.getKey(),
// 类文件在指定包名下
ClassName.get(packageNameForAPT, entry.getValue()));
}
// 遍历之后：return groupMap;
methodBuidler.addStatement("return $N", Constants.GROUP_PARAMETER_NAME);
// 最终生成的类文件名
String finalClassName = Constants.GROUP_FILE_NAME + moduleName;
messager.printMessage(Diagnostic.Kind.NOTE, "APT生成路由组Group类文件：" +
packageNameForAPT + "." + finalClassName);
// 生成类文件：ARouter$$Group$$app
JavaFile.builder(packageNameForAPT, // 包名
TypeSpec.classBuilder(finalClassName) // 类名
.addSuperinterface(ClassName.get(groupLoadType)) // 实现ARouterLoadGroup接口
.addModifiers(Modifier.PUBLIC) // public修饰符
.addMethod(methodBuidler.build()) // 方法的构建（方法参数 + 方法体）
.build()) // 类构建完成
.build() // JavaFile构建完成
我们为了能看出效果，在src下再新建两个Actvity
运行后
Path路由：将扫描到的Activity都添加到了app下
public class ARouter$$Path$$app implements ARouterLoadPath {
@Override
public Map loadPath() {
Map pathMap = new HashMap<>();
pathMap.put("/app/MainActivity", RouterBean.create(RouterBean.Type.ACTIVITY, MainActivity.class, "/app/MainActivity", "app"));
pathMap.put("/app/MainActivity", RouterBean.create(RouterBean.Type.ACTIVITY, MainActivity2.class, "/app/MainActivity", "app"));
pathMap.put("/app/MainActivity", RouterBean.create(RouterBean.Type.ACTIVITY, MainActivity3.class, "/app/MainActivity", "app"));
return pathMap;
}
} public class ARouter$$Group$$app implements ARouterLoadGroup {
@Override
public Map> loadGroup() {
Map> groupMap = new HashMap<>();
groupMap.put("app", ARouter$$Path$$app.class);
return groupMap;
}
} 我们再查看一下其他分组的显示：
生成的apt文件都在自己的目录下，这个是rebuild project的运行结果，但是我们可以观察到他们的包名与config.gradle中定义的是一样的
所以build apk分析一下生成的apk
