Android Gradle Plugin 高级用法：多模块构建、依赖管理与自定义构建类型

Android 项目的规模日益增长，单一模块的项目变得难以维护和扩展。Gradle 作为 Android 官方推荐的构建工具，提供了强大的多模块构建能力、灵活的依赖管理以及自定义构建类型的特性，帮助开发者构建可维护、可扩展、高效的 Android 项目。本文将深入探讨 Android Gradle Plugin 的高级用法，重点介绍多模块构建、依赖管理与自定义构建类型，并通过实例演示如何利用这些特性优化项目结构和构建流程。

一、多模块构建：拆分复杂项目，提升开发效率

多模块构建是一种将大型项目拆分为多个独立模块的架构模式。每个模块都可以独立编译、测试和部署，从而提高开发效率、代码复用性和项目可维护性。

1. 为什么要使用多模块构建？

提高编译速度： 模块化后，每次修改代码只需编译相关的模块，无需编译整个项目，大大缩短编译时间。
提升代码复用性： 将通用功能抽取为独立的模块，可以在多个项目中复用，避免重复开发。
降低耦合度： 模块之间通过明确的接口进行交互，降低模块间的耦合度，提高代码的可维护性和可测试性。
方便团队协作： 将项目分配给不同的团队或开发者负责不同的模块，提高团队协作效率。
支持增量构建： Gradle 可以智能地识别哪些模块需要重新构建，哪些模块不需要，从而实现增量构建，进一步提高编译速度。

2. 多模块项目的结构

一个典型的多模块 Android 项目通常包含以下几种类型的模块：

app 模块： 主应用程序模块，负责用户界面和业务逻辑的整合。
library 模块： 库模块，包含可复用的代码和资源，可以被其他模块或项目引用。
feature 模块： 功能模块，包含特定功能的代码和资源，可以按需加载和安装。
data 模块： 数据模块，负责数据访问、存储和管理。
domain 模块： 领域模型模块，包含业务逻辑和数据模型。

项目结构示例：

MyProject/ ├── settings.gradle ├── build.gradle ├── app/ │ ├── build.gradle │ └── ... ├── feature_login/ │ ├── build.gradle │ └── ... ├── library_common/ │ ├── build.gradle │ └── ... └── data/ ├── build.gradle └── ...

3. 实现多模块构建

要实现多模块构建，需要进行以下步骤：

在 settings.gradle 文件中声明所有模块：

gradle include ':app' include ':feature_login' include ':library_common' include ':data'
在每个模块的 build.gradle 文件中声明模块类型：
- app 模块：
  
  “`gradle
  plugins {
  id ‘com.android.application’
  id ‘org.jetbrains.kotlin.android’
  }
  
  android {
  // …
  }
  
  dependencies {
  implementation project(‘:library_common’)
  implementation project(‘:data’)
  implementation project(‘:feature_login’) // 动态特性模块需要使用 implementation
  // …
  }
  “`
- library 模块：
  
  “`gradle
  plugins {
  id ‘com.android.library’
  id ‘org.jetbrains.kotlin.android’
  }
  
  android {
  // …
  }
  
  dependencies {
  // …
  }
  “`
- feature 模块 (Dynamic Feature Module)：
  
  “`gradle
  plugins {
  id ‘com.android.dynamic-feature’
  id ‘org.jetbrains.kotlin.android’
  }
  
  android {
  // …
  baseFeature true
  }
  
  dependencies {
  implementation project(‘:app’) // 必须依赖 app 模块
  // …
  }
  “`
模块间的依赖关系：

在模块的 build.gradle 文件中使用 implementation project(':module_name') 来声明对其他模块的依赖。使用 api 关键字可以让依赖传递，例如 A 依赖 B，B 依赖 C，那么 A 可以直接访问 C。implementation 则不能传递，A 只能访问 B。
kapt 用来处理 Kotlin 的注解处理器，如果模块需要使用注解处理器，需要使用 kapt project(':module_name') 。
同步 Gradle：

修改 settings.gradle 或 build.gradle 文件后，需要同步 Gradle 才能生效。

4. 注意事项

模块划分要合理，避免过度划分或划分不足。
模块间的依赖关系要清晰，避免循环依赖。
使用版本控制工具管理代码，方便团队协作。
使用持续集成/持续部署 (CI/CD) 工具自动化构建、测试和部署流程。
动态特性模块需要使用 Android App Bundle (AAB) 才能正常工作。

二、依赖管理：统一依赖版本，简化依赖声明

依赖管理是 Gradle 的一个重要特性，它可以帮助开发者统一依赖版本、简化依赖声明、解决依赖冲突，从而提高构建效率和项目稳定性。

1. 依赖声明方式

Gradle 提供了多种依赖声明方式：

implementation： 依赖只对当前模块可见，不会传递到其他模块。
api： 依赖对当前模块和其他依赖当前模块的模块可见，会传递到其他模块。
compileOnly： 依赖只在编译时需要，运行时不需要。
runtimeOnly： 依赖只在运行时需要，编译时不需要。
testImplementation： 依赖只在单元测试时需要。
androidTestImplementation： 依赖只在 Android instrumentation tests 时需要。
kapt： 用于 Kotlin Annotation Processing Tool，处理注解处理器。

2. 版本管理

使用版本变量： 在项目的 build.gradle 文件中定义版本变量，然后在模块的 build.gradle 文件中使用这些变量。

gradle ext { kotlin_version = '1.8.0' appcompat_version = '1.6.1' material_version = '1.10.0' }

gradle dependencies { implementation "androidx.appcompat:appcompat:$appcompat_version" implementation "com.google.android.material:material:$material_version" implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" // ... }
使用 dependencies 块： 在 build.gradle 文件中使用 dependencies 块来集中管理依赖版本。

“`gradle
dependencies {
implementation “androidx.appcompat:appcompat:${versions.appcompat}”
implementation “com.google.android.material:material:${versions.material}”
}

ext.versions = [
appcompat: “1.6.1”,
material: “1.10.0”
]
“`
使用版本目录 (Version Catalogs): 这是官方推荐的依赖版本管理方式，使用 libs.versions.toml 文件集中管理依赖，类型安全，方便使用。

在 settings.gradle.kts 文件中配置：

kotlin dependencyResolutionManagement { versionCatalogs { create("libs") { from(files("./gradle/libs.versions.toml")) } } }

创建 gradle/libs.versions.toml 文件：

“`toml
[versions]
androidx-appcompat = “1.6.1”
material = “1.10.0”
kotlin = “1.8.0”

[libraries]
androidx-appcompat = { module = “androidx.appcompat:appcompat”, version.ref = “androidx-appcompat” }
material = { module = “com.google.android.material:material”, version.ref = “material” }
kotlin-stdlib = { module = “org.jetbrains.kotlin:kotlin-stdlib-jdk8”, version.ref = “kotlin” }
“`

然后在模块的 build.gradle.kts 文件中使用：

kotlin dependencies { implementation(libs.androidx.appcompat) implementation(libs.material) implementation(libs.kotlin.stdlib) }

3. 解决依赖冲突

当项目中存在多个版本的同一个依赖库时，可能会发生依赖冲突。Gradle 提供了多种方式来解决依赖冲突：

force： 强制使用指定的版本。

gradle dependencies { implementation("com.example:library:1.0") { force = true } }
exclude： 排除指定的依赖。

gradle dependencies { implementation("com.example:library:1.0") { exclude group: 'com.google.code.gson', module: 'gson' } }
resolutionStrategy： 使用 Gradle 的解析策略来解决冲突。

gradle configurations.all { resolutionStrategy { force 'com.google.code.gson:gson:2.8.6' } }

三、自定义构建类型：灵活配置构建选项

Android Gradle Plugin 提供了多种构建类型，例如 debug 和 release。开发者可以自定义构建类型，以便根据不同的构建需求配置不同的构建选项。

1. 创建自定义构建类型

在模块的 build.gradle 文件中，可以在 android 块的 buildTypes 块中创建自定义构建类型。

gradle android { buildTypes { debug { // ... } release { // ... } staging { // 自定义构建类型 initWith debug minifyEnabled true shrinkResources true proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' applicationIdSuffix ".staging" signingConfig signingConfigs.debug // 或者自定义一个 staging 的签名配置 } } }

2. 配置构建选项

在自定义构建类型中，可以配置各种构建选项，例如：

minifyEnabled： 是否启用代码混淆。
shrinkResources： 是否启用资源缩减。
proguardFiles： 指定 ProGuard 配置文件。
debuggable： 是否启用调试模式。
signingConfig： 指定签名配置。
applicationIdSuffix： 指定应用 ID 后缀。
versionNameSuffix： 指定版本名称后缀。
resValue： 定义资源值，可以在代码中使用。
buildConfigField： 定义构建配置字段，可以在代码中使用。

3. 使用自定义构建类型

可以在 Gradle tasks 中指定使用哪个构建类型。例如，使用 assembleStaging 构建 staging 构建类型的 APK。也可以在 Android Studio 中选择构建变体 (Build Variants) 来构建不同构建类型的 APK。

4. 产品风味 (Product Flavors)

除了构建类型，Gradle 还提供了产品风味 (Product Flavors) 的概念。产品风味用于构建具有不同功能或特性的 APK。例如，可以创建 free 和 paid 两种产品风味。产品风味可以与构建类型结合使用，例如 debugFree、releaseFree、debugPaid、releasePaid。

“`gradle
android {
flavorDimensions “version” // 至少定义一个 flavorDimension

productFlavors {
    free {
        dimension "version"
        applicationIdSuffix ".free"
        versionNameSuffix "-free"
    }
    paid {
        dimension "version"
        applicationIdSuffix ".paid"
        versionNameSuffix "-paid"
    }
}

}
“`

四、总结

Android Gradle Plugin 提供了强大的构建能力，包括多模块构建、依赖管理和自定义构建类型。通过合理利用这些特性，可以构建可维护、可扩展、高效的 Android 项目。

多模块构建 可以将大型项目拆分为多个独立模块，提高开发效率、代码复用性和项目可维护性。
依赖管理 可以统一依赖版本、简化依赖声明、解决依赖冲突，从而提高构建效率和项目稳定性。推荐使用Version Catalogs管理依赖。
自定义构建类型 可以根据不同的构建需求配置不同的构建选项，例如代码混淆、资源缩减、签名配置等。产品风味可以构建具有不同功能或特性的 APK。

掌握这些高级用法，可以帮助开发者更好地管理 Android 项目，提高开发效率，并构建高质量的 Android 应用。在实际开发中，需要根据项目需求灵活运用这些特性，并不断学习和探索新的 Gradle 技巧，才能更好地应对复杂的 Android 项目构建挑战。

Android Gradle Plugin 高级用法：多模块构建、依赖管理与自定义构建类型

发表评论 取消回复

发表评论取消回复