Android 模块化的基本思路探索实践

什么是模块化

什么是模块化呢？有一种定义是：模块化是一种处理复杂分解为更好的可管理模块的方式。由此可见，模块化思路下构成的复杂系统是由各个可管理的子模块构成的，每个子模块之前相互独立，并通过某种特定的方式进行通信。在工业上面，有模块化汽车的概念，也有模块化手机的概念，各个模块根据一定的标准进行生产，生产之后可以直接进行各个模块的组装，某个模块出现问题之后，可以单独对这个模块进行替换。举个例子，同样一款汽车，有各中配置不同的版本，比如发动机不同。这些发动机都按照一定的标准生产，但是发送的输出和能耗并不同。重要的是其接口标准一样。从可替换这一点来讲，和软件开发中的可插拔是异曲同工的。

android 开发中有两个比较相似的概念：化和模块化，这里需要进行区分的。

组件化：指的是单一的功能组件，如地图组件、支付组件、路由组件（router）等等；模块化：独立的业务模块，模块相对于组件来讲粒度更大。

模块化的好处是显而易见的。

多团队并行开发测试； 模块间解耦、重用； 可单独编译打包某一模块，提升开发效率。

android插件化——指将一个程序划分为不同的部分，比如一般app的皮肤样式就可以看成一个插件

android组件化——这个概念实际跟上面相差不那么明显，组件和插件较大的区别就是：组件是指通用及复用性较高的构件，比如图片缓存就可以看成一个组件被多个app共用

插件的方式只有三种：１，apk安装，２，apk不安装，３，dex包

模块debug和release处理

对于模块化项目，每个单独的 business module 都可以单独编译成 apk。在开发阶段需要单独打包编译，项目发布的时候又需要它作为项目的一个 module 来整体编译打包。简单的说就是开发时是 application，发布时是 library。因此需要在 business module 的 build.gradle 中加入如下代码：

if(isbuildmodule.toboolean()){ apply plugin:'com.android.application'}else{ apply plugin:'com.android.library'}

isbuildmodule 在项目根目录的 gradle.properties 中定义:

isbuildmodule=false

同样 manifest.xml 也需要有两套：

sourcesets { main {  if(isbuildmodule.toboolean()) {     manifest.srcfile'src/main/debug/androidmanifest.xml'   }else{     manifest.srcfile'src/main/release/androidmanifest.xml'   } }}

debug 模式下的 androidmanifest.xml :

realease 模式下的 androidmanifest.xml :

模块化分层设计

合理的模块化分层设计是非常重要的，就像一个房子一样，合理的框架设计是成功的保证。模块化分层设计需要达到以下几个目标：

模块职责明确；

模块代码边界清晰；

模块通信

模块职责明确

根据职责进行分层设计是合理有效的，以下是在项目实践中采用的分层设计。

sdksdk层包括的内容如图所示，需要强调的是并不是所有的第三方libraries都放到sdk，必须是通用的基础级别的。

组件库我们将各个业务模块公用的组件整合到组件库中，组件库并不一定是一个module，它也可以是多个module，实际使用的时候更多的被业务模块依赖。

basecore这是最重要的一个层级，app核心的部分就是它，basecore可以用通用的定义以下几个部分：

coreaccount: app账号管理，账号登录、注销、profile信息获取等；corenetwork: 以retrofit2为例，corenetwork并不提供业务模块的api，只是提供基础的网络状态管理、网络错误管理；corestorage: 处理sqlite、preferences；corecommunication：模块之间的通信主要有三种：事件通知、页面跳转（activity、service）、接口调用。模块通信是最重要的层次，后面会重点讲

此外，这个层次是最容易代码越界的层次，随着业务的不断复杂，业务模块中的代码是极有可能下沉到basecore的，从而导致core层代码越来越冗余。清晰合理的代码边界规范是重要的。

业务模块业务模块的拆分粒度需要把控，太小的粒度并不是很合理。其中app（release）是最终发布出去的版本，它是对其他模块1…n 的整合。各个业务模块在debug’阶段，可以独立打包成apk进行调试，在release阶段，则作为app的module被引用。各个业务模块之间不进行相互调用，它们之间的通信通过basecore层来实现。

代码边界

合理的代码边界约定可以保证层次的清晰、避免架构变得冗余，虽然没法完全保证，毕竟定期的重构是无法避免的。

各个业务模块之间无依赖关系，模块之间页面的跳转通过arouter等页面路由协议进行;

模块之间的事件通信采用eventbus，并依赖于basecore层的事件manager进行管理；

模块之间的功能暴露全部通过接口，接口需要下沉到basecore层，接口使用前必须先注册，调用方式形如下，后续文章会详细介绍：

servicemanager.regist(pluginservice.class);servicemanager.get(pluginservice.class).execute();

组件库组件必须提供个性化定制，方便业务模块使用;

合理控制各组件和各业务模块的拆分粒度，太小的公有模块不足以构成单独组件或者模块的，我们先放到类似于 commonmodule 的组件中，在后期不断的重构迭代中视情况进行进一步的拆分;

上层的公有业务或者功能模块可以逐步下放到下层，下放过程中按照层次职责归类下放；

各个模块之间的横向依赖关系，比如在使用pluginservice2之前，需要先注册pluginservice1，这种依赖管理后续会详细介绍

模块通信

模块通信需要解决三大问题：

页面跳转

事件通知

接口调用

页面跳转

这里介绍一款页面路由神器：arouterhttps://github.com/alibaba/arouter

本着能用、够用、好用的原则，这款神器支持以下功能：

支持直接解析标准url进行跳转，并自动注入参数到目标页面中

支持多模块工程使用

支持添加多个拦截器，自定义拦截顺序

支持依赖注入，可单独作为依赖注入框架使用

支持instantrun

支持multidex(google方案)

映射关系按组分类、多级管理，按需初始化

支持用户指定全局降级与局部降级策略

页面、拦截器、服务等组件均自动注册到框架

支持多种方式配置转场动画

支持获取fragment

完全支持kotlin以及混编(配置见文末 其他#5)

其调用方式如下：

1. 添加注解@route(path ="/test/activity")publicclassyouractivityextendactivity{ ...}2. 初始化sdkif(isdebug()) {     // 这两行必须写在init之前，否则这些配置在init过程中将无效 arouter.openlog();  // 打印日志 arouter.opendebug(); // 开启调试模式(如果在instantrun模式下运行，必须开启调试模式！线上版本需要关闭,否则有安全风险)}arouter.init(mapplication);// 尽可能早，推荐在application中初始化3. 发起路由操作// 1\. 应用内简单的跳转(通过url跳转在'进阶用法'中)arouter.getinstance().build("/test/activity").navigation();// 2\. 跳转并携带参数arouter.getinstance().build("/test/1").withlong("key1",666l).withstring("key3","888").withobject("key4", new test("jack","rose")).navigation();

实际应用中，在basecore中实现一个routermanager，管理路由初始化，跳转等事宜：

publicclassroutermanager{ /**  * router path  */ publicstaticfinalstring url_welcome ="/loginmodule/welcome"; publicstaticfinalstring url_login ="/loginmodule/login"; publicstaticfinalstring url_main_login ="/loginmodule/main"; publicstaticfinalstring url_main_pedu ="/pedumodule/main"; ... /**  * module application name  */ publicstaticfinalstring module_login ="loginmodule"; publicstaticfinalstring module_pedu ="pedumodule"; publicstaticvoidinitrouter(application application){   if(buildconfig.debug) {     arouter.openlog();  // 打印日志     arouter.opendebug(); // 开启调试模式(如果在instantrun模式下运行，必须开启调试模式！线上版本需要关闭,否则有安全风险)   }   arouter.init(application); } publicstaticvoidgotonewpage(context context, string pageurl){   arouter.getinstance().build(pageurl).navigation(); } publicstaticvoidgowelcome(context context){   arouter.getinstance().build(url_welcome).navigation(); } publicstaticvoidgologin(context context){   arouter.getinstance().build(url_login).navigation(); } publicstaticvoidgohome(context context){   string packagename = context.getapplicationinfo().packagename;   logutils.logd(packagename);   string suffix = packagename.substring(packagename.lastindexof(".") +1);   switch(suffix) {     casemodule_login:       arouter.getinstance().build(url_main_login).navigation();       break;     casemodule_pedu:       arouter.getinstance().build(url_main_pedu).navigation();       break;   } } ...}

更多使用方法可以参考github该库的详细介绍

由于篇幅原因，事件通知、接口调用将在后续文章中介绍！！

其他问题

资源名冲突

对于多个 bussines module 中资源名冲突的问题，可以通过在 build.gradle 定义前缀的方式解决：

defaultconfig { ... resourceprefix"module_name_" ...}

而对于 module 中有些资源不想被外部访问的，我们可以创建 res/values/public.xml，添加到 public.xml 中的 resource 则可被外部访问，未添加的则视为私有：