Android组件化项目自动初始化插件Initer原理解析

项目背景

先来说说开发此项目的背景，由于公司的项目采用组件化开发，各个组件内部需要在application中初始化一些特有的东西。通常的做法是在主项目中直接调用组件中的代码去完成初始化工作，这么做是完全OK的；but现在有这么一个设想，我能不能在编译主项目时不去编译某些组件，这样做能极大的提高了主项目的编译速度。下面我们来按照这个思路走一遍试试，首先要去掉某个组件就直接干掉该组件在项目中的依赖就好了。当我们干掉依赖时发现初始化该组件的地方报错了，原因是找不到类文件，仔细想一下就会发现我们这里调用的是组件的类文件，现在组件都被干掉了，当然找不到这个类了。那该怎么办呢，我们直接注释了吧，然后去跑项目完全ok。然后想要编译该组件时再去手动打开这个注释，好累啊。。。那么有没有别的方案呢，我们的需求就想要去掉每个组件就直接去掉依赖就好了，为什么还要去改动代码呢？？？？答案是有办法的，我们在初始化的时候其实只需要主项目的Application和当前编译环境（debug/release），那我们就想办法把这段初始化的代码自动生成，当我们依赖某个组件时自动去执行初始化的代码，不依赖时自然就不会去执行。就这样Initer就应用而生了。

核心思想

使用编译时注解自动生成初始化代码的代理类，统一调用

实现步骤

1、定义注解 @Inite

/**
 * 初始化组件注解器
 * Created by hezhiqiang on 2018/11/26.
 */

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Inite {

}

2、定义模板接口,这个类的作用是作为代理类的模板，所有生成的代理类都会实现此接口

/**
 * 业务组件初始化模板
 * Created by hezhiqiang on 2018/11/26.
 */

public interface IComponentInit {
    void init(Context context, Boolean isDebug);
}

3、在初始化工具类上增加注解

/**
 * Created by hezhiqiang on 2018/12/3.
 */

@Inite
public class TestIniter1 {

    public static void init(Context context, Boolean isDebug) {
        Log.d("xxxTestIniter1","TestIniter1#init is be call");
    }
}

这里需要注意两点：

init方法必须是用public static修饰
方法名和参数都是固定为init(Context context,boolean isDebug)

说明：由于初始化组件代码一般都是在Application中调用，目的只是为了得到应用的Application，因此我们这里直接使用一个静态的init方法将Application传到组件即可。

4、使用注解生成器生成代理类，生成产物如下：

/**
 * DO NOT EDIT THIS FILE!!! IT WAS GENERATED BY LCS_PROCESSOR. */
public class _InitImpl$$app implements IComponentInit {
  @Override
  public void init(Context context, Boolean isDebug) {
    com.hzq.initer.TestIniter1.init(context,isDebug);
  }
}

5、提供初始化Api，作用是扫描生成的所有代理类，并调用初始化方法。

调用方式是如下:

/**
 * Created by hezhiqiang on 2018/12/3.
 */

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        Initer.init(this,BuildConfig.DEBUG);
    }
}

总结

到此初始化插件基本流程已经理清了，具体代码实现还请移驾到本人的github（qiangzi.github）查看源码。

下面附上此插件的使用方式

1、项目配置

在需要自动初始化的组件的build.gradle文件中添加以下依赖：

android {
    //......
    defaultConfig {
        //......
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [moduleName: project.getName()]
            }
        }
    }
    //......
}

dependencies {
   //......
    implementation 'com.hzq.android:initer-api:1.0.1'
    annotationProcessor 'com.hzq.android:initer-compiler:1.0.0'
}

2、创建初始化组件工具类，并添加@Inite注解。注意这里是静态调用，所以init方法必须是static的

@Inite
public class TestIniter1 {

    public static void init(Context context, Boolean isDebug) {
        Log.d("xxxTestIniter1","TestIniter1#init is be call");
    }
}

3、在Application#onCreate中添加如下代码

Initer.init(this,BuildConfig.DEBUG);