如何下载和引用 Gradle 中的单个工件？

Question

我正在创建一个 Gradle 任务，我想在其中下载和引用 Maven 存储库中存在的工件的 jar 文件。具体来说，我计划使用该 jar 的位置作为脚本的参数，通过 Gradle exec 任务调用外部脚本。使用 exec 任务很简单；我想弄清楚的是如何获取工件 jar 文件在文件系统上的位置。

作为一个简单而具体的示例，假设我的 Gradle 项目目录中有以下文件：

build.gradle:

task myScript(type: Exec) {
    executable './my_script.sh'
    args jarFilePath // How do I get this value?
}

my_script.sh:

#!/usr/bin/env bash
echo "Jar file location: "

如何获取工件 jar 的文件路径，必要时从远程存储库下载它？例如，如果它不在我的本地工件缓存中，或者它是更新的快照版本，则应该下载它。

Answer 1

假设我们想要的jar文件是guava-26.0-jre.jar。以下 build.gradle 文件将检索工件（如有必要）并将文件位置作为参数提供给脚本：

import java.nio.file.Files
import java.nio.file.Path
import java.nio.file.StandardCopyOption

repositories {
    mavenCentral()
}

configurations {
    myArtifact
}

dependencies {
    myArtifact group: 'com.google.guava', name: 'guava', 
            version: '26.0-jre', transitive: false
}

task myScript(type: Exec) {
    Path artifactPath = 
            temporaryDir.toPath().resolve('guava.jar').toAbsolutePath()

    doFirst {
        Files.copy(configurations.myArtifact.singleFile.toPath(), artifactPath,
                StandardCopyOption.REPLACE_EXISTING)
    }

    executable './my_script.sh'
    args artifactPath.toString()
}

这将创建一个名为“myArtifact”的自定义 configuration，它只依赖于 guava-26.0-jre。通过将其标记为 transitive: false none，工件的依赖项将包含在配置中，如果它们不存在于本地工件缓存中，也不会被下载。

对 configurations.myArtifact.singleFile returns 的调用是对工件 jar 文件的 java.io.File 引用。此 getSingleFile() 方法还确保集合中只有一个文件，如果有零个或多个则抛出 IllegalStateException。如果配置在未来被错误配置为具有多个工件（例如，如果有人从我们的脚本中删除了“传递”选项），这可以防止引用错误的工件。

toAbsolutePath() 方法确保脚本的路径是绝对路径，因此不需要相对于任何特定目录进行解析。

请注意，这是将工件复制到 the task's temporary directory in a doFirst 块，而不是直接引用文件的路径。这是为了在加载脚本时不需要解析工件。否则，即使在执行不相关的任务（包括 clean 和 tasks 等基本任务时，也需要解析（并可能下载）工件，如果工件无法解析，则会导致构建失败。

StandardCopyOption.REPLACE_EXISTING 选项用于覆盖以前构建的任何以前的 jar 文件。

Answer 2

以下带有复制任务的代码段 copyDependencies 适用于单个和多个依赖项。您可以定义依赖于此任务的任何其他任务（例如，键入 Exec）。

configurations {
    web {
        transitive = false
    }
}

dependencies {
    web "com.foo:foo-messaging:$version:@war",
            "com.foo:foo-ng:$version:@war"
}

task copyDependencies(type: Copy) {
    from configurations.web
    into "$buildDir/web"
}

如何下载和引用 Gradle 中的单个工件？

How can I download and reference a single artifact in Gradle?

dependency-management

gradle

dependency-resolution