Android模块化设计方案之接口API化

Android模块化设计方案系列文章:

Android模块化设计方案模型图

Android模块化设计方案之接口API化

在对项目进行模块化的时候,为了避免相同层级的模块之间交叉依赖,把模块之间需要相互调用的方法抽象成接口下沉到公共模块是普遍的解决方案,但是这样会导致公共模块越来越臃肿,承担了很多不属于它的职能,而且出现问题的时候也不方便进行定位。

那么如何解决这个问题?

微信团队有一篇文章《微信Android模块化架构重构实践》 给出了一个方案,即API化:

那么接下来,我就根据微信团队提出的理论,在实战项目中进行实践:

开发工具:Android Studio 3.6.3

Gradle版本:5.6.4

开发语言:Kotlin


第一步:我在a模块中简单定义了一个接口:

并在impl里面对该接口进行了实现,现在可以看到我这个接口的拓展名是.kapi的,为了能让Android Studio更好的识别该自定义文件,我们可以在Preferences > Editor > File Types里面定义文件的类型。

针对Java文件的.api后缀
针对Kotlin文件的.kapi后缀

这里有问题,本来这个.kapi应该和上面的.api一样,定义在各自的文件类型下,但是我定义在Kotlin的文件下的时候,编译项目时会随机飘红,我研究了下但是并没有找到原因所在,所以只能在Kotlin的同层定义了一个Kapi的类型与拓展名。有知道原因的大佬希望能不吝赐教。



第二步:在a模块中新建一个api.gradle,作为自动生成-api模块的build.gradle文件

由于跨模块调用资源文件的场景一般不多,所以我就简单一点,让自动生成的-api模块类型为java-library。



第三步:自定义gradle脚本实现-api模块的生成,我在setting.gradle文件的同层目录下创建一个名为supportApi.gradle的脚本文件,其内容如下:

1


2

(简书插入gradle代码的时候全成了一坨,我就偷个懒,就截图展示了😹)

定义完我们的脚本文件之后,在setting.gradle中引入,并把include替换为我们自己定义的includeWithApi

然后就可以重新构建我们的项目了。



第四步:脚本自动生成的liba-api模块就可以愉快的被其他模块调用了,因为这个模块里面只有我们在liba模块里面kapi接口,并没有其他多余的文件,我们也可以放心大胆的在其他模块中依赖这个api模块了。

而liba模块本身在脚本中已经自动完成对生成模块的依赖了,所以liba模块无需再依赖liba-api。

接口API化的简单实现方案就此完成,赶快试试吧~

项目地址:https://gitee.com/StudyNotes/x-moduler

欢迎关注~

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

推荐阅读更多精彩内容