Gradle - 手动下载依赖、锁定版本和更新依赖
Gradle - download dependencies, lock versions and update dependencies manually
问题。
Gradle 依赖管理是这样的:
- 没有简单的方法来检查依赖项更新的可用性(只能使用一些第三方插件,如 ben-manes/gradle-versions-plugin)和下载替换旧版本的更新;
- 依赖项工件从远程存储库下载,然后存储在 gradle 缓存中,并在后续构建中重复使用;但项目的成功编译不能依赖于与 Internet 的连接、远程存储库的可用性以及这些存储库中存在特定版本的依赖项。
目标。
- 下载所有依赖项目并将其存储在 VCS 中;
- 手动检查这些依赖项的更新并下载它们。
我的解决方案适用于使用 java
或 android
插件的 Gradle 配置。
java
插件定义了 compile
和 testCompile
配置。
compile
用于编译项目的生产源所需的依赖项。 testCompile
是编译项目测试源码需要的依赖。
让我们在build.gradle
中定义我们自己的配置:
configurations {
download
testDownload
}
接下来让我们创建目录:
libs/compile/downloaded
是存储 download
依赖项的地方;
libs/testCompile/downloaded
是存储 testDownload
依赖项的地方。
接下来我们定义几个任务。
从 download
配置中删除依赖项:
task cleanDownloadedDependencies(type: Delete) {
delete fileTree('libs/compile/downloaded')
}
从 testDownload
配置中删除依赖项:
task cleanDownloadedTestDependencies(type: Delete) {
delete fileTree('libs/testCompile/downloaded')
}
从 download
配置下载依赖项:
task downloadDependencies(type: Copy) {
from configurations.download
into "libs/compile/downloaded/"
}
从 testDownload
配置下载依赖项:
task downloadTestDependencies(type: Copy) {
from configurations.testDownload
into "libs/testCompile/downloaded/"
}
执行以上所有任务以更新依赖项:
task updateDependencies {
dependsOn cleanDownloadedDependencies, cleanDownloadedTestDependencies, downloadDependencies, downloadTestDependencies
}
接下来我们定义依赖项:
dependencies {
download(
'com.google.code.gson:gson:+',
'joda-time:joda-time:+',
)
testDownload(
'junit:junit:+'
)
然后我们告诉 compile
和 testCompile
配置应该在哪里获取用于编译的依赖项。
compile fileTree(dir: 'libs/compile', include: '**/*.jar')
testCompile fileTree(dir: 'libs/testCompile', include: '**/*.jar')
}
现在您可以下载或更新已下载的依赖项:
./gradlew updateDependencies
如果您正在使用 android
插件,那么您还可以为 Android 设备上的编译和 运行 测试所需的依赖项添加 androidTestDownload
配置。还可以将一些依赖项作为 aar
工件提供。
这是使用 android
插件的 Gradle 配置示例:
...
repositories {
...
flatDir {
dirs 'libs/compile', 'libs/compile/downloaded',
'libs/testCompile', 'libs/testCompileDownloaded',
'libs/androidTestCompile', 'libs/androidTestCompile/downloaded'
}
}
configurations {
download
testDownload
androidTestDownload
}
android {
...
}
dependencies {
download(
'com.android.support:support-v4:+',
'com.android.support:appcompat-v7:+',
'com.google.android.gms:play-services-location:+',
'com.facebook.android:facebook-android-sdk:+',
'com.vk:androidsdk:+',
'com.crashlytics.sdk.android:crashlytics:+',
'oauth.signpost:signpost-core:+',
'oauth.signpost:signpost-commonshttp4:+',
'org.twitter4j:twitter4j-core:+',
'commons-io:commons-io:+',
'com.google.code.gson:gson:+',
'org.jdeferred:jdeferred-android-aar:+'
)
compile fileTree(dir: 'libs/compile', include: '**/*.jar')
testCompile fileTree(dir: 'libs/testCompile', include: '**/*.jar')
androidTestCompile fileTree(dir: 'libs/androidTestCompile', include: '**/*.jar')
}
task cleanDownloadedDependencies(type: Delete) {
delete fileTree('libs/compile/downloaded')
}
task cleanDownloadedTestDependencies(type: Delete) {
delete fileTree('libs/testCompile/downloaded')
}
task cleanDownloadedAndroidTestDependencies(type: Delete) {
delete fileTree('libs/androidTestCompile/downloaded')
}
task downloadDependencies(type: Copy) {
from configurations.download
into 'libs/compile/downloaded/'
}
task downloadTestDependencies(type: Copy) {
from configurations.testDownload
into 'libs/testCompile/downloaded/'
}
task downloadAndroidTestDependencies(type: Copy) {
from configurations.androidTestDownload
into 'libs/androidTestCompile/downloaded/'
}
task updateDependencies {
dependsOn cleanDownloadedDependencies, cleanDownloadedTestDependencies, cleanDownloadedAndroidTestDependencies, downloadDependencies, downloadTestDependencies, downloadAndroidTestDependencies
}
fileTree(dir: 'libs/compile', include: '**/*.aar')
.each { File file ->
dependencies.add("compile",
[name: file.name.lastIndexOf('.').with { it != -1 ? file.name[0..<it] : file.name }, ext: 'aar'])
}
fileTree(dir: 'libs/testCompile', include: '**/*.aar')
.each { File file ->
dependencies.add("testCompile",
[name: file.name.lastIndexOf('.').with { it != -1 ? file.name[0..<it] : file.name }, ext: 'aar'])
}
fileTree(dir: 'libs/androidTestCompile', include: '**/*.aar')
.each { File file ->
dependencies.add("androidTestCompile",
[name: file.name.lastIndexOf('.').with { it != -1 ? file.name[0..<it] : file.name }, ext: 'aar'])
}
对于下载依赖项的锁定版本(库/等版本到硬编码版本)以使构建可重现,现在 Gradle 4.8 及更高版本,我们将内置 "dependency lock" 支持。如果有人使用动态版本 (M.m.p/i) Major.minor.patch/interimBranch 等(例如:4.+ 或 3.1.+),这将极大地帮助构建可重现或从二进制存储库工具中提取工件的版本范围(例如:Artifactory / Nexus)。
任何使用 Gradle 4.8+ 版本的 Gradle 用户都应该开始使用这个新功能。
https://docs.gradle.org/4.8/userguide/dependency_locking.html
对于 Gradle 4.8 发行说明:https://docs.gradle.org/4.8/release-notes.html
过去,此依赖项锁定功能已提供给 Gradle 社区,并通过 Netflix Nebula https://github.com/nebula-plugins/gradle-dependency-lock-plugin and https://plugins.gradle.org/plugin/nebula.dependency-lock
的 Gradle 可用的 FOSS 插件提供
问题。
Gradle 依赖管理是这样的:
- 没有简单的方法来检查依赖项更新的可用性(只能使用一些第三方插件,如 ben-manes/gradle-versions-plugin)和下载替换旧版本的更新;
- 依赖项工件从远程存储库下载,然后存储在 gradle 缓存中,并在后续构建中重复使用;但项目的成功编译不能依赖于与 Internet 的连接、远程存储库的可用性以及这些存储库中存在特定版本的依赖项。
目标。
- 下载所有依赖项目并将其存储在 VCS 中;
- 手动检查这些依赖项的更新并下载它们。
我的解决方案适用于使用 java
或 android
插件的 Gradle 配置。
java
插件定义了 compile
和 testCompile
配置。
compile
用于编译项目的生产源所需的依赖项。 testCompile
是编译项目测试源码需要的依赖。
让我们在build.gradle
中定义我们自己的配置:
configurations {
download
testDownload
}
接下来让我们创建目录:
libs/compile/downloaded
是存储download
依赖项的地方;libs/testCompile/downloaded
是存储testDownload
依赖项的地方。
接下来我们定义几个任务。
从 download
配置中删除依赖项:
task cleanDownloadedDependencies(type: Delete) {
delete fileTree('libs/compile/downloaded')
}
从 testDownload
配置中删除依赖项:
task cleanDownloadedTestDependencies(type: Delete) {
delete fileTree('libs/testCompile/downloaded')
}
从 download
配置下载依赖项:
task downloadDependencies(type: Copy) {
from configurations.download
into "libs/compile/downloaded/"
}
从 testDownload
配置下载依赖项:
task downloadTestDependencies(type: Copy) {
from configurations.testDownload
into "libs/testCompile/downloaded/"
}
执行以上所有任务以更新依赖项:
task updateDependencies {
dependsOn cleanDownloadedDependencies, cleanDownloadedTestDependencies, downloadDependencies, downloadTestDependencies
}
接下来我们定义依赖项:
dependencies {
download(
'com.google.code.gson:gson:+',
'joda-time:joda-time:+',
)
testDownload(
'junit:junit:+'
)
然后我们告诉 compile
和 testCompile
配置应该在哪里获取用于编译的依赖项。
compile fileTree(dir: 'libs/compile', include: '**/*.jar')
testCompile fileTree(dir: 'libs/testCompile', include: '**/*.jar')
}
现在您可以下载或更新已下载的依赖项:
./gradlew updateDependencies
如果您正在使用 android
插件,那么您还可以为 Android 设备上的编译和 运行 测试所需的依赖项添加 androidTestDownload
配置。还可以将一些依赖项作为 aar
工件提供。
这是使用 android
插件的 Gradle 配置示例:
...
repositories {
...
flatDir {
dirs 'libs/compile', 'libs/compile/downloaded',
'libs/testCompile', 'libs/testCompileDownloaded',
'libs/androidTestCompile', 'libs/androidTestCompile/downloaded'
}
}
configurations {
download
testDownload
androidTestDownload
}
android {
...
}
dependencies {
download(
'com.android.support:support-v4:+',
'com.android.support:appcompat-v7:+',
'com.google.android.gms:play-services-location:+',
'com.facebook.android:facebook-android-sdk:+',
'com.vk:androidsdk:+',
'com.crashlytics.sdk.android:crashlytics:+',
'oauth.signpost:signpost-core:+',
'oauth.signpost:signpost-commonshttp4:+',
'org.twitter4j:twitter4j-core:+',
'commons-io:commons-io:+',
'com.google.code.gson:gson:+',
'org.jdeferred:jdeferred-android-aar:+'
)
compile fileTree(dir: 'libs/compile', include: '**/*.jar')
testCompile fileTree(dir: 'libs/testCompile', include: '**/*.jar')
androidTestCompile fileTree(dir: 'libs/androidTestCompile', include: '**/*.jar')
}
task cleanDownloadedDependencies(type: Delete) {
delete fileTree('libs/compile/downloaded')
}
task cleanDownloadedTestDependencies(type: Delete) {
delete fileTree('libs/testCompile/downloaded')
}
task cleanDownloadedAndroidTestDependencies(type: Delete) {
delete fileTree('libs/androidTestCompile/downloaded')
}
task downloadDependencies(type: Copy) {
from configurations.download
into 'libs/compile/downloaded/'
}
task downloadTestDependencies(type: Copy) {
from configurations.testDownload
into 'libs/testCompile/downloaded/'
}
task downloadAndroidTestDependencies(type: Copy) {
from configurations.androidTestDownload
into 'libs/androidTestCompile/downloaded/'
}
task updateDependencies {
dependsOn cleanDownloadedDependencies, cleanDownloadedTestDependencies, cleanDownloadedAndroidTestDependencies, downloadDependencies, downloadTestDependencies, downloadAndroidTestDependencies
}
fileTree(dir: 'libs/compile', include: '**/*.aar')
.each { File file ->
dependencies.add("compile",
[name: file.name.lastIndexOf('.').with { it != -1 ? file.name[0..<it] : file.name }, ext: 'aar'])
}
fileTree(dir: 'libs/testCompile', include: '**/*.aar')
.each { File file ->
dependencies.add("testCompile",
[name: file.name.lastIndexOf('.').with { it != -1 ? file.name[0..<it] : file.name }, ext: 'aar'])
}
fileTree(dir: 'libs/androidTestCompile', include: '**/*.aar')
.each { File file ->
dependencies.add("androidTestCompile",
[name: file.name.lastIndexOf('.').with { it != -1 ? file.name[0..<it] : file.name }, ext: 'aar'])
}
对于下载依赖项的锁定版本(库/等版本到硬编码版本)以使构建可重现,现在 Gradle 4.8 及更高版本,我们将内置 "dependency lock" 支持。如果有人使用动态版本 (M.m.p/i) Major.minor.patch/interimBranch 等(例如:4.+ 或 3.1.+),这将极大地帮助构建可重现或从二进制存储库工具中提取工件的版本范围(例如:Artifactory / Nexus)。
任何使用 Gradle 4.8+ 版本的 Gradle 用户都应该开始使用这个新功能。 https://docs.gradle.org/4.8/userguide/dependency_locking.html 对于 Gradle 4.8 发行说明:https://docs.gradle.org/4.8/release-notes.html
过去,此依赖项锁定功能已提供给 Gradle 社区,并通过 Netflix Nebula https://github.com/nebula-plugins/gradle-dependency-lock-plugin and https://plugins.gradle.org/plugin/nebula.dependency-lock
的 Gradle 可用的 FOSS 插件提供