Maven Publish 插件提供了将构建 Artifacts 发布到 Apache Maven 仓库的能力。发布到 Maven 仓库的模块可以被 Maven、Gradle(参见声明依赖)以及其他理解 Maven 仓库格式的工具使用。您可以在发布概述中了解发布的基础知识。
用法
要使用 Maven Publish 插件,请在您的构建脚本中包含以下内容
plugins {
`maven-publish`
}
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.from(org.gradle.api.component.SoftwareComponent)。
-
自定义 Artifacts — 通过 MavenPublication.artifact(java.lang.Object) 方法。有关自定义 Maven Artifacts 的可用配置选项,请参阅 MavenArtifact。
-
标准元数据,例如
artifactId
、groupId
和version
。 -
POM 文件的其他内容 — 通过 MavenPublication.pom(org.gradle.api.Action)。
您可以在完整发布示例中看到所有这些实际应用。MavenPublication
的 API 文档包含额外的代码示例。
生成的 POM 中的身份值
生成的 POM 文件的属性将包含派生自以下项目属性的身份值
-
groupId
- Project.getGroup() -
artifactId
- Project.getName() -
version
- Project.getVersion()
覆盖默认身份值很简单:只需在配置 MavenPublication 时指定 groupId
、artifactId
或 version
属性即可。
publishing {
publications {
create<MavenPublication>("maven") {
groupId = "org.gradle.sample"
artifactId = "library"
version = "1.1"
from(components["java"])
}
}
}
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
(以及 Artifact 的 extension
和 classifier
属性),Gradle 将处理任何有效的 Unicode 字符。
唯一明确禁止的 Unicode 值是 \
、/
以及任何 ISO 控制字符。提供的值在发布早期进行验证。
定制生成的 POM
生成的 POM 文件可以在发布前进行定制。例如,将库发布到 Maven Central 时,需要设置某些元数据。Maven Publish 插件为此提供了一个 DSL。请参阅 DSL 参考中的 MavenPom,以获取可用属性和方法的完整文档。以下示例展示了如何使用最常见的属性和方法
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 = "https://apache.ac.cn/licenses/LICENSE-2.0.txt"
}
}
developers {
developer {
id = "johnd"
name = "John Doe"
email = "john.doe@example.com"
}
}
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/"
}
}
}
}
}
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 = 'https://apache.ac.cn/licenses/LICENSE-2.0.txt'
}
}
developers {
developer {
id = 'johnd'
name = 'John Doe'
email = 'john.doe@example.com'
}
}
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
代码块中通过依赖声明定义的版本。任何其他类型的处理,例如通过更改解析版本的规则,都不会在发布时考虑。 - 解析版本
-
此策略发布在构建期间解析的版本,可能通过应用解析规则和自动冲突解决。这具有优势,即发布的版本与发布 Artifact 时经过测试的版本相符。
解析版本的示例用例
-
项目使用动态版本作为依赖,但更倾向于向其使用者暴露给定版本的解析版本。
-
结合依赖锁定,您希望发布锁定的版本。
-
项目利用了 Gradle 丰富的版本约束,这在转换为 Maven 时会丢失信息。项目选择发布解析版本,而不是依赖转换。
这通过使用 versionMapping
DSL 方法实现,该方法允许配置 VersionMappingStrategy。
publishing {
publications {
create<MavenPublication>("mavenJava") {
versionMapping {
usage("java-api") {
fromResolutionOf("runtimeClasspath")
}
usage("java-runtime") {
fromResolutionResult()
}
}
}
}
}
publishing {
publications {
mavenJava(MavenPublication) {
versionMapping {
usage('java-api') {
fromResolutionOf('runtimeClasspath')
}
usage('java-runtime') {
fromResolutionResult()
}
}
}
}
}
在上面的示例中,Gradle 将对在 api
中声明的依赖使用在 runtimeClasspath
上解析的版本,这些版本映射到 Maven 的 compile
范围。Gradle 还会对在 implementation
中声明的依赖使用在 runtimeClasspath
上解析的版本,这些版本映射到 Maven 的 runtime
范围。fromResolutionResult()
表示 Gradle 应该使用变体的默认 classpath,而 runtimeClasspath
是 java-runtime
的默认 classpath。
仓库
此插件提供类型为 MavenArtifactRepository 的仓库。要了解如何定义和使用仓库进行发布,请参阅基本发布部分。
这里有一个定义发布仓库的简单示例
publishing {
repositories {
maven {
// change to point to your repo, e.g. http://my.org/repo
url = uri(layout.buildDirectory.dir("repo"))
}
}
}
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。以下示例对以 "SNAPSHOT" 结尾的版本使用一个 URL,对其他版本使用不同的 URL
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)
}
}
}
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
时
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)
}
}
}
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 重定位信息
当项目更改其发布的 Artifact 的 groupId
或 artifactId
(即其坐标)时,告知用户新 Artifact 的位置非常重要。Maven 可以通过重定位功能提供帮助。其工作方式是,项目在旧坐标下发布一个额外的 Artifact,该 Artifact 仅包含一个最小的重定位 POM;该 POM 文件指定了新 Artifact 的位置。然后,Maven 仓库浏览器和构建工具可以告知用户 Artifact 的坐标已更改。
为此,项目添加一个额外的 MavenPublication
,并指定 MavenPomRelocation。
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"
}
}
}
}
}
}
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
。所有其他属性都是可选的。
指定 自定义 |
重定位 POM 应该为旧 Artifact 的下一个版本创建。例如,当 Artifact 的坐标从 com.example:lib:1.0.0
更改,并且新坐标的 Artifact 继续使用版本号并发布为 com.new-example:lib:2.0.0
时,则重定位 POM 应该指定从 com.example:lib:2.0.0
重定位到 com.new-example:lib:2.0.0
。
重定位 POM 只需发布一次,发布后应从构建文件中移除其配置。
请注意,重定位 POM 并非适用于所有情况;当一个 Artifact 被拆分成两个或多个独立的 Artifact 时,重定位 POM 可能没有帮助。
追溯发布重定位信息
可以在 Artifact 的坐标过去已更改但当时未发布重定位信息的情况下,追溯发布重定位信息。
上述建议同样适用。为了方便用户迁移,注意重定位 POM 中指定的 version
非常重要。重定位 POM 应该允许用户一步迁移到新的 Artifact,然后在单独的步骤中更新到最新版本。例如,当 com.new-example:lib:5.0.0
的坐标在 2.0.0 版本中更改时,理想情况下,应该为旧坐标 com.example:lib:2.0.0
发布重定位 POM,重定位到 com.new-example:lib:2.0.0
。用户可以先从 com.example:lib
切换到 com.new-example
,然后单独从版本 2.0.0 更新到 5.0.0,逐步处理破坏性更改(如果有)。
追溯发布重定位信息时,无需等待项目的下一次常规发布,可以立即发布。如上所述,重定位 POM 发布后,应再次从构建文件中移除重定位信息。
避免重复依赖
当仅 Artifact 的坐标发生变化,但 Artifact 内类的包名保持不变时,可能会发生依赖冲突。项目可能(传递地)依赖于旧的 Artifact,但同时又依赖于包含相同类的新 Artifact,这可能带有不兼容的更改。
为了检测此类冲突的重复依赖,可以将能力(capabilities)作为Gradle 模块元数据的一部分发布。使用Java 库项目的示例,请参见声明本地组件的额外能力。
执行空运行
为了在将重定位信息发布到远程仓库之前验证其是否按预期工作,可以先将其发布到本地 Maven 仓库。然后可以创建一个依赖于重定位 Artifact 的本地测试 Gradle 或 Maven 项目。
完整示例
以下示例演示了如何签署和发布一个包含源代码、Javadoc 和定制 POM 的 Java 库
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 = "https://apache.ac.cn/licenses/LICENSE-2.0.txt"
}
}
developers {
developer {
id = "johnd"
name = "John Doe"
email = "john.doe@example.com"
}
}
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)
}
}
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 = 'https://apache.ac.cn/licenses/LICENSE-2.0.txt'
}
}
developers {
developer {
id = 'johnd'
name = 'John Doe'
email = 'john.doe@example.com'
}
}
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)
}
}
结果是,将发布以下 Artifacts
-
POM 文件:
my-library-1.0.pom
-
Java 组件的主要 JAR Artifact:
my-library-1.0.jar
-
已明确配置的 sources JAR Artifact:
my-library-1.0-sources.jar
-
已明确配置的 Javadoc JAR Artifact:
my-library-1.0-javadoc.jar
签名插件(Signing Plugin)用于为每个 Artifact 生成签名文件。此外,还将为所有 Artifact 和签名文件生成校验和文件。
`publishToMavenLocal` 不会在 $USER_HOME/.m2/repository 中创建校验和文件。如果您想验证校验和文件是否正确创建,或将其用于后续发布,请考虑配置一个带有 file:// URL 的自定义 Maven 仓库,并将其用作发布目标。 |
移除延迟配置行为
在 Gradle 5.0 之前,publishing {}
代码块(默认情况下)被隐式地视为其中所有逻辑都在项目评估后执行。这种行为导致了相当多的困惑,并在 Gradle 4.8 中被弃用,因为它是唯一以这种方式表现的代码块。
您的发布代码块中或插件中可能存在依赖于延迟配置行为的逻辑。例如,以下逻辑假设在设置 artifactId 时,子项目将被评估
subprojects {
publishing {
publications {
create<MavenPublication>("mavenJava") {
from(components["java"])
artifactId = tasks.jar.get().archiveBaseName.get()
}
}
}
}
subprojects {
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
artifactId = jar.archiveBaseName
}
}
}
}
这种逻辑现在必须包装在 afterEvaluate {}
代码块中。
subprojects {
publishing {
publications {
create<MavenPublication>("mavenJava") {
from(components["java"])
afterEvaluate {
artifactId = tasks.jar.get().archiveBaseName.get()
}
}
}
}
}
subprojects {
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
afterEvaluate {
artifactId = jar.archiveBaseName
}
}
}
}
}