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);
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容

  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,476评论 2 59
  • Android组件化项目地址:Android组件化项目AndroidModulePattern Android组件...
    半灬边灬天阅读 2,865评论 4 37
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 今天听樊登读书中老师讲的书《一平方米的静心》,发现生活中真的需要静下来,慢下来,而不是匆忙地前行。 昨天骑车时,遇...
    陈雪云2021阅读 6,100评论 0 2
  • 被这个困扰了二十年的我,终于在第二十一年找到了正解。看到自己现在头发慢慢的越变越健康,真的有一种晚来得子的幸福感(...
    水星记_e292阅读 621评论 2 1