简介

Sonatype 提供了一个叫做开源软件资源库托管 Open Source Software Repository Hosting (OSSRH) 的工具，帮助我们来方便的将项目发布到中心仓库中。

但是这个工具和我们的项目构建是割裂的，尤其是在 CI 集成构建中，很难做到自动化。

Gradle 是一个很好的构建工具，灵活而又强大，可不可以直接在 Gradle 中的任务中直接构建和上传到中央仓库或者其他自定义的 nexus 仓库中呢？答案是肯定的。

Gradle Nexus Publish Plugin 历史

今天要给大家介绍的 gradle 插件名字叫做 Gradle Nexus Publish Plugin，最近才发布了 1.0.0 版本，有小伙伴可能要问了，gradle 出来这么久了，最近才有这样的插件吗？

其实不然，我们来讲一下 gradle Nexus 发布插件的历史。

2015 年，Marcin Zajączkowski 创建了 gradle-nexus-staging-plugin，该插件可在 Nexus 存储库管理器中关闭和释放 staging 存储库。使用这个插件就可以直接从代码中将 Gradle 项目发布到 Maven Central 仓库。多年来，它已经在全球各地被多个项目所采用。

但是这个插件存在一个小问题: 由于 Gradle 发布过程中的技术限制，因此需要使用启发式技术来跟踪隐式创建的 staging 存储库，对于给定状态的多个存储库，通常会发布失败。尤其是在持续集成服务 Travis CI 在 2019 年末更改其网络架构之后，这个插件问题就更多了。

基于这个问题，马克·菲利普（Marc Philipp）创建了另外一个插件 Nexus Publish Plugin，该插件丰富了 Gradle 中的发布机制，可以显式创建 staging 存储库并直接向其发布（上传）组件。

通常我们需要将这两个插件一起使用，但是，一个功能需要使用到两个插件还是会让用户感到困惑。所以 Gradle Nexus Publish Plugin 在 2020/2021 年应运而生了，它的目的就是合并上面两个插件的功能。

插件的使用

在 gradle 中使用该插件很简单，首先需要引入这个插件：

plugins {    id("io.github.gradle-nexus.publish-plugin") version "«version»"}

注意，这个插件必须在 Gradle 5.0 或者之后的版本使用，并且在根项目中引入。

接下来，我们需要定义要发布的仓库，如果是通过 Sonatype’s OSSRH Nexus 发布到 Maven 的中央仓库，那么需要添加 sonatype()，如下所示：

nexusPublishing {    repositories {        sonatype()    }}

在 sonatype()中，实际上定义了 nexusUrl 和 snapshotRepositoryUrl。

发布到中央仓库是需要用户名密码的，我们需要设置 sonatypeUsername 和 sonatypePassword 这两个项目的属性。一种方法是在~/.gradle/gradle.properties 中进行配置，或者设置 ORG_GRADLE_PROJECT_sonatypeUsername 和 ORG_GRADLE_PROJECT_sonatypePassword 这两个环境变量。

或者，可以直接在 sonatype 中进行定义：

nexusPublishing {    repositories {        sonatype {            username = "your-username"            password = "your-password"        }    }}

最后，调用 publishToSonatype 和 closeAndReleaseSonatypeStagingRepository 就可以分别发布到 Sonatype 和关闭并发布到中央仓库了。

注意，上面的 closeAndReleaseSonatypeStagingRepository 实际上是包含了两步操作：close 和 release。我们也可以仅仅调用 closeSonatypeStagingRepository，然后手动登录 Nexus UI，进行 release 操作。

下面是两个分别使用 groovy 和 Kotlin 的具体的例子：

Groovy DSL

plugins {    id "java-library"    id "maven-publish"    id "io.github.gradle-nexus.publish-plugin" version "«version»"}
publishing {    publications {        mavenJava(MavenPublication) {            from(components.java)        }    }}
nexusPublishing {    repositories {        myNexus {            nexusUrl = uri("https://your-server.com/staging")            snapshotRepositoryUrl = uri("https://your-server.com/snapshots")            username = "your-username" // defaults to project.properties["myNexusUsername"]            password = "your-password" // defaults to project.properties["myNexusPassword"]        }    }}

Kotlin DSL

plugins {    `java-library`    `maven-publish`    id("io.github.gradle-nexus.publish-plugin") version "«version»"}
publishing {    publications {        create<MavenPublication>("mavenJava") {            from(components["java"])        }    }}
nexusPublishing {    repositories {        create("myNexus") {            nexusUrl.set(uri("https://your-server.com/staging"))            snapshotRepositoryUrl.set(uri("https://your-server.com/snapshots"))            username.set("your-username") // defaults to project.properties["myNexusUsername"]            password.set("your-password") // defaults to project.properties["myNexusPassword"]        }    }}

默认情况下 nexusPublishing 中的 connectTimeout 和 clientTimeout 是 5 分钟，可以根据自己的需要进行调整。

插件背后的故事

我们来看一下这个插件背后是怎么工作的。

首先定义的nexusPublishing { repositories { ... } } 会拦截所有子项目的 maven-publish 插件，用来修改发布地址。

如果项目的版本号不是以-SNAPSHOT结尾，这说明是发布版本，那么会创建一个initialize${repository.name.capitalize()}StagingRepository 任务，开启一个新的 staging 仓库，并且设置好对应的 URL。在多项目构建中，所有拥有相同 nexusUrl 的子项目，将会使用同样的 staging 仓库。

initialize${repository.name.capitalize()}StagingRepository为每个配置好的仓库地址，生成发布任务。

为每个发布任务生成一个 publishTo${repository.name.capitalize()} 生命周期 task。

在发布任务之后分别创建 close${repository.name.capitalize()}StagingRepository 和 release${repository.name.capitalize()}StagingRepository 任务。

总结

这么好用的插件，赶紧去试试吧。

本文已收录于 http://www.flydean.com/07-gradle-nexus-publish-plugin/

最通俗的解读，最深刻的干货，最简洁的教程，众多你不知道的小技巧等你来发现！

欢迎关注我的公众号:「程序那些事」,懂技术，更懂你！