什么叫自动注册组件?一开始我也没有明白,现在我来解释下。
组件化完成后,为了减少代码耦合,我们可以使用动态生成代码的方式写一些重复代码。
什么是自动注册:
当我们项目有多个moudle的时候,app作为主工程,会有多个业务moudle。我们想要将每一个业务moudle下的 XXInterface 的实现类放到一个全局的数组之中,我们应该怎么处理呢?第一个办法就是在app module下创建全局数组,然后将每个moudle下接口实现类手动的添加到数组里面。这个是绝对没有问题的,但是每次新增一个实现类,我们就要手动的写代码。作为互联网界的流行“ 谁懒谁技术强的”标准,我们肯定不能这么low的写。也就是说这些代码我们不能写!!!!
通过asm,将每个业务moudle的指定类,通过动态生成代码方式添加到数组之中的技术就是自动注册。
功能介绍
在apk打包过程中,对编译后的所有class(包含jar包中的class)进行扫描,将 scanInterface的实现类 或 scanSuperClasses的子类扫描出来,并在 codeInsertToClassName 类的 static块 中生成注册代码。
备注:因为是使用了asm技术,所以扫描的类包含:通过maven依赖的库、module依赖的library、aar包、jar包、AIDL编译后的类及当前module中的java类。但是apt是只能扫描源码,所以asm要比apt多了一个纬度的扫描。
实现
第一步:我们需要创建接口(基础moudle内):
/**
* Created by malei on 7/19/21
* Describe:
*/
public class CategoryA implements ICategory {
@Override
public String getName() {
return "CategoryA";
}
}
然后我们在App Moudle和 B Moudle里实现接口
/**
* Created by malei on 7/19/21
* Describe:App moudle
*/
public class CategoryA implements ICategory {
@Override
public String getName() {
return "CategoryA";
}
}
/**
* Created by malei on 7/19/21
* Describe:B 业务 moudle
*/
public class CategoryB implements ICategory {
@Override
public String getName() {
return "CategoryB";
}
}
然后编写接口数组类管理:
public class CategoryManager {
private static HashMap<String, ICategory> categoryList = new HashMap<>();
static void register(ICategory category) {
if (category != null) {
categoryList.put(category.getName(), category);
}
}
public static HashMap<String, ICategory> getList(){
return categoryList;
}
}
第三步:实现的过程就使用到了 com.billy.android:autoregister 这个包,首先我们需要在项目根gradle下添加依赖:
classpath 'com.billy.android:autoregister:1.4.1'
第四步:在app gradle添加配置信息
apply plugin: 'auto-register'
project.ext.registerInfoList = [
[
'scanInterface' : 'com.qiyi.runtime.ICategory', //扫描的接口实现类
'codeInsertToClassName': 'com.qiyi.runtime.CategoryManager', //插入代码的类
'registerMethodName' : 'register' //未指定 codeInsertToMethodName,默认插入到static块中,故此处register必须为static方法
]
]
autoregister {
registerInfo = registerInfoList
cacheEnabled = true //支持增量编译及其开关(默认开启,可通过配置cacheEnabled = false来关闭增量编译
}
最后当我们生成app 以后,通过反编译的方式,我们看下CategoryManger类后,发现多了一个静态代码:
这个技术看着很简单,但是这个技术是使用在路由上,当我们在将各个module里的路由实现类放入数组中的时候就可以使用该技术。