发布构件到 Maven 中央仓库遇到的坑

作为 Java 开发者(伪),工作中一定离不开 Maven。
偶尔也需要发布自己的构件到 Maven 中央仓库中(https://oss.sonatype.org/)。
但是经常有这样那样的坑(因为总是换电脑 XD),在这里记录一下,以备后续查阅。

Maven Logo

上传步骤

将项目发布到 maven 中央仓库的一般步骤如下:

  1. 注册Sonatype的账户。地址:https://issues.sonatype.org/secure/Signup!default.jspa

  2. 提交发布申请。(仅第一次)

  3. 使用 GPG 生成密钥对。

    Windows 安装:http://gpg4win.org/

    Mac 安装:brew install gpg

    • gpg --version 检查是否安装成功
    • gpg --gen-key 生成密钥对
    • gpg --list-keys 查看公钥
    • gpg --keyserver hkp://pool.sks-keyservers.net --send-keys 公钥ID 将公钥发布到 PGP 密钥服务器
    • gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 公钥ID 查询公钥是否发布成功
  4. 配置 maven。
    需要修改的 Maven 配置文件包括:setting.xml(全局级别)与 pom.xml(项目级别)。

    • setting.xml 配置一览

      <settings>
      
          ...
      
          <servers>
              <server>
                  <id>snapshotRepository-id</id>
                  <username>用户名</username>
                  <password>密码</password>
              </server>
          </servers>
      
          ...
      
      </settings>
      
      

      使用自己注册的 Sonatype 账号的用户名与密码来配置以上 server 信息。

      此处 id snapshotRepository-id 应和下面 pom.xml 中 snapshotRepository 和 repository 里面的 id 保持一致。

      • pom.xml 配置一览
      <project>
      
          ...
      
          <name>your project's name</name>
          <description>your project's description</description>
          <url>http://www.chengww.com/</url>
      
          <licenses>
              <license>
                  <name>The Apache Software License, Version 2.0</name>
                  <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
              </license>
          </licenses>
      
          <developers>
              <developer>
                  <name>chengww</name>
                  <email>chengww5217@163.com</email>
              </developer>
          </developers>
      
          ...
      
          <profiles>
              <profile>
                  <id>release</id>
                  <build>
                      <plugins>
                          <!-- Source -->
                          <plugin>
                              <groupId>org.apache.maven.plugins</groupId>
                              <artifactId>maven-source-plugin</artifactId>
                              <version>2.2.1</version>
                              <executions>
                                  <execution>
                                      <phase>package</phase>
                                      <goals>
                                          <goal>jar-no-fork</goal>
                                      </goals>
                                  </execution>
                              </executions>
                          </plugin>
                          <!-- Javadoc -->
                          <plugin>
                              <groupId>org.apache.maven.plugins</groupId>
                              <artifactId>maven-javadoc-plugin</artifactId>
                              <version>2.9.1</version>
                              <executions>
                                  <execution>
                                      <phase>package</phase>
                                      <goals>
                                          <goal>jar</goal>
                                      </goals>
                                  </execution>
                              </executions>
                          </plugin>
                          <!-- GPG -->
                          <plugin>
                              <groupId>org.apache.maven.plugins</groupId>
                              <artifactId>maven-gpg-plugin</artifactId>
                              <version>1.5</version>
                              <executions>
                                  <execution>
                                      <phase>verify</phase>
                                      <goals>
                                          <goal>sign</goal>
                                      </goals>
                                  </execution>
                              </executions>
                          </plugin>
                      </plugins>
                  </build>
                  <distributionManagement>
                      <snapshotRepository>
                          <id>snapshotRepository-id</id>
                                     <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
                      </snapshotRepository>
                      <repository>
                          <id>snapshotRepository-id</id>
                          <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
                      </repository>
                  </distributionManagement>
              </profile>
          </profiles>
      
          ...
      
          </project>
      

      注意:以上 pom.xml 必须包括:name、description、url、licenses、developers、scm 等基本信息,此外,使用了 Maven 的 profile 功能,只有在 release 的时候,创建源码包、创建文档包、使用 GPG 进行数字签名。此外,snapshotRepository 与 repository 中的 id 一定要与 setting.xml 中 server 的 id 保持一致。

  5. 上传构件到 OSS 中。mvn clean deploy -P release

  6. 在 OSS 中发布构件。进入 https://oss.sonatype.org/,点击Staging Repositories -> 在搜索栏输入你的 groupId -> 勾选你的构件并点击 close -> 点击 tab 栏的 release。

  7. 通知 Sonatype 的工作人员关闭 issue。(仅第一次)

参考地址:https://my.oschina.net/huangyong/blog/226738


等待审批通过后,就可以在中央仓库中搜索到自己发布的构件了!

但是,事情并不是那么简单的。总是会出现这样那样的坑。

碰到的坑一览

GPG 生成密钥对

消息提示乱码

image

出现该步骤其实是输入密码的步骤。但是由于是中文的缘故,消息提示乱码了。

只需要在下面横线上输入密码之后,将光标移动到下面的好,回车即可。注意,密码需要输入两次,请保持两次一致。

将公钥发布到 PGP 密钥服务器

gpg: 发送至公钥服务器失败:Server indicated a failure

因安装了新版的 gpg,在 gpg --list-keys 时显示如下:

pub   rsa2048 2019-04-12 [SC] [有效至:2021-04-11]
      9A1640F7A2551131612D51B12D83594B7B29D86A
uid           [ 绝对 ] chengww <chengww5217@163.com>
sub   rsa2048 2019-04-12 [E] [有效至:2021-04-11]

发布公钥到服务器时,填的公钥 ID 为 9A1640F7A2551131612D51B12D83594B7B29D86A,终端上显示为:

gpg --keyserver hkp://subkeys.pgp.net --send-keys 9A1640F7A2551131612D51B12D83594B7B29D86A
...
gpg: 正在发送密钥 2D83594B7B29D86A 到 hkp://subkeys.pgp.net
gpg: 发送至公钥服务器失败:Server indicated a failure
gpg: 发送至公钥服务器失败:Server indicated a failure

只需要将公钥 ID 从 9A1640F7A2551131612D51B12D83594B7B29D86A 修改成 2D83594B7B29D86A 即可:

gpg --keyserver hkp://subkeys.pgp.net --send-keys 2D83594B7B29D86A

配置 maven

全局级别 setting.xml 在哪里配置

settings.xml 文件一般存在于两个位置:
全局配置: ${M2_HOME}/conf/settings.xml
用户配置:${user.home}/.m2/settings.xml

如果实在是不清楚的,请自行 mvn -X 查看:

...
[DEBUG] Reading global settings from /usr/local/Cellar/maven/3.6.0/libexec/conf/settings.xml
[DEBUG] Reading user settings from /Users/chengww/.m2/settings.xml
...

关于 setting.xml 相关讲解参见:https://www.jianshu.com/p/110d897a5442

上传构件到 OSS

Maven Sonatype Nexus return 401

401 错误,一般都是未在 setting.xml 中设置用户名密码所致(或用户名密码不正确)。

参见上述 4.配置 maven 配置下 setting.xml

gpg: signing failed: Inappropriate ioctl for device

原因是新版 gpg 在当前终端无法弹出密码输入页面。

解决:

export GPG_TTY=$(tty)

在当前终端中 export(临时解决)

或者加入到 ~/.bash_profile,然后 source ~/.bash_profile

gpg: signing failed: Screen or window too small

执行上述命令后在 IntelliJ IDEA 中的终端(Terminal)中还是不能弹出密码输入界面,且报上面的错。

这个时候就要到系统的的终端,cd 到项目目录,然后执行 mvn clean deploy -P release

结束语

路漫漫其修远兮,愿天下没有 BUG。

image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,012评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,589评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,819评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,652评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,954评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,381评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,687评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,404评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,082评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,355评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,880评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,249评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,864评论 3 232
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,007评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,760评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,394评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,281评论 2 259

推荐阅读更多精彩内容