Android：项目模块化/组件化的架构之路（一）-CSDN博客

本文链接：https://blog.csdn.net/liyi1009365545/article/details/84032509

文章目录

前言

在Android开发中，随着项目的不断扩展，项目会变得越来越庞大，而随之带来的便是项目维护成本与开发成本的增加！每次调试时，不得不运行整个项目；每当有新成员加入团队时，需要更多的时间去了解庞大的项目。。。而为了解决这些问题，团队通常会将项目模块化，以此来降低项目的复杂度和耦合度，让团队可以并行开发与测试，让团队成员更加专注于自己所负责的功能模块开发。。。

对于一些大厂如BAT或者美团等这些大型互联网公司，都会自己造轮子，实现项目模块化。而对于中小型公司，限于成本因素，一般都是选用这些大厂造的优秀的轮子来进行项目模块化。本文以及后面一系列文章，将向大家分享我在项目模块化中的实践经验。我的项目模块化方案主要借鉴于饿了么、微信、美团的模块化技术文章，如有建议，欢迎提出！

模块化需要做什么

首先，在开始项目模块化之前，我们必须要明确模块化需要做些什么？这就等于写书之前必须得有个总纲，否则越写到后面，越是混乱。以下是我认为在模块化时需要注意的几个问题：

如何拆分项目
模块之间的通信
模块内的代码隔离
模块在调试与发布模式之间的切换

在明确了项目模块化中需要解决的问题后，我们需要选定一个优秀的组件化开源框架。在本方案中，我选择阿里的ARouter，也是目前比较流行的组件化框架之一，大家也可以选择其他开源框架。ARouter的具体使用本文就不在介绍了，大家可以在网上自行搜索，下面开始设计项目模块化的架构。

一、如何拆分项目

模块化结构图例
如上图所示，我将项目大概划分为五层：

宿主层： 不做具体的项目功能实现，只负责集成业务模块，组装成一个完整的APP
业务模块层： 将项目的每个大功能模块拆分成的一个一个单独的module
基础业务组件层： 此层最大的作用是为了复用，例如首页模块与新盘模块中都有楼盘搜索这个功能，且UI显示相似，这时在两个模块中都实现楼盘搜索就显得繁琐了，像这种与业务有关联且需要多处使用的情况，我们完全可以将其抽离出来作为基础业务组件
功能组件层： 项目中常用的功能库，如图片加载、网络请求等
底层SDK： 从公司项目中长期积累出来的底层类库

以上是大多数项目模块化时的拆分方式，每个人也可以根据项目的实际情况进行调整。

二、模块之间的通信

1. 常用的通信方式

当项目被拆分成多个模块后，模块之间的良好的通信是我们必须考虑的问题。ARouter本身也提供一套通信机制，但是一般很难满足我们所有的需求，所以我们会容易想到的常用的几种通信方式：EvenBus、协议通信、广播或者是将通信的部分下沉到公共组件库。对于这几种方式，在一些大厂的技术文章中都有提到一些他们的看法，下面我简单总结一下：

EventBus： 我们非常熟悉的事件总线型的通信框架，非常灵活，采用注解方式实现，但是难以追溯事件，微信、饿了么认为这是个极大的缺点，不是很推荐，但是美团觉得只要自身控制的好就行（自己设计了一套基于LiveData的简易事件总线通信框架）。
协议通信： 通信双发必须得都知晓协议，且协议需要放在一个公共部分保存。虽然解耦能力强，但是协议一旦变化，通讯双方的同步会变的复杂，不方便。
广播： 安卓的四大组件之一，常见的通信方式，但是相对EventBus来说，过重。
下沉到公共组件库： 这是在模块化中常见的做法，不断的将各种方法、数据模型等公共部分下成到公共组件库，这样一来，公共组件库会变的越来越庞大，越来越中心化，违背了项目模块化的初衷。最后，越来越难以维护，不得不在重新拆分公共组件库。

2. 改善通信方式

上面说了一些常用的通信方式，可以看到大厂并不是很满意，那么大厂都是怎么解决的呢？没错，大厂往往都会有重造一个符合他们要求的通信框架！然而这不是我们想要的（中小型公司的实力和成本不允许啊😢）,不过没关系，我们可以根据大厂们的思路，自己建造一个精简实用的通信架构，下面一起来看!

2.1 使用接口进行通信

接口通信概念并不是什么新颖的概念，微信在技术文章中着重说明过，ARouter框架也具备这种能力。下面我们配合一个小例子形象的说明一下。

eg：在一个房产项目中，有推荐与新盘两个模块，这两个模块使用相同的接口（传入参数不同）获取楼盘数据。

针对这种状况，一般我们下沉数据接口至公共组件库，然后推荐和新盘都去调用公共组件库中的楼盘接口获取数据。而上面也说过了，这种情况的后果就是，当有数十上百个接口被下沉到公共组件库后，公共组件库已然中心化且变得很庞大，这不是我们想要的。我们需要的是去中心化，开发成员只需要专注于自己负责的模块本身，减少模块之间的耦合。而接口化的通信方式给我们提供了这种可能。

什么是接口化通信？我们可以理解为将一个模块当作SDK，提供接口+数据结构给其他需要的模块调用，从而实现通信。我们完全可以将获取楼盘数据的具体实现放在新盘模块中，然后单独提供获取楼盘数据的接口和楼盘的数据结构给推荐模块，推荐模块通过调用提供的接口就可以直接获取需要的楼盘数据，不需要关注获取楼盘数据的具体实现。这样，即使获取楼盘数据的具体实现发生变动，推荐模块也不需要做任何更改，且维护也很简单。

对于这种接口化的通信实现，ARouter的IProvider就已经实现，完全可以满足我们的要求。具体如何使用IProvider，这里就不在详细介绍，大家可以网上自行搜索。

2.2 如何对外暴露接口

解决了通信手段的问题，我们就得考虑另一个问题，为其他模块提供的接口+数据结构我们应该放在哪里？下沉到公共模块吗？或者另外新建一个module用来维护这些接口+数据结构？但是这样一来，成本就有些大了，也不方便。

在微信的模块化文章中提出了一个解决方法，将你要暴露的接口+数据结构甚至其他想要暴露的文件都.api化，即将你要暴露的文件的后缀名改为api，然后通过特定的方法将api后缀的文件拷贝出来，在module外部重新组成一个新的module（也可称为SDK），而想要使用的模块只需要调用这个SDK即可。当然，拷贝文件和组件SDK是完全自动化的，并非手工，这样才能节省成本。

由于微信的模块化文章中没有涉及到.api化的具体实现，所以根据这种思路，我使用了其他方法来实现要达到的效果。具体思路如下：

创建一个名为_exports的文件夹，需要对外暴露的文件都放在里面
将_exports文件夹打包成jar

/**
 * 创建 jar 包
 */
task makeExportJar(type: Jar) {
   
    baseName = "hpauth-exports"
    version = "1.0.0"
    extension = "jar"
    // java文件编译后的所在位置
    from('build/intermediates/classes/debug/')
    // kotlin文件编译后的所在位置
    from('build/tmp/kotlin-classes/debug/')
    include('com/homeprint/module/auth/_exports/**')
    // jar包导出路径
    destinationDir = file('build/_exports')
}

将jar发布到本地maven仓库（发布到本地仅仅针对个人开发的时候；团队开发时，大家使用各自的电脑，无法访问到你本地的maven仓库，所以这时需要在局域网中建立一个maven仓库，详情请查看《Android：超详细的本地搭建maven私服以及使用Nexus3.x搭建maven私服的讲解》）

artifacts {
   
    archives makeExportJar
}

uploadArchives {
   
    repositories {
   
        mavenDeployer {
   
            // 本地的maven仓库路径
            repository(url: uri("../repo"))
            pom.project {
   
                groupId 'com.homeprint.module'
                artifactId 'auth-exports'
                version '1.0.0'
            }
        }
    }
}