使用 Gradle 版本目录进行依赖管理 - Android

  /  前言  /

在软件开发中，依赖管理是一个至关重要的方面。合理的依赖版本控制有助于确保项目的稳定性、安全性和可维护性。

Gradle版本目录（Version Catalogs）是 Gradle 构建工具的一个强大功能，它为项目提供了一种集中管理依赖版本的方式，使得团队协作更为高效。

/  什么是版本目录？/

Gradle版本目录是 Gradle 6.8 版本引入的一项新功能，它允许开发者将项目中使用的所有第三方依赖的版本信息集中管理在一个地方。

通过定义一个版本目录，你可以在一个文件中指定所有依赖的版本号，而不必在每个模块或构建文件中重复声明。

/  示例  /

1. 新建一个空项目

首先创建一个空白的 Android 项目，默认情况下我们的 Gradle 文件如下：

可以看到所有的依赖都是以字符串形式呈现，到后期项目越来越庞大时，对于开发者而言维护工作会大大增加。当然Gradle版本目录我相信在后期的 Android Studio 中以默认的形式存在。

不难看出，Android中的依赖项基本都是由相同部分组成，什么意思呢？即冒号(:)之前的就是所谓的依赖组，你可以理解为一个依赖组捆绑了多个相关的依赖项，冒号之后的就是它的组成部分。例如：

• 依赖组：androidx.compose.ui

• 间隔：冒号（:）

• 具体依赖：ui-graphics

2. 创建版本目录

在 gradle 文件中添加一个名为 libs.versions.toml 文件，添加完成后，点击 Sync 同步一下。

文件包含三个部分：版本块、依赖库块、插件块。

[versions]

[libraries]

[plugins]

3. 开始迁移依赖

回到 build.gradle 文件中，你会发现依赖项弹出了黄色高亮提示。

根据IDE提示可以智能的识别到版本目录的存在，然后一键替换，替换后会报错，我们需要同步一下即可。

来到版本目录，IDE自动地把依赖放到了对应的位置，如下图：

剩余的依赖同上依次迁移过去到版本目录即可，需要注意的是，像类似 compose-bom 已经统一了版本号的物料清单，被包含的依赖不再需要定义版本号并且不需要使用 module，而是使用 group。name 代表了具体的名字。

3. 迁移插件

接下来需要处理的另一处是我们的项目的插件部分，当然这部分没有提示，需要我们手动迁移过去。

迁移前

迁移后

在同步完成之后，如果 libs 出现以下报错问题可以参考博客解决：

博客：

https://github.com/gradle/gradle/issues/22797

源码：

https://github.com/AAnthonyyyy/VersionCatalogsGuide