GitHub标星9-8k，知乎阅读10w+，Android-客户端组件化实践

主工程：除了一些全局配置和主 Activity 之外，不包含任何业务代码。

业务组件：最上层的业务，每个组件表示一条完整的业务线，彼此之间互相独立。

基础组件：支撑上层业务组件运行的基础业务服务。

基础 SDK：完全业务无关的基础代码。

各层次职责清晰独立，可以很方便的进行拆解和组合；由于都有自己的版本，业务线可以独立发版，随时升级、回滚。

基本解耦方案

组件化的第一步就是对要拆出去的组件进行解耦，常见解耦方式有以下几种：

(1) 公用代码处理

1. 基础业务逻辑分别拆成基础组件
2. 自身逻辑完整、用于完成某一特定功能、不含业务逻辑的一组代码，独立成 SDK
3. 代码量很小不足以拆分成单独拆分的代码和资源，我们统一放在一个专门建立的 common 组件中，并且严格限制 common 组件的增长。随着组件化的逐渐进行，common 应该逐渐变小而不是增大。
4. 碰巧被共同使用的一些代码和资源片段，通常它们被复用只是因为被开发人员搜索到而直接使用了，很多时候某个资源已经被 A 业务声明了前缀，但是由于没有隔离，仍然会不可避免的被他人在 B 业务中强行复用，这时候如果 A 业务方要进行一些修改，B 业务就会受到影响 —— 这种情况我们允许直接复制

(2) 初始化

有些组件有在应用启动时初始化服务的需求，而且很多服务还是有依赖关系的，最初我们为每个组件都添加了一个 init() 方法，但是并不能解决依赖顺序问题，需要每个组件都在 app 工程中按顺序添加初始化代码才能正常运行，这使得不熟悉整套组件业务的人很难建立起一个可以独立运行的组件 app。因此我们开发了一套多线程初始化框架，每个组件只要新建若干个启动 Task 类，并在 Task 中声明依赖关系即可：

App 只需知道自己依赖什么组件即可，在编译 app 时 gradle 插件会自动定位到所有的 Task，并运行时生成依赖图，按依赖顺序启动 Task：

这样就解决了组件在主工程中堆积初始化代码的问题，在简化了代码的同时还有加快启动速度的功效。

(3) 路由

界面间使用 Url 进行跳转，不但实现了解耦，也统一了各端的页面打开方式。我们实现了一套灵活小巧的路由框架 ZRouter，它支持多组件、路由拦截、AB Test 、参数正则匹配、降级策略、任意参数传递以及自定义跳转等功能，可以自定义路由的各个阶段，完全满足了我们的业务需求。

(4) 接口

除了页面间的跳转，不同业务之间不可避免的会有一些调用，为了避免组件的直接通信，通常都是使用接口依赖的方式。我们实现了一个 Interface Provider 来支持接口通信，它可以通过运行时在动态注册一个接口，同时也实现了对于 ServiceLoader 的支持。只要一方组件将通信接口暴露出来，使用方就可以直接使用接口进行调用。

动态注册接口

Provider.register(AbcInterface.class，new AbcInterfaceImpl())

获取实例并调用

Provider.get(AbcInterface.class).doSomething()

(5) EventBus

这个自不必说，虽然说滥用是一个问题，但是有些场景下，使用事件还是最为方便简单的方式

(6) 组件 API 模块

上面提到的接口和事件以及一些跨组件使用的 Model 放到哪里好呢？如果直接将这些类下沉到一个公共组件中，由于业务的频繁更新，这个公共组件可能会更新得十分频繁，开发也十分的不方便，所以使用公共组件是行不通的，于是我们采取了另一种方式——组件 API ：为每个有对外暴露需求的组件添加一个 API 模块，API 模块中只包含对外暴露的 Model 和组件通信用的 Interface 与 Event。有需要引用这些类的组件只要依赖 API 即可。

[图片上传中…(image-a39cd0-1598345691997-6)]

一个典型的组件工程结构是这个样子：

以上图为例，它包含三个模块：

template ：组件代码，它包含了这个组件所有业务代码

template-api：组件的接口模块，专门用于与其他组件通信，只包含 Model、Interface 和 Event，不存在任何业务和逻辑代码

app 模块：用于独立运行 app，它直接依赖组件模块，只要添加一些简单的配置，即可实现组件独立运行。

组件半自动拆分

有了解耦的方法，剩下的就是采取行动拆分组件了，拆组件是一个很头疼的问题，它非常考虑一个人的细心与耐心，由于无法准确知道有哪些代码要被拆走，也不能直观的知晓依赖关系，移动变得非常的困难且容易出错，一旦不能一次性拆分成功，到处都是编译错误，便只能靠人肉一点一点的挪。

工欲善其事，必先利其器。为了解决这个问题，我们开发了一个辅助工具 RefactorMan： 它可以递归的解析出工程中所有源码的引用和被引用情况，同时会根据预设规则自动分析出所有不合理的依赖，在开发人员根据提示解决了不合理依赖之后，即可将组件一键移出，大大减少了拆组件的工作量。我们在组件化初期曾经走过一些弯路，最初拆出的八个组件工程的的部分源码经历了几次的反复移动才得出最优解，而有了 RefactorMan，我们可以面对反复的拆分和组合组件有恃无恐。

Bonus ：由于可以分析和移动资源，所以额外获得了清理无用资源的功能。

联合编译完整包

单独运行组件 app 并不能完整的覆盖所有的 case，尤其是在给 QA 测试的时候，还是需要编译完整的主工程包的，所以我们需要一个直接编译完整包的方案：

最初我们的实现方式只针对组件，比较简单：

首先在 setting.gradle 中动态引入组件 module：

def allComponents = [“base”, “account” … “template” …]
allComponents.forEach({ name ->
if (shouldUseSource(name)) {
// 动态引入外部模块
include “:$name"project(":${name}”).projectDir = getComponentDir(name);
}
})

然后在 app/build.gradle 中切换依赖，需要将所有被间接依赖的组件全部 exclude 以防止同时依赖了一个组件的 module 和 aar：

allComponents.forEach({ name ->
if (shouldUseSource(name)) {
implementation(project(“:KaTeX parse error: Expected 'EOF', got '}' at position 46: …PONENT_GROUP } }̲ else { impleme…{COMPONENT_GROUP}:$name:${versions[name]}”) { exclude group: COMPONENT_GROUP }
}
})

由于所有组件的 group 都是一样的，所以这样做并没有什么问题，但是后来一些基础 SDK 也出现了这种需求，这时候就需要一种通用的源码依赖方案，因此做了一下修改，直接使用 gradle 提供的依赖替换功能，只需要修改 setting.gradle 即可：

// … 忽略读取配置代码 …
configs.forEach { artifact, prj ->
include “:$prj.name"project(":${prj.name}”).projectDir = new File(prj.dir)
}
gradle.allprojects { project ->
if (project == project.rootProject) {
return
}
project.configurations.all {
resolutionStrategy.dependencySubstitution {
configs.forEach { artifact, prj ->
// 在这里进行替换
substitute module(artifact) with project(“