Maven Publish 插件提供了将构建工件发布到 Apache Maven 仓库的功能。发布到 Maven 仓库的模块可以被 Maven、Gradle（参见 声明依赖项）和其他理解 Maven 仓库格式的工具使用。您可以在 发布概述 中了解发布的基础知识。

用法

要使用 Maven Publish 插件，请在您的构建脚本中包含以下内容

示例 1. 应用 Maven Publish 插件
build.gradle.kts
plugins {
    `maven-publish`
}
build.gradle
plugins {
    id 'maven-publish'
}

Maven Publish 插件使用项目上名为 publishing 的扩展，类型为 PublishingExtension。此扩展提供命名出版物的容器和命名仓库的容器。Maven Publish 插件与 MavenPublication 出版物和 MavenArtifactRepository 仓库一起使用。

任务

generatePomFileForPubNamePublication — GenerateMavenPom

为名为 PubName 的出版物创建 POM 文件，填充已知的元数据，例如项目名称、项目版本和依赖项。POM 文件的默认位置为 build/publications/$pubName/pom-default.xml。

publishPubNamePublicationToRepoNameRepository — PublishToMavenRepository

将 PubName 出版物发布到名为 RepoName 的存储库。如果您有一个没有显式名称的存储库定义，则 RepoName 将为“Maven”。

publishPubNamePublicationToMavenLocal — PublishToMavenLocal

将 PubName 出版物复制到本地 Maven 缓存中，通常为 <当前用户的主目录>/.m2/repository，以及出版物的 POM 文件和其他元数据。

publish

依赖于：所有 publishPubNamePublicationToRepoNameRepository 任务

一个聚合任务，将所有定义的出版物发布到所有定义的存储库。它不包括将出版物复制到本地 Maven 缓存。

publishToMavenLocal

依赖于：所有 publishPubNamePublicationToMavenLocal 任务

将所有定义的出版物复制到本地 Maven 缓存，包括其元数据（POM 文件等）。

出版物

此插件提供 出版物，类型为 MavenPublication。要了解如何定义和使用出版物，请参阅有关 基本发布 的部分。

您可以在 Maven 出版物中配置四项主要内容

您可以在 完整的发布示例 中看到所有这些内容的实际应用。MavenPublication 的 API 文档包含其他代码示例。

生成的 POM 中的身份值

生成的 POM 文件的属性将包含从以下项目属性派生的标识值

覆盖默认标识值很容易：只需在配置 MavenPublication 时指定 groupId、artifactId 或 version 属性。

示例 2. 自定义发布标识
build.gradle.kts
publishing {
    publications {
        create<MavenPublication>("maven") {
            groupId = "org.gradle.sample"
            artifactId = "library"
            version = "1.1"

            from(components["java"])
        }
    }
}
build.gradle
publishing {
    publications {
        maven(MavenPublication) {
            groupId = 'org.gradle.sample'
            artifactId = 'library'
            version = '1.1'

            from components.java
        }
    }
}
某些存储库无法处理所有支持的字符。例如，在 Windows 上发布到基于文件系统的存储库时，: 字符不能用作标识符。

Maven 将 groupId 和 artifactId 限制为有限的字符集 ([A-Za-z0-9_\\-.]+)，Gradle 强制执行此限制。对于 version（以及工件 extension 和 classifier 属性），Gradle 将处理任何有效的 Unicode 字符。

明确禁止的唯一 Unicode 值是 \、/ 和任何 ISO 控制字符。提供的值将在发布早期进行验证。

自定义生成的 POM

可以在发布之前自定义生成的 POM 文件。例如，在将库发布到 Maven Central 时，您需要设置某些元数据。Maven Publish 插件为此目的提供了一个 DSL。有关可用属性和方法的完整文档，请参阅 DSL 参考中的 MavenPom。以下示例展示了如何使用最常见的属性

示例 3. 自定义 POM 文件
build.gradle.kts
publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            pom {
                name = "My Library"
                description = "A concise description of my library"
                url = "http://www.example.com/library"
                properties = mapOf(
                    "myProp" to "value",
                    "prop.with.dots" to "anotherValue"
                )
                licenses {
                    license {
                        name = "The Apache License, Version 2.0"
                        url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
                    }
                }
                developers {
                    developer {
                        id = "johnd"
                        name = "John Doe"
                        email = "[email protected]"
                    }
                }
                scm {
                    connection = "scm:git:git://example.com/my-library.git"
                    developerConnection = "scm:git:ssh://example.com/my-library.git"
                    url = "http://example.com/my-library/"
                }
            }
        }
    }
}
build.gradle
publishing {
    publications {
        mavenJava(MavenPublication) {
            pom {
                name = 'My Library'
                description = 'A concise description of my library'
                url = 'http://www.example.com/library'
                properties = [
                    myProp: "value",
                    "prop.with.dots": "anotherValue"
                ]
                licenses {
                    license {
                        name = 'The Apache License, Version 2.0'
                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                    }
                }
                developers {
                    developer {
                        id = 'johnd'
                        name = 'John Doe'
                        email = '[email protected]'
                    }
                }
                scm {
                    connection = 'scm:git:git://example.com/my-library.git'
                    developerConnection = 'scm:git:ssh://example.com/my-library.git'
                    url = 'http://example.com/my-library/'
                }
            }
        }
    }
}

自定义依赖项版本

支持两种发布依赖项的策略

声明的版本（默认）

此策略发布由构建脚本作者在 dependencies 块中使用依赖项声明定义的版本。任何其他类型的处理，例如通过 更改已解析版本的规则，都不会被考虑用于发布。

已解析的版本

此策略发布在构建过程中解析的版本，可能通过应用解析规则和自动冲突解决来实现。这样做的好处是，发布的版本与发布的工件测试的版本相对应。

解析版本的示例用例

  • 一个项目使用动态版本来表示依赖项，但更倾向于向其使用者公开给定版本解析后的版本。

  • 结合依赖项锁定，您希望发布锁定的版本。

  • 一个项目利用了 Gradle 的丰富版本约束，这些约束在转换为 Maven 时存在信息丢失。与其依赖转换，不如发布解析后的版本。

这是通过使用 versionMapping DSL 方法来实现的，该方法允许配置VersionMappingStrategy

示例 4. 使用解析后的版本
build.gradle.kts
publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            versionMapping {
                usage("java-api") {
                    fromResolutionOf("runtimeClasspath")
                }
                usage("java-runtime") {
                    fromResolutionResult()
                }
            }
        }
    }
}
build.gradle
publishing {
    publications {
        mavenJava(MavenPublication) {
            versionMapping {
                usage('java-api') {
                    fromResolutionOf('runtimeClasspath')
                }
                usage('java-runtime') {
                    fromResolutionResult()
                }
            }
        }
    }
}

在上面的示例中，Gradle 将使用在 runtimeClasspath 上解析的版本来表示在 api 中声明的依赖项，这些依赖项映射到 Maven 的 compile 范围。Gradle 还将使用在 runtimeClasspath 上解析的版本来表示在 implementation 中声明的依赖项，这些依赖项映射到 Maven 的 runtime 范围。fromResolutionResult() 表示 Gradle 应该使用变体的默认类路径，而 runtimeClasspath 是 java-runtime 的默认类路径。

仓库

此插件提供类型为MavenArtifactRepository 的仓库。要了解如何定义和使用仓库进行发布，请参阅有关基本发布的部分。

以下是一个定义发布仓库的简单示例

示例 5. 声明要发布到的仓库
build.gradle.kts
publishing {
    repositories {
        maven {
            // change to point to your repo, e.g. http://my.org/repo
            url = uri(layout.buildDirectory.dir("repo"))
        }
    }
}
build.gradle
publishing {
    repositories {
        maven {
            // change to point to your repo, e.g. http://my.org/repo
            url = layout.buildDirectory.dir('repo')
        }
    }
}

您需要配置的两个主要内容是仓库的

  • URL（必需）

  • 名称（可选）

只要仓库在构建脚本中具有唯一的名称，您就可以定义多个仓库。您也可以声明一个（且仅一个）没有名称的仓库。该仓库将隐式地使用“Maven”作为名称。

您还可以配置连接到仓库所需的任何身份验证详细信息。有关更多详细信息，请参阅MavenArtifactRepository。

快照仓库和发布仓库

将快照和发布版本发布到不同的 Maven 仓库是一种常见的做法。一种简单的方法是根据项目版本配置仓库 URL。以下示例使用一个 URL 用于以“SNAPSHOT”结尾的版本，另一个 URL 用于其他版本。

示例 6. 根据项目版本配置仓库 URL
build.gradle.kts
publishing {
    repositories {
        maven {
            val releasesRepoUrl = layout.buildDirectory.dir("repos/releases")
            val snapshotsRepoUrl = layout.buildDirectory.dir("repos/snapshots")
            url = uri(if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl)
        }
    }
}
build.gradle
publishing {
    repositories {
        maven {
            def releasesRepoUrl = layout.buildDirectory.dir('repos/releases')
            def snapshotsRepoUrl = layout.buildDirectory.dir('repos/snapshots')
            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
        }
    }
}

类似地，您可以使用 项目或系统属性 来决定发布到哪个仓库。以下示例在设置了项目属性 release 时使用发布仓库，例如当用户运行 gradle -Prelease publish 时。

示例 7. 根据项目属性配置仓库 URL
build.gradle.kts
publishing {
    repositories {
        maven {
            val releasesRepoUrl = layout.buildDirectory.dir("repos/releases")
            val snapshotsRepoUrl = layout.buildDirectory.dir("repos/snapshots")
            url = uri(if (project.hasProperty("release")) releasesRepoUrl else snapshotsRepoUrl)
        }
    }
}
build.gradle
publishing {
    repositories {
        maven {
            def releasesRepoUrl = layout.buildDirectory.dir('repos/releases')
            def snapshotsRepoUrl = layout.buildDirectory.dir('repos/snapshots')
            url = project.hasProperty('release') ? releasesRepoUrl : snapshotsRepoUrl
        }
    }
}

发布到 Maven 本地仓库

为了与本地 Maven 安装集成，有时需要将模块发布到 Maven 本地仓库（通常位于 <当前用户的主目录>/.m2/repository），以及它的 POM 文件和其他元数据。在 Maven 术语中，这被称为“安装”模块。

Maven Publish 插件使这变得很容易，它会自动为 publishing.publications 容器中的每个 MavenPublication 创建一个 PublishToMavenLocal 任务。任务名称遵循 publishPubNamePublicationToMavenLocal 的模式。这些任务都连接到 publishToMavenLocal 聚合任务。您不需要在 publishing.repositories 部分中包含 mavenLocal()。

发布 Maven 重定位信息

当项目更改其发布的工件的groupId或artifactId（即坐标）时，重要的是让用户知道新工件在哪里可以找到。Maven可以通过重定位功能来帮助实现这一点。其工作原理是，项目在旧坐标下发布一个额外的工件，该工件仅包含一个最小的重定位POM；该POM文件指定了新工件的位置。Maven仓库浏览器和构建工具可以告知用户工件的坐标已更改。

为此，项目添加了一个额外的MavenPublication，指定一个MavenPomRelocation

示例 8. 指定重定位 POM
build.gradle.kts
publishing {
    publications {
        // ... artifact publications

        // Specify relocation POM
        create<MavenPublication>("relocation") {
            pom {
                // Old artifact coordinates
                groupId = "com.example"
                artifactId = "lib"
                version = "2.0.0"

                distributionManagement {
                    relocation {
                        // New artifact coordinates
                        groupId = "com.new-example"
                        artifactId = "lib"
                        version = "2.0.0"
                        message = "groupId has been changed"
                    }
                }
            }
        }
    }
}
build.gradle
publishing {
    publications {
        // ... artifact publications

        // Specify relocation POM
        relocation(MavenPublication) {
            pom {
                // Old artifact coordinates
                groupId = "com.example"
                artifactId = "lib"
                version = "2.0.0"

                distributionManagement {
                    relocation {
                        // New artifact coordinates
                        groupId = "com.new-example"
                        artifactId = "lib"
                        version = "2.0.0"
                        message = "groupId has been changed"
                    }
                }
            }
        }
    }
}

在relocation下只需要指定已更改的属性，即artifactId和/或groupId。所有其他属性都是可选的。

指定version在新的工件具有不同版本时很有用，例如，因为版本编号已从 1.0.0 重新开始。

自定义message可以解释为什么工件坐标已更改。

重定位 POM 应该为旧工件的下一个版本创建。例如，当com.example:lib:1.0.0的工件坐标发生更改，并且具有新坐标的工件继续版本编号并发布为com.new-example:lib:2.0.0时，则重定位 POM 应该指定从com.example:lib:2.0.0到com.new-example:lib:2.0.0的重定位。

重定位 POM 只需发布一次，一旦发布，其构建文件配置应再次删除。

请注意，重定位 POM 不适合所有情况；当工件被拆分为两个或多个独立的工件时，重定位 POM 可能没有帮助。

追溯发布重定位信息

可以在过去工件的坐标发生更改后追溯发布重定位信息，并且当时没有发布重定位信息。

上面描述的相同建议适用。为了简化用户的迁移，重要的是要注意重定位 POM 中指定的version。重定位 POM 应该允许用户一步一步地迁移到新工件，然后允许他们单独更新到最新版本。例如，当com.new-example:lib:5.0.0的坐标在版本 2.0.0 中发生更改时，理想情况下，重定位 POM 应该为旧坐标com.example:lib:2.0.0发布，重定位到com.new-example:lib:2.0.0。然后，用户可以从com.example:lib切换到com.new-example，然后单独从版本 2.0.0 更新到 5.0.0，逐步处理重大更改（如果有）。

当追溯发布重定位信息时，不必等待项目的下一个定期发布，可以在此期间发布。如上所述，一旦发布了重定位 POM，就应该从构建文件中再次删除重定位信息。

避免重复依赖

当仅更改工件的坐标，但工件内部类的包名保持不变时，可能会发生依赖冲突。项目可能（传递地）依赖于旧工件，但同时还依赖于包含相同类的新的工件，这些类可能包含不兼容的更改。

为了检测到这种冲突的重复依赖项，功能 可以作为 Gradle 模块元数据 的一部分发布。有关使用 Java 库 项目的示例，请参阅 为本地组件声明附加功能。

执行干运行

为了验证重定位信息在发布到远程仓库之前按预期工作，可以先将其 发布到本地 Maven 仓库。然后可以创建一个本地测试 Gradle 或 Maven 项目，该项目将重定位工件作为依赖项。

完整示例

以下示例演示了如何签署和发布 Java 库，包括源代码、Javadoc 和自定义 POM

示例 9. 发布 Java 库
build.gradle.kts
plugins {
    `java-library`
    `maven-publish`
    signing
}

group = "com.example"
version = "1.0"

java {
    withJavadocJar()
    withSourcesJar()
}

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            artifactId = "my-library"
            from(components["java"])
            versionMapping {
                usage("java-api") {
                    fromResolutionOf("runtimeClasspath")
                }
                usage("java-runtime") {
                    fromResolutionResult()
                }
            }
            pom {
                name = "My Library"
                description = "A concise description of my library"
                url = "http://www.example.com/library"
                properties = mapOf(
                    "myProp" to "value",
                    "prop.with.dots" to "anotherValue"
                )
                licenses {
                    license {
                        name = "The Apache License, Version 2.0"
                        url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
                    }
                }
                developers {
                    developer {
                        id = "johnd"
                        name = "John Doe"
                        email = "[email protected]"
                    }
                }
                scm {
                    connection = "scm:git:git://example.com/my-library.git"
                    developerConnection = "scm:git:ssh://example.com/my-library.git"
                    url = "http://example.com/my-library/"
                }
            }
        }
    }
    repositories {
        maven {
            // change URLs to point to your repos, e.g. http://my.org/repo
            val releasesRepoUrl = uri(layout.buildDirectory.dir("repos/releases"))
            val snapshotsRepoUrl = uri(layout.buildDirectory.dir("repos/snapshots"))
            url = if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl
        }
    }
}

signing {
    sign(publishing.publications["mavenJava"])
}

tasks.javadoc {
    if (JavaVersion.current().isJava9Compatible) {
        (options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
    }
}
build.gradle
plugins {
    id 'java-library'
    id 'maven-publish'
    id 'signing'
}

group = 'com.example'
version = '1.0'

java {
    withJavadocJar()
    withSourcesJar()
}

publishing {
    publications {
        mavenJava(MavenPublication) {
            artifactId = 'my-library'
            from components.java
            versionMapping {
                usage('java-api') {
                    fromResolutionOf('runtimeClasspath')
                }
                usage('java-runtime') {
                    fromResolutionResult()
                }
            }
            pom {
                name = 'My Library'
                description = 'A concise description of my library'
                url = 'http://www.example.com/library'
                properties = [
                    myProp: "value",
                    "prop.with.dots": "anotherValue"
                ]
                licenses {
                    license {
                        name = 'The Apache License, Version 2.0'
                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                    }
                }
                developers {
                    developer {
                        id = 'johnd'
                        name = 'John Doe'
                        email = '[email protected]'
                    }
                }
                scm {
                    connection = 'scm:git:git://example.com/my-library.git'
                    developerConnection = 'scm:git:ssh://example.com/my-library.git'
                    url = 'http://example.com/my-library/'
                }
            }
        }
    }
    repositories {
        maven {
            // change URLs to point to your repos, e.g. http://my.org/repo
            def releasesRepoUrl = layout.buildDirectory.dir('repos/releases')
            def snapshotsRepoUrl = layout.buildDirectory.dir('repos/snapshots')
            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
        }
    }
}

signing {
    sign publishing.publications.mavenJava
}


javadoc {
    if(JavaVersion.current().isJava9Compatible()) {
        options.addBooleanOption('html5', true)
    }
}

结果是将发布以下工件

  • POM：my-library-1.0.pom

  • Java 组件的主要 JAR 工件：my-library-1.0.jar

  • 已明确配置的源代码 JAR 工件：my-library-1.0-sources.jar

  • 已明确配置的 Javadoc JAR 工件：my-library-1.0-javadoc.jar

签名插件 用于为每个工件生成签名文件。此外，将为所有工件和签名文件生成校验和文件。

publishToMavenLocal 不会在 $USER_HOME/.m2/repository 中创建校验和文件。如果您想验证校验和文件是否正确创建，或者将它们用于以后发布，请考虑配置一个 自定义 Maven 仓库，使用 file:// URL，并将其用作发布目标。

删除延迟配置行为

在 Gradle 5.0 之前，publishing {} 块（默认情况下）被隐式地视为在项目评估后执行其中的所有逻辑。这种行为造成了相当多的困惑，并在 Gradle 4.8 中被弃用，因为它是在这种情况下唯一表现出这种行为的块。

您的发布块或插件中可能存在一些依赖于延迟配置行为的逻辑。例如，以下逻辑假设子项目将在设置 artifactId 时进行评估

build.gradle.kts
subprojects {
    publishing {
        publications {
            create<MavenPublication>("mavenJava") {
                from(components["java"])
                artifactId = tasks.jar.get().archiveBaseName.get()
            }
        }
    }
}
build.gradle
subprojects {
    publishing {
        publications {
            mavenJava(MavenPublication) {
                from components.java
                artifactId = jar.archiveBaseName
            }
        }
    }
}

现在，这种逻辑必须包装在 afterEvaluate {} 块中。

build.gradle.kts
subprojects {
    publishing {
        publications {
            create<MavenPublication>("mavenJava") {
                from(components["java"])
                afterEvaluate {
                    artifactId = tasks.jar.get().archiveBaseName.get()
                }
            }
        }
    }
}
build.gradle
subprojects {
    publishing {
        publications {
            mavenJava(MavenPublication) {
                from components.java
                afterEvaluate {
                    artifactId = jar.archiveBaseName
                }
            }
        }
    }
}