Android组件化架构中用于各个组件在Application启动时进行初始化操作的框架
| 模块 | componentinitializer | compiler | gradle-plugin |
|---|---|---|---|
| 最新版本 | |
|
|
@Component
public class Component implements IComponent {
@Override
public void init(Context context) {
}
}相对于配置文件（xml,或者.MF）,注解方式是最方便的
有一种场景是组件A的初始化依赖于组件B先初始化完成，此时我们可以通过@Component注解的dependencies属性来配置这种依赖关系
@Component(
name = "ComponentA",
dependencies = {"ComponentB"}
)
public class ComponentA implements IComponent {
@Override
public void init(Context context) {
}
}我们的框架会保证ComponentB在ComponentA之前初始化
我们是通过注入new ComponentA()代码来实现ComponentA类的初始化，不是通过反射，所以效率高
只需要一行代码
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
ComponentInitializer.initComponents(this);
}
}Project级别的build.gradle文件
buildscript {
repositories {
jcenter()
}
dependencies {
classpath "com.jst.componentinitializer:gradle-plugin:1.0.1"
}
}App module(使用'com.android.application' plugin的module)的build.gradle文件
apply plugin: 'com.jst.component.initializer'组件module （使用@Component注解的module）
dependencies {
implementation 'com.jst.componentinitializer:componentinitializer:1.0.0'
annotationProcessor 'com.jst.componentinitializer:compiler:1.0.0'
}Application类所在module（一般为App module）
dependencies {
implementation 'com.jst.componentinitializer:componentinitializer:1.0.0'
}在组件module中新增加一个Component类，该类实现IComponent接口，添加@Component注解
@Component
public class Component implements IComponent {
@Override
public void init(Context context) {
}
}大部分的组件不需要添加初始化依赖，所以这样配置就可以了
如果一个组件的初始化依赖于另一个组件的初始化先完成，则需要添加初始化依赖。
在dependencies中添加被依赖组件的 component name。
依赖可以有多个，dependencies是数组。
@Component(
dependencies = {"ComponentB","ComponentC"}
)
public class ComponentA implements IComponent {
@Override
public void init(Context context) {
}
}对于被依赖的组件，则需要声明一个component name
@Component(
name = "ComponentB"
)
public class ComponentB implements IComponent {
@Override
public void init(Context context) {
}
}public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
ComponentInitializer.initComponents(this);
}
}debug模式下在调用各Component的init方法之前会输出日志，用户可以通过日志查看各Component的初始化情况。tag 为 ComponentInitializer.LOG_TAG
通过在ComponentInitializer.initComponents()方法之前调用ComponentInitializer.setDebug(true)的方式可以打开debug模式
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
ComponentInitializer.setDebug(true);
ComponentInitializer.initComponents(this);
}
}对于配置了dependencies参数的场景会存在一些异常情况。对于所有的异常情况，该框架在执行ComponentInitializer.initComponents()方法时都会进行检测， 并且以IllegalArgumentException异常的形式进行抛出，并且会提示给用户异常原因所在的具体的类，方便用户定位问题。
例如：ComponentA 依赖 ComponentB，ComponentB 依赖 ComponentC ,ComponentC 依赖 ComponentA，则存在循环依赖
比如，被依赖的组件没有配置component name，或者配置的component name与你声明的不匹配
在编译期，使用annotationProcessor来处理@Component注解，自动生成.java类
在打包Dex文件之前,使用Transform API 修改.class文件，自动添加注册代码到ComponentInitializer.class中，这样就可以省去用户手动注册Component的麻烦。其中用到了AutoRegister的能力。 （ARouter也用了AutoRegister）
详细的原理解析 请参考 Component Initializer原理解析
直接clone该项目可以直接编译运行，在demo文件夹下有用于演示的demo程序
用户可以通过修改组件module中的@Component注解的dependencies配置来通过log查看各Component的初始化顺序
如果组件有一些功能需要在Application启动时进行初始化，我们可以如何来实现呢？
我们知道app module是会依赖于所有的组件module,所以可以在app module中的Application类中去做组件module的初始化。
缺点：
- 在组件化架构中，一般app module起到的作用是一个app壳，里面应该避免包含具体业务逻辑
- 各个组件module的初始化代码都放在一个Application类中去做的话，时间一长，Application类就会存在中心化的问题，该类的代码就会变的比较多，逻辑会越来越复杂，该类就很难维护，每个人都不敢乱改其中的代码
同样是在app module中的Application类中调用各个组件的Component类的init方法
优点：
初始化逻辑放在了各个组件里来维护，解决了Application类的中心化问题
缺点：
在Application类中要存在这样的一个方法
void initComponents(){
new Component1().init();
new Component2().init();
new Component3().init();
...
}如果有新增的组件，就需要在该方法中新增一行调用代码，手动的维护这样的一个列表非常的不方便
实现一个ComponentManager管理类，Application启动时调用该管理类的init方法，在该方法中去扫描所有的component.xml的配置文件（component.xml配置文件会被打包到apk中），解析出其中所有的Component类的完整类名，通过反射初始化该类，然后调用该类的init方法。
优点：
不需要在Application类中维护一个Component列表
缺点：
- 需要在组件module中增加一个配置文件来配置Component类的完整类名，这种配置方式并不方便
- 通过反射来初始化Component类，性能较低
QQ 交流群
