版本帝 Gradle 最新版本已经到了 8.1.1 ,你是不是还在用着 Gradle 3 的功能?今天我们了解一下 Gradle 7.0 之后推出的新功能 Version Catalog 版本目录。
Gradle 版本目录是 Gradle7 中引入的新功能。使用 Gradle 版本目录,您可以在拥有多个模块时更轻松地管理依赖项和插件。您不必对各个 build 文件中的依赖项名称和版本进行硬编码,也不必在每次需要升级依赖项时都更新每个条目,而是可以创建一个包含依赖项的中央版本目录。
首先创建一个版本目录文件。在根项目的 gradle
文件夹中,创建一个名为 libs.versions.toml
的文件。Gradle 默认会在 libs.versions.toml
文件中查找目录,因此我们建议使用此默认名称。
注意:您可以更改目录文件名;但是,这需要更改 build 文件,因此不建议这样做。
在 libs.versions.toml
文件中,添加以下内容:
[versions]
[libraries]
[bundles]
[plugins]
versions
部分用于声明可以被依赖项引用的版本libraries
部分用于声明坐标的别名bundles
部分用于声明依赖包plugins
部分用于声明插件先看一下之前我们是如何引入依赖项的:
dependencies {
implementation 'com.jcraft:jsch:0.1.55'
}
迁移到版本目录后的引入方式:
# libs.versions.toml 文件
[versions]
jsch = "0.1.55"
[libraries]
jsch = { group = "com.jcraft", name = "jsch", version.ref = "jsch" }
# build.gradle 文件
dependencies {
implementation libs.jsch
}
从上面的简单例子中,我们可以从libs
中通过别名jsch
获取 jsch 的依赖项。下面介绍几种复杂的例子:
别名 | 访问名称 |
---|---|
guava | libs.guava |
commons-lang3 | libs.commons.lang3 |
androidx.awesome.lib | libs.androidx.awesome.lib |
在声明依赖项的别名时建议使用
kebab-case
(例如 commons-lang3),以便在 build 文件中获得更好的代码补全帮助。
如果有多个依赖项强关联,必须同时引用的情况,如下:
dependencies {
implementation 'org.junit.jupiter:junit-jupiter-api:5.9.3'
implementation 'org.junit.jupiter:junit-jupiter-engine:5.9.3'
implementation 'org.junit.jupiter:junit-jupiter-params:5.9.3'
}
我们可以在libs.versions.toml
文件中使用bundles
将其打成一个包:
[versions]
jupiter = "5.9.3"
[libraries]
junit-jupiter-api = { group = "org.junit.jupiter", name = "junit-jupiter-api", version.ref = "jupiter" }
junit-jupiter-engine = { group = "org.junit.jupiter", name = "junit-jupiter-engine", version.ref = "jupiter" }
junit-jupiter-params = { group = "org.junit.jupiter", name = "junit-jupiter-params", version.ref = "jupiter" }
[bundles]
junit-jupiter = ["junit-jupiter-api", "junit-jupiter-engine", "junit-jupiter-params"]
然后在build.gradle中引用:
dependencies {
implementation libs.junit.jupiter
}
迁移插件与依赖项的迁移一样,在 libs.versions.toml
文件的 [versions] 和 [plugins] 部分,为每个插件添加一个条目。然后将 build.gradle
文件中 plugins{} 代码块内的声明替换为相应的目录名称。
以下代码段展示了移除插件之前的 build.gradle
文件:
plugins {
id("com.android.application")
}
迁移后:
[versions]
androidGradlePlugin = "7.4.1"
[plugins]
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
plugins {
id(libs.plugins.android.application)
}
以上就是对 Gradle 版本目录功能的简单应用,统一管理依赖项版本,十分方便。
全部0条评论
快来发表一下你的评论吧 !