一种简单易懂的 Android 项目模块间解藕方案

在 Android 开发中,当项目增加一定规模之后,一般都会采用多模块的项目结构。当然也能采用插件化的开发模式,具体采用什么开发模式,开发者可以自行定夺。这里将介绍下我所熟悉的一种模块化开发机制。本质是基于 gradle 的 Multi-Project 构建和 Java 的动态代理机制。

这个方案现已提取开源:https://github.com/stefanJi/Android-MPD

// settings.gradle

include ':app', ':feature_a', ':feature_b', ':feature_c'
image

利用这套机制时:比如开发者开发 A 功能时,只会涉及 feature_a 模块中代码的修改,那么开发者就可以让 gradle 不编译其他模块中的代码(在 settings.gradle 中注释不需要的模块),从而能够减少本地开发时的编译耗时,也能够让某些代码只会在开发期间存在(比如为了方便测试单独提供的 admin 模块)。

选择性编译

同时为了避免因为模块间彼此依赖,导致个别模块不编译的目标无法实现。于是要求各个模块之间不能直接依赖具体实现,只能依赖某个公共模块(比如 app 模块)提供的接口。

image

具体实现是:

在 app 模块中定义模块 feature_a 能够提供的功能,比如打开 feature_a 中的一个 Activity.

public interface IFeatureA {
    @Nullable
    public Class<Activity> getActivityOfA();
}

然后在 feature_a 中实现这个接口:

public class FeatureA implements IFeatureA {
    public Class<Activity> getActivityOfA() {
        return FeatureAActivity.class;
    }
}

然后在 app 中注入 IFeatureA 接口的具体实现:

public class FeatureRegister {

    private static IFeatureA featureA;

    @Nullable
    public static IFeatureA getFeatureA() {
        if (featureA == null) {
            try {
                // 这里使用反射能够在即使 feature_a 模块未加入编译之后也能够成功编译
                featureA = (IFeatureA) Class.forName("io.github.stefanji.feature_a.FeatureA").newInstance();
            } catch (ClassNotFoundException e) {
                // 如果 feature_a 未加入编译,则会触发异常
            }
        }
        return featureA;
    }
}

然后 feature_b 需要获取 feature_a 的 FeatureAActivity:

IFeatureA featureA = FeatureRegister.getFeatureA();
Class<Activity> activityClass = null;
if (featureA != null) {
    activityClass = featureA.getActivityOfA();
};

动态代理未加入编译的模块

在上面我们已经能够实现不编译某些模块,并且项目整体编译不会出现问题。但是每次访问其他模块提供的功能时,从 app 模块获取实现之后需要进行判空处理。不是太优雅。

于是可以利用动态代理,如果目标模块没有被编译,那么就返回一个实现了目标模块功能接口的代理对象。
修改 app 中代码如下:

@NotNull
public static IFeatureA getFeatureA() {
    if (featureA == null) {
        try {
            featureA = (IFeatureA) Class.forName("io.github.stefanji.feature_a.FeatureA").newInstance();
        } catch (ClassNotFoundException e) {
        }
        // 如果 feature_a 模块未没编译,FeatureA 类将找不到,就动态生成一个 Proxy 类
        if (featureA == null) {
            featureA = (IFeatureA) Proxy.newProxyInstance(FeatureRegister.class.getClassLoader(),
                    new Class[]{IFeatureA.class},
                    new InvocationHandler() {
                        @Override
                        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                            Class returnType = method.getReturnType();
                            // 让原始类型返回零值
                            if (returnType == boolean.class) {
                                return false;
                            }
                            if (returnType == int.class) {
                                return 0;
                            }
                            if (returnType == float.class) {
                                return 0f;
                            }
                            //...
                            // 让引用类型返回 null
                            return null;
                        }
                    });
        }
    }
    return featureA;
}

这样就不用做如下判空了:

if (featureA != null) {
    activityClass = featureA.getActivityOfA();
};

自动化

每新增一个模块,我们就需要重复上面的步骤,在 FeatureRegister 中注册新的 Feature 接口。这种重复的操作,当然可以利用注解处理器或 gradle transform 之类的代码生成机制,让编译器去自动生成模板代码。

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

推荐阅读更多精彩内容