發佈構件到 Maven 中央倉庫遇到的坑

做爲 Java 開發者（僞），工做中必定離不開 Maven。 偶爾也須要發佈本身的構件到 Maven 中央倉庫中（oss.sonatype.org/）。 可是常常有這樣那樣的坑（由於老是換電腦 XD），在這裏記錄一下，以備後續查閱。

上傳步驟

將項目發佈到 maven 中央倉庫的通常步驟以下：

1. 註冊Sonatype的帳戶。地址：issues.sonatype.org/secure/Sign…

2. 提交發布申請。(僅第一次)

   • 建立 Issue：issues.sonatype.org/secure/Crea…
   • 項目類型是 Community Support - Open Source Project Repository Hosting
   • groupId 對應的域名你須要有全部權

3. 使用 GPG 生成密鑰對。

   Windows 安裝：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 中發佈構件。進入 oss.sonatype.org/，點擊Staging Repositories -> 在搜索欄輸入你的 groupId -> 勾選你的構件並點擊 close -> 點擊 tab 欄的 release。

7. 通知 Sonatype 的工做人員關閉 issue。(僅第一次)

參考地址：my.oschina.net/huangyong/b…

---

等待審批經過後，就能夠在中央倉庫中搜索到本身發佈的構件了！

可是，事情並非那麼簡單的。老是會出現這樣那樣的坑。

碰到的坑一覽

GPG 生成密鑰對

消息提示亂碼

出現該步驟實際上是輸入密碼的步驟。可是因爲是中文的緣故，消息提示亂碼了。

只須要在下面橫線上輸入密碼以後，將光標移動到下面的好，回車便可。注意，密碼須要輸入兩次，請保持兩次一致。

將公鑰發佈到 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 相關講解參見：www.jianshu.com/p/110d897a5…

上傳構件到 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。