Android组件化

2401_84520026

已于 2024-04-27 18:01:53 修改

阅读量908

点赞数 19

文章标签： android

于 2024-04-27 18:01:51 首次发布

本文链接：https://blog.csdn.net/2401_84520026/article/details/138254561

版权

ps：module_ 开头表示基础组件，fun_ 前缀表示业务基础组件，biz_前缀表示业务组件，export_前缀表示业务组件暴露接口。

单工程利弊分析：

利：一个模块修改后只需要编译一下，依赖它的其他模块就能马上感知到变化。
弊：没能做到完全的职责拆分，每个模块的开发者都有修改其他模块的权限。

首先在 gradle.properties 文件内声明一个变量：

// gradle.properties

isModule = true

isModule 为 true 时表示组件可以作为 apk 运行起来，false 表示组件只能作为 library。我们根据需要改变这个值后同步下gradle即可。

然后在某个 module 的 build.gradle 文件内用这个变量做三个地方的判断：

// build.gradle

// 区分是应用还是库

if(isModule.toBoolean()) {

apply plugin: ‘com.android.application’

}else {

apply plugin: ‘com.android.library’

}

android {

defaultConfig {

// 如果是应用需要指定application

if(isModule.toBoolean()) {

applicationId “com.xxx.xxx”

}

sourceSets {

main {

// 应用和库的AndroidManifest文件区分

if(isModule.toBoolean()) {

manifest.srcFile ‘src/main/debug/AndroidManifest.xml’

}else {

manifest.srcFile ‘src/main/AndroidManifest.xml’

}

由于library是不需要 Application 和启动Activity页，所以我们要区分这个文件，应用manifest指定的路径没有特定，随意找个路径创建即可。在应用AndroidManifest.xml里我们要设置启动页：

<manifest xmlns:android=“http://schemas.android.com/apk/res/android”

package=“com.sun.biz_home”>

<application

android:allowBackup=“true”

android:label=“@string/home_app_name”

android:supportsRtl=“true”

android:theme=“@style/home_AppTheme”>

library 的 AndroidManifest.xml 不需要这些：

<manifest xmlns:android=“http://schemas.android.com/apk/res/android”

package=“com.sun.biz_home”>

gradle 依赖 module 的方式主要有两种：

implementation: A implementation B，B implementation C，但 A 不能访问到 C 的东西。
api：A api B，B api C，A能访问到C的东西。

一般来说我们只需要使用 implementation 即可，api 是会造成项目编译时间变长，而且会引入该模块不需要的功能，代码之间耦合变得严重了。不过 module_common 是统一了基础组件版本的公共库，所有组件都应需要依赖它并拥有基础组件的能力，所以基本每个业务组件和业务基础组件都应该依赖公共库：

dependencies {

implementation project(‘:module_common’)

}

而 common 组件依赖基础组件应该是用 api，因为把基础组件的能力传递给上层业务组件：

dependencies {

api project(‘:module_base’)

api project(‘:module_util’)

}

多工程方案

多工程就是每个组件都是一个工程，例如创建一个工程后 app 作为壳组件，它依赖 biz_home 运行，因此不需要 isModule 来控制独立调试，它本身就是一个工程可以独立调试。

多工程的利弊就是和单工程相反的：

利：做到职责完全拆分，其他项目复用更加方便，直接一行依赖引入。
弊：修改后需要上传到maven仓库，其他工程再次编译后才能感知到变化，多了上传和编译的时间。

多工程组件依赖需要用到maven仓库。把每个组件的aar上传到公司内网的maven仓库，然后像这样去依赖：

implementation ‘com.xxx.xxx:module_common:1.0.0’

我们在学习组件化的过程中可以搭建一个maven仓库并把aar上传到我们自己搭建的maven仓库，这里是一篇搭建maven仓库和上传aar的介绍。注意一点，我们在开发阶段用snapshot快照版本不更改版本号上传，在发布release正式版时增加版本号并上传。

我们把三方库统一放到 config.gradle 内管理：

ext {

dependencies = [

“glide”: “com.github.bumptech.glide:glide:4.12.0”,

“glide-compiler”: “com.github.bumptech.glide:compiler:4.12.0”,

“okhttp3”: “com.squareup.okhttp3:okhttp:4.9.0”,

“retrofit”: “com.squareup.retrofit2:retrofit:2.9.0”,

“retrofit-converter-gson” : “com.squareup.retrofit2:converter-gson:2.9.0”,

“retrofit-adapter-rxjava2” : “com.squareup.retrofit2:adapter-rxjava2:2.9.0”,

“rxjava2”: “io.reactivex.rxjava2:rxjava:2.2.21”,

“arouter”: “com.alibaba:arouter-api:1.5.1”,

“arouter-compiler”: “com.alibaba:arouter-compiler:1.5.1”,

// our lib

“module_util”: “com.sun.module:module_util:1.0.0”,

“module_common”: “com.sun.module:module_common:1.0.0”,

“module_base”: “com.sun.module:module_base:1.0.0”,

“fun_splash”: “com.sun.fun:fun_splash:1.0.0”,

“fun_share”: “com.sun.fun:fun_share:1.0.0”,

“export_biz_home”: “com.sun.export:export_biz_home:1.0.0”,

“export_biz_me”: “com.sun.export:export_biz_me:1.0.0”,

“export_biz_msg”: “com.sun.export:export_biz_msg:1.0.0”,

“biz_home”: “com.sun.biz:biz_home:1.0.0”,

“biz_me”: “com.sun.biz:biz_me:1.0.0”,

“biz_msg”: “com.sun.biz:biz_msg:1.0.0”

]

}

这样方便版本统一管理，然后在根目录的 build.gradle 内导入：

apply from: ‘config.gradle’

最后在各自的模块引入依赖，比如在 module_common 中这么引入依赖即可。

dependencies {

api rootProject.ext.dependencies[“arouter”]

kapt rootProject.ext.dependencies[“arouter-compiler”]

api rootProject.ext.dependencies[“glide”]

api rootProject.ext.dependencies[“okhttp3”]

api rootProject.ext.dependencies[“retrofit”]

api rootProject.ext.dependencies[“retrofit-converter-gson”]

api rootProject.ext.dependencies[“retrofit-adapter-rxjava2”]

api rootProject.ext.dependencies[“rxjava2”]

api rootProject.ext.dependencies[“module_util”]

api rootProject.ext.dependencies[“module_base”]

}

个人觉得多工程适合"很大"的工程，每个业务组件可能都需要一个组开发，类似淘宝这样的app。但这只是针对业务组件来说的，业务基础组件和基础组件修改的频率不会很大，最好都是单工程上传至maven仓库来使用。本文的例子是为了方便所以把所有组件写到一起了，最好的方式就是把 fun_ 和 module_ 开头的组件都拆分成单工程独立开发，业务组件写到一个工程内。

页面跳转

做完组件之间的隔离后，暴露出来最明显的问题就是页面跳转和数据通信的问题。一般来说，页面跳转都是显示startActivity跳转，在组件化项目内就不适用了，隐式跳转可以用，但每个Activity都要写 intent-filter 就显得有点麻烦，所以最好的方式还是用路由框架。

实际上市面已经有比较成熟的路由框架专门就是为了组件化而生的，比如美团的WMRouter，阿里的ARouter等，本例使用 ARouter 框架，看下ARouter页面跳转的基本操作。

首先肯定是引入依赖，以 module_common 引入ARouter举例，build.gradle 应该添加：

android {

defaultConfig {

javaCompileOptions {

annotationProcessorOptions {

arguments = [AROUTER_MODULE_NAME: project.getName()]

}

compileOptions {

sourceCompatibility JavaVersion.VERSION_1_8

targetCompatibility JavaVersion.VERSION_1_8

}

dependencies {

api rootProject.ext.dependencies[“arouter”]

kapt rootProject.ext.dependencies[“arouter-compiler”]

}

kapt注解依赖没有办法传递，所以我们不可避免得需要在每个模块都声明这些配置，除了 api rootProject.ext.dependencies["arouter"] 这行。然后需要全局注册 ARouter，我是在 module_common 统一注册的。

class AppCommon: BaseApp{

override fun onCreate(application: Application) {

MLog.d(TAG, “BaseApp AppCommon init”)

initARouter(application)

}

private fun initARouter(application: Application) {

if(BuildConfig.DEBUG) {

ARouter.openLog()

ARouter.openDebug()

}

ARouter.init(application)

}

接着我们在 module_common 模块内声明一个路由表用作统一管理路径。

// RouterPath.kt

class RouterPath {

companion object {

const val APP_MAIN = “/app/MainActivity”

const val HOME_FRAGMENT = “/home/HomeFragment”

const val MSG_FRAGMENT = “/msg/MsgFragment”

const val ME_FRAGMENT = “/me/MeFragment”

const val MSG_PROVIDER = “/msg/MsgProviderImpl”

}

然后在MainActivity类文件上进行注解：

@Route(path = RouterPath.APP_MAIN)

class MainActivity : AppCompatActivity() {

}

任意模块只需要调用 ARouter.getInstance().build(RouterPath.APP_MAIN).navigation() 即可实现跳转。如果我们要加上数据传递也很方便：

ARouter.getInstance().build(RouterPath.APP_MAIN)

.withString(“key”, “value”)

.withObject(“key1”, obj)

.navigation()

然后在MainActivity使用依赖注入接受数据：

class MainActivity : AppCompatActivity() {

@Autowired

@JvmField

var key: String = “”

}

ARouter 基本能满足所有的跳转需求。

组件间通信

前面已经提到组件通信是通过”间接依赖“解耦的，也就是会出现第三个"组件"作为中间件。如果是按照顺序阅读本文的话，就会发现工程目录中有出现 export_ 前缀的模块，这个模块其实是暴露了组件对外的接口，比如首页模块biz_home对应的"下沉接口"模块就是 export_biz_home，外部想要访问 biz_home 的功能只需要依赖 export_biz_home。这种每一个组件对应一个"下沉接口"组件看起来有点冗余，但若是项目很大的时候，这种方式是比较清晰的。当然若项目较小，可以考虑把所有暴露的接口整合到一个”下沉接口“组件，也就是本文例子的 module_base，然后module_common依赖module_base，这样每个模块都能使用任意模块的向外暴露的功能了，如果觉得下沉接口过多或者你需要严格界定每个组件，那就不推荐用这种方式了。

我们现在假设都是在export_声明对外暴露接口，场景是：从首页模块发送数值给消息模块，我的模块可以从消息模块获取数值。接下来介绍两种通信的方式。