自定义发布 - Gradle 构建系统

修改和添加变体到现有组件以进行发布

Gradle 的发布模型基于组件的概念，组件由插件定义。例如，Java Library 插件定义了一个 java 组件，它对应于一个库，但 Java Platform 插件定义了另一种组件，名为 javaPlatform，它实际上是一种不同类型的软件组件（平台）。

有时我们想要向现有组件添加更多变体或修改现有组件的现有变体。例如，如果您为不同的平台添加了 Java 库的变体，您可能只想在 java 组件本身上声明此额外的变体。通常，声明额外的变体通常是发布额外工件的最佳解决方案。

为了执行此类添加或修改，AdhocComponentWithVariants 接口声明了两个名为 addVariantsFromConfiguration 和 withVariantsFromConfiguration 的方法，它们接受两个参数

用作变体来源的出站配置
允许您过滤将要发布的变体的自定义操作

要使用这些方法，您必须确保您使用的 SoftwareComponent 本身是 AdhocComponentWithVariants，Java 插件（Java、Java Library、Java Platform）创建的组件就是这种情况。添加变体非常简单

示例 1. 向现有软件组件添加变体

InstrumentedJarsPlugin.kt

val javaComponent = components.findByName("java") as AdhocComponentWithVariants
javaComponent.addVariantsFromConfiguration(outgoing) {
    // dependencies for this variant are considered runtime dependencies
    mapToMavenScope("runtime")
    // and also optional dependencies, because we don't want them to leak
    mapToOptional()
}

InstrumentedJarsPlugin.groovy

AdhocComponentWithVariants javaComponent = (AdhocComponentWithVariants) project.components.findByName("java")
javaComponent.addVariantsFromConfiguration(outgoing) {
    // dependencies for this variant are considered runtime dependencies
    it.mapToMavenScope("runtime")
    // and also optional dependencies, because we don't want them to leak
    it.mapToOptional()
}

在其他情况下，您可能想要修改 Java 插件已经添加的变体。例如，如果您激活了 Javadoc 和源代码的发布，它们将成为 java 组件的附加变体。如果您只想发布其中一个，例如仅 Javadoc 但不发布源代码，您可以修改 sources 变体以使其不被发布

示例 2. 发布带有 Javadoc 但不带源代码的 java 库

build.gradle.kts

java {
    withJavadocJar()
    withSourcesJar()
}

val javaComponent = components["java"] as AdhocComponentWithVariants
javaComponent.withVariantsFromConfiguration(configurations["sourcesElements"]) {
    skip()
}

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            from(components["java"])
        }
    }
}

build.gradle

java {
    withJavadocJar()
    withSourcesJar()
}

components.java.withVariantsFromConfiguration(configurations.sourcesElements) {
    skip()
}

publishing {
    publications {
        mavenJava(MavenPublication) {
            from components.java
        }
    }
}

创建和发布自定义组件

在前面的示例中，我们演示了如何扩展或修改现有组件，例如 Java 插件提供的组件。但是 Gradle 也允许您构建自定义组件（不是 Java Library，不是 Java Platform，不是 Gradle 原生支持的东西）。

要创建自定义组件，您首先需要创建一个空的临时组件。目前，这只能通过插件来实现，因为您需要获得 SoftwareComponentFactory 的句柄

示例 3. 注入软件组件工厂

InstrumentedJarsPlugin.kt

class InstrumentedJarsPlugin @Inject constructor(
    private val softwareComponentFactory: SoftwareComponentFactory) : Plugin<Project> {

InstrumentedJarsPlugin.groovy

private final SoftwareComponentFactory softwareComponentFactory

@Inject
InstrumentedJarsPlugin(SoftwareComponentFactory softwareComponentFactory) {
    this.softwareComponentFactory = softwareComponentFactory
}

声明自定义组件发布什么仍然通过 AdhocComponentWithVariants API 完成。对于自定义组件，第一步是创建自定义出站变体，按照本章中的说明进行操作。在这个阶段，您应该拥有可以在跨项目依赖关系中使用的变体，但我们现在要将它们发布到外部仓库。

示例 4. 创建自定义临时组件

InstrumentedJarsPlugin.kt

// create an adhoc component
val adhocComponent = softwareComponentFactory.adhoc("myAdhocComponent")
// add it to the list of components that this project declares
components.add(adhocComponent)
// and register a variant for publication
adhocComponent.addVariantsFromConfiguration(outgoing) {
    mapToMavenScope("runtime")
}

InstrumentedJarsPlugin.groovy

// create an adhoc component
def adhocComponent = softwareComponentFactory.adhoc("myAdhocComponent")
// add it to the list of components that this project declares
project.components.add(adhocComponent)
// and register a variant for publication
adhocComponent.addVariantsFromConfiguration(outgoing) {
    it.mapToMavenScope("runtime")
}

首先，我们使用工厂创建一个新的临时组件。然后，我们通过 addVariantsFromConfiguration 方法添加一个变体，这在上一节中进行了更详细的描述。

在简单情况下，Configuration 和变体之间存在一对一的映射，在这种情况下，您可以发布从单个 Configuration 发出的所有变体，因为它们实际上是同一件事。但是，在某些情况下，Configuration 与我们也称为辅助变体的附加配置发布相关联。此类配置在多项目构建中很有意义，但在外部发布时则不然。例如，项目之间共享文件目录就是这种情况，但是无法直接在 Maven 仓库上发布目录（只能发布打包的东西，如 jar 或 zip）。查看 ConfigurationVariantDetails 类，了解如何跳过特定变体的发布。如果已为配置调用了 addVariantsFromConfiguration，则可以使用 withVariantsFromConfiguration 对结果变体进行进一步修改。

当发布像这样的临时组件时

Gradle 模块元数据将精确地表示已发布的变体。特别是，所有出站变体都将继承已发布配置的依赖项、工件和属性。
将生成 Maven 和 Ivy 元数据文件，但您需要通过 ConfigurationVariantDetails 类声明依赖项如何映射到 Maven 作用域。

实际上，这意味着以这种方式创建的组件可以像“本地组件”一样被 Gradle 使用。

向发布添加自定义工件

您应该拥抱 Gradle 的变体感知模型，而不是从工件的角度考虑。期望单个模块可能需要多个工件。然而，这很少止步于此，如果额外的工件代表一个可选特性，它们也可能具有不同的依赖项等等。

Gradle 通过Gradle 模块元数据支持发布附加变体，这使得这些工件为依赖项解析引擎所知。请参阅文档的变体感知共享部分，了解如何声明此类变体，并查看如何发布自定义组件。

如果您直接将额外的工件附加到发布，它们将“脱离上下文”发布。这意味着，它们根本没有在元数据中被引用，然后只能通过依赖项上的分类器直接寻址。与 Gradle 模块元数据相反，Maven pom 元数据将不包含有关附加工件的信息，无论它们是通过变体还是直接添加，因为变体无法以 pom 格式表示。

以下部分描述了如果您确定元数据（例如 Gradle 或 POM 元数据）与您的用例无关，则如何直接发布工件。例如，如果您的项目不需要被其他项目使用，并且发布的唯一结果是工件本身。

一般来说，有两种选择

仅使用工件创建发布
向基于带有元数据的组件的发布添加工件（不推荐，而是调整组件或使用临时组件发布，两者都将生成适合您工件的元数据）

要创建基于工件的发布，请首先定义一个自定义工件并将其附加到您选择的 Gradle 配置。以下示例定义了一个由 rpm 任务（未显示）生成的 RPM 工件，并将该工件附加到 conf 配置

示例 5. 为配置定义自定义工件

build.gradle.kts

configurations {
    create("conf")
}
val rpmFile = layout.buildDirectory.file("rpms/my-package.rpm")
val rpmArtifact = artifacts.add("conf", rpmFile.get().asFile) {
    type = "rpm"
    builtBy("rpm")
}

build.gradle

configurations {
    conf
}
def rpmFile = layout.buildDirectory.file('rpms/my-package.rpm')
def rpmArtifact = artifacts.add('conf', rpmFile.get().asFile) {
    type = 'rpm'
    builtBy 'rpm'
}

artifacts.add() 方法 — 来自 ArtifactHandler — 返回类型为 PublishArtifact 的工件对象，然后可以在定义发布时使用，如下面的示例所示

示例 6. 将自定义 PublishArtifact 附加到发布

build.gradle.kts

publishing {
    publications {
        create<MavenPublication>("maven") {
            artifact(rpmArtifact)
        }
    }
}

build.gradle

publishing {
    publications {
        maven(MavenPublication) {
            artifact rpmArtifact
        }
    }
}

artifact() 方法接受发布工件作为参数 — 像示例中的 rpmArtifact — 以及 Project.file(java.lang.Object) 接受的任何类型的参数，例如 File 实例、字符串文件路径或归档任务。
发布插件支持不同的工件配置属性，因此请始终查看插件文档以获取更多详细信息。 Maven Publish Plugin 和 Ivy Publish Plugin 都支持 classifier 和 extension 属性。
自定义工件需要在发布中是不同的，通常通过 classifier 和 extension 的唯一组合来实现。有关精确的要求，请参阅您正在使用的插件的文档。
如果您将 artifact() 与归档任务一起使用，Gradle 会自动使用来自该任务的 classifier 和 extension 属性填充工件的元数据。

现在您可以发布 RPM。

如果您真的想向基于组件的发布添加工件，而不是调整组件本身，您可以组合 from components.someComponent 和 artifact someArtifact 表示法。

限制发布到特定仓库

当您定义了多个发布或仓库时，您通常想要控制哪些发布发布到哪些仓库。例如，考虑以下示例，该示例定义了两个发布 — 一个仅包含二进制文件，另一个包含二进制文件和关联的源代码 — 以及两个仓库 — 一个用于内部使用，一个用于外部消费者

示例 7. 添加多个发布和仓库

build.gradle.kts

publishing {
    publications {
        create<MavenPublication>("binary") {
            from(components["java"])
        }
        create<MavenPublication>("binaryAndSources") {
            from(components["java"])
            artifact(tasks["sourcesJar"])
        }
    }
    repositories {
        // change URLs to point to your repos, e.g. http://my.org/repo
        maven {
            name = "external"
            url = uri(layout.buildDirectory.dir("repos/external"))
        }
        maven {
            name = "internal"
            url = uri(layout.buildDirectory.dir("repos/internal"))
        }
    }
}

build.gradle

publishing {
    publications {
        binary(MavenPublication) {
            from components.java
        }
        binaryAndSources(MavenPublication) {
            from components.java
            artifact sourcesJar
        }
    }
    repositories {
        // change URLs to point to your repos, e.g. http://my.org/repo
        maven {
            name = 'external'
            url = layout.buildDirectory.dir('repos/external')
        }
        maven {
            name = 'internal'
            url = layout.buildDirectory.dir('repos/internal')
        }
    }
}

发布插件将创建任务，允许您将任一发布发布到任一仓库。它们还将这些任务附加到 publish 聚合任务。但是，假设您想要将仅二进制文件的发布限制为外部仓库，并将带有源代码的二进制文件发布限制为内部仓库。为此，您需要使发布成为有条件的。

Gradle 允许您通过 Task.onlyIf(String, org.gradle.api.specs.Spec) 方法，根据条件跳过您想要的任何任务。以下示例演示了如何实现我们刚刚提到的约束

示例 8. 配置哪些工件应发布到哪些仓库

build.gradle.kts

tasks.withType<PublishToMavenRepository>().configureEach {
    val predicate = provider {
        (repository == publishing.repositories["external"] &&
            publication == publishing.publications["binary"]) ||
        (repository == publishing.repositories["internal"] &&
            publication == publishing.publications["binaryAndSources"])
    }
    onlyIf("publishing binary to the external repository, or binary and sources to the internal one") {
        predicate.get()
    }
}
tasks.withType<PublishToMavenLocal>().configureEach {
    val predicate = provider {
        publication == publishing.publications["binaryAndSources"]
    }
    onlyIf("publishing binary and sources") {
        predicate.get()
    }
}

build.gradle

tasks.withType(PublishToMavenRepository) {
    def predicate = provider {
        (repository == publishing.repositories.external &&
            publication == publishing.publications.binary) ||
        (repository == publishing.repositories.internal &&
            publication == publishing.publications.binaryAndSources)
    }
    onlyIf("publishing binary to the external repository, or binary and sources to the internal one") {
        predicate.get()
    }
}
tasks.withType(PublishToMavenLocal) {
    def predicate = provider {
        publication == publishing.publications.binaryAndSources
    }
    onlyIf("publishing binary and sources") {
        predicate.get()
    }
}

gradle publish 的输出

> gradle publish
> Task :compileJava
> Task :processResources
> Task :classes
> Task :jar
> Task :generateMetadataFileForBinaryAndSourcesPublication
> Task :generatePomFileForBinaryAndSourcesPublication
> Task :sourcesJar
> Task :publishBinaryAndSourcesPublicationToExternalRepository SKIPPED
> Task :publishBinaryAndSourcesPublicationToInternalRepository
> Task :generateMetadataFileForBinaryPublication
> Task :generatePomFileForBinaryPublication
> Task :publishBinaryPublicationToExternalRepository
> Task :publishBinaryPublicationToInternalRepository SKIPPED
> Task :publish

BUILD SUCCESSFUL in 0s
10 actionable tasks: 10 executed

您可能还希望定义自己的聚合任务以帮助您的工作流程。例如，假设您有多个应发布到外部仓库的发布。将它们全部一次性发布而不发布内部发布可能非常有用。

以下示例演示了如何通过定义一个聚合任务 — publishToExternalRepository — 它依赖于所有相关的发布任务来完成此操作

示例 9. 定义您自己的用于发布的速记任务

build.gradle.kts

tasks.register("publishToExternalRepository") {
    group = "publishing"
    description = "Publishes all Maven publications to the external Maven repository."
    dependsOn(tasks.withType<PublishToMavenRepository>().matching {
        it.repository == publishing.repositories["external"]
    })
}

build.gradle

tasks.register('publishToExternalRepository') {
    group = 'publishing'
    description = 'Publishes all Maven publications to the external Maven repository.'
    dependsOn tasks.withType(PublishToMavenRepository).matching {
        it.repository == publishing.repositories.external
    }
}

此特定示例通过将 TaskCollection.withType(java.lang.Class) 与 PublishToMavenRepository 任务类型结合使用，自动处理相关发布任务的引入或删除。如果您要发布到与 Ivy 兼容的仓库，则可以使用 PublishToIvyRepository 执行相同的操作。

配置发布任务

发布插件在项目评估后创建其非聚合任务，这意味着您无法从构建脚本中直接引用它们。如果您想配置这些任务中的任何一个，则应使用延迟任务配置。这可以通过项目 tasks 集合以多种方式完成。

例如，假设您想要更改 generatePomFileForPubNamePublication 任务写入其 POM 文件的位置。您可以使用 TaskCollection.withType(java.lang.Class) 方法来完成此操作，如本示例所示

示例 10. 配置由发布插件创建的动态命名任务

build.gradle.kts

tasks.withType<GenerateMavenPom>().configureEach {
    val matcher = Regex("""generatePomFileFor(\w+)Publication""").matchEntire(name)
    val publicationName = matcher?.let { it.groupValues[1] }
    destination = layout.buildDirectory.file("poms/${publicationName}-pom.xml").get().asFile
}

build.gradle

tasks.withType(GenerateMavenPom).all {
    def matcher = name =~ /generatePomFileFor(\w+)Publication/
    def publicationName = matcher[0][1]
    destination = layout.buildDirectory.file("poms/${publicationName}-pom.xml").get().asFile
}

上面的示例使用正则表达式从任务名称中提取发布的名称。这是为了避免可能生成的所有 POM 文件的文件路径之间发生冲突。如果您只有一个发布，那么您不必担心此类冲突，因为只会有一个 POM 文件。

此页是否对您有帮助？