Android 工程组件化实践

本文记录将一个新工程按组件化配置的过程及过程中遇到的问题。

一、工程最终结构

首先看下工程的最终结构,其中包括主模块、组件模块(也就是可以单独打包的子模块)、 lib 模块(又包括:基础lib,普通lib)。
如图:


工程结构

各个模块的详细介绍:

  • app:入口作用,最终发版打包的模块;
  • common:包括组件模块中共用的依赖、activity、工具类等其他可能会共用的,比如 ARouter 的依赖、登录activity 等可以放到该模块中,注意:主模块及组件模块要分别依赖该模块;
  • easyvideoplayer:就是普通的lib模块,哪儿个模块需要就去哪儿个模块添加依赖,下文中不再说这个模块相关的配置;
  • usercenter:用户中心组件模块。

二、创建工程及模块

创建工程其中包含主模块 app,并新建模块(正常应用模块,非 Android Library 类型):common、usercenter。

1. 在工程 build.gradle 中添加:

ext {
    // 定义版本号,模块中版本号保持一致
    compileSdkVersion = 29
    buildToolsVersion = '29.0.2'
    minSdkVersion = 18
    targetSdkVersion = 29
    
    // 定义 applicationId
    applicationId = 'com.hyh.trytodo'

    // 控制组件化是否可以打组件包,想打组件包时改为:true
    isRunModule = false
}

2. app 模块需要配置:

  • 文件 build.gradle 中:
api project(':common')
// 非组件化打包时添加模块依赖
if (!rootProject.ext.isRunModule) {
    implementation project(':usercenter')
}

3. common 模块中需要修改文件:

  • 文件 build.gradle 中:
    apply plugin: 'com.android.application' 改为 apply plugin: 'com.android.library'
    版本号使用工程 build.gradle 文件中定义的
    compileSdkVersion rootProject.ext.compileSdkVersion
    buildToolsVersion rootProject.ext.buildToolsVersion
    删除 applicationId xxx
  • AndroidManifest.xml 中:删除 <application> 中的所有属性,添加 activity 中也要在该文件中添加声明。

4. usercenter 模块中需要修改文件:

  • 在目录 main/ 下创建 degub/ 目录,并将该模块中的 AndroidManifest.xml 复制到该目录,之后新建的 activity 要在该文件中声明。
  • AndroidManifest.xml 中:删除 <application> 中的所有属性。
  • 文件 build.gradle 中:
if (rootProject.ext.isRunModule) {
   apply plugin: 'com.android.application'
} else {
   apply plugin: 'com.android.library'
}

android {
   compileSdkVersion rootProject.ext.compileSdkVersion
   buildToolsVersion rootProject.ext.buildToolsVersion

   defaultConfig {
       if (isRunModule) {
           applicationId rootProject.ext.applicationId
       }
       minSdkVersion rootProject.ext.minSdkVersion
       targetSdkVersion rootProject.ext.targetSdkVersion
   }
   ....
   sourceSets {
       main {
           if (isRunModule) {
               manifest.srcFile 'src/main/debug/AndroidManifest.xml'
           } else {
               manifest.srcFile 'src/main/AndroidManifest.xml'
               java {
                   exclude '**/debug/**'
               }
           }
       }
   }
}

到此工程及模块配置已经完成,接下来就是添加代码。

4. ARouter 配置及使用参考官方文件,不在赘述。

过程中遇到的问题:

1. 明明在 common 中添加了RxJava 的依赖,在 app 中也添加了 common 的依赖,但是在 app 中还是不能使用 RxJava 相关的方法。

出现该问题:需要看下依赖 RxJava 的语句是使用的 api 还是 implementation。只有使用 api 时,app 中才能正常使用。出现同样问题可以先排查这离

2. ARouter 提示:"W/ARouter::: ARouter::There is no route match the path [/xxx/xxx], in group [xxx][ ]"

ARouter 的主要配置是在 common 的 build.gradle 文件中配置,然后各个需要使用 ARouter 的模块去依赖 common,但是光这样是不行的,还需要添加下面的配置:

android {
    defaultConfig {
        .....
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [AROUTER_MODULE_NAME: project.getName()]
            }
        }
    }
}

dependencies {
    annotationProcessor 'com.alibaba:arouter-compiler:1.2.2'
}

推荐阅读更多精彩内容