手把手教你提交Jar包到Maven公共倉庫

在上一篇文章中，我介紹了自己的SpringBoot Starter專案，可以讓我們使用註解的方式輕鬆地獲取操作日誌，並推送到指定資料來源。

之前，我的專案開源在Github上，大家想要用我的專案，還得把Github倉庫配置到Maven的Setting.xml裡，一點也不方便。

本文，就整理一下我把專案上傳到公共Maven倉庫的過程，當做一篇教程文章。

不得不說，上傳公共Maven倉庫，還是頗費周折的，差點沒把人氣死。

《萌新學開源》系列文章持續更新：

《萌新寫開源01》如何使用註解優雅的記錄操作日誌

《萌新寫開源02》如何提交專案到Maven公共倉庫（本文）

《萌新寫開源》如何從0到1寫一個SpringBoot Starter

《萌新寫開源》如何讓你的註解支援重複註解

碼字不易，求個關注！公眾號：後端技術漫談 ，全網部落格名：蠻三刀醬

總體流程

網上有很多文章可以查到，主要是以下幾步：

在sonatype提交發布工單（Issue）
配置gpg祕鑰
配置pom.xml和setting.xml
mvn clean deploy

你肯定要問了，sonatype和公共的Maven倉庫是什麼關係？為什麼需要在sonatype進行操作呢？

Maven中央倉庫並不支援直接釋出jar包。我們需要將jar包釋出到一些指定的第三方Maven倉庫，然後該倉庫再將jar包同步到Maven中央倉庫。其中，最”簡單”的方式是通過Sonatype OSSRH倉庫來發布jar包。接下來，我會介紹如何將jar包釋出到Sonatype OSSRH。

此外，還要重申的一點：網路上的教程都是有時效性的，包括本文也是（本文寫於2021年12月）。所以最好的方式，是按照官網的文件去做，遇到問題再配合網上的教程解決，因為官網的文件永遠是最新並且最優的解決方案，直接照著部落格教程去做有可能會走很多彎路。

官網文件地址：（這是你最應該看的文件沒有之一）

https://central.sonatype.org/...

好了，讓我們一步步跟著上面的官方文件來操作。

在sonatype提交工單

第一步，首先你需要在sonatype網站註冊賬號：

https://issues.sonatype.org/s...!default.jspa

建立好後登入，點選頁面上方的新建，來提交一個新的issue。

下圖是我建立時候填寫的內容，大家可以參考。

主要是幾個地方要注意：

問題名稱，只要大概表達清楚意思即可
groupId要寫準確
Porject URL填寫Github倉庫地址
SCM url需要在Github倉庫地址後帶git字尾

提交後，我本來以為是人工稽核，其實是全自動機器人自動回覆你。它要求你證明你對groupId的網址有所有權，比如我填寫的是cn.monitor4all，那麼我就要在monitor4all.cn的網站上，新增一個TXT解析，指向這個Issue（值寫為OSSRH-xxxxx）.

如果你是的groupId填寫的是com.github.xxx，則不需要做上述的步驟。所以如果自己沒有域名，或者嫌麻煩的，直接用com.github.xxx即可。

由於我的網站域名是自己買的，並且是騰訊雲解析的，所以我去騰訊雲新增了一條TXT解析值寫為OSSRH-75759。（我的工單地址就是https://issues.sonatype.org/b...）

稍等幾分鐘，sonatype就檢測到了你的域名所有權。

配置gpg祕鑰

第二部，你需要設定gpg祕鑰，官網gps祕鑰簽名教程：

https://central.sonatype.org/...

你肯定會好奇什麼是GPG，GPG是一種RSA演算法的實現。

1991年，程式設計師Phil Zimmermann為了避開政府監視，開發了加密軟體PGP。這個軟體非常好用，迅速流傳開來，成了許多程式設計師的必備工具。但是，它是商業軟體，不能自由使用。所以，自由軟體基金會決定，開發一個PGP的替代品，取名為GnuPG。這就是GPG的由來。

sonatype既然允許你上傳到公有倉庫，肯定要對你這個“人”，進行鑑權。防止其他惡意的人上傳Jar包。

我們去官網下載GunPG

https://www.gnupg.org/download/

有各種系統的版本可以下載，我下載了MacOS版。

裝好後，我們開啟ssh，輸入命令：

➜  ~ gpg --generate-key

緊接著跟著操作就能生成祕鑰，以下是我的生成結果，打了碼：

gpg (GnuPG/MacGPG2) 2.2.32; Copyright (C) 2021 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

注意：使用 “gpg --full-generate-key” 以獲得一個全功能的金鑰生成對話方塊。

GnuPG 需要構建使用者標識以辨認您的金鑰。

真實姓名： xxxxxxx
電子郵件地址： xxxxxxx@foxmail.com
您選定了此使用者標識：
    “xxxxxxxx <xxxxx@foxmail.com>”

更改姓名（N）、註釋（C）、電子郵件地址（E）或確定（O）/退出（Q）？ u
更改姓名（N）、註釋（C）、電子郵件地址（E）或確定（O）/退出（Q）？ o
我們需要生成大量的隨機位元組。在質數生成期間做些其他操作（敲打鍵盤
、移動滑鼠、讀寫硬碟之類的）將會是一個不錯的主意；這會讓隨機數
發生器有更好的機會獲得足夠的熵。
我們需要生成大量的隨機位元組。在質數生成期間做些其他操作（敲打鍵盤
、移動滑鼠、讀寫硬碟之類的）將會是一個不錯的主意；這會讓隨機數
發生器有更好的機會獲得足夠的熵。
gpg: 金鑰 54EC3C8FA3A5B50F 被標記為絕對信任
gpg: 目錄‘/Users/xxxxxxxxx/.gnupg/openpgp-revocs.d’已建立
gpg: 吊銷證照已被儲存為‘/Users/xxxxxxxxx/.gnupg/openpgp-revocs.d/xxxxxxxxxxxxxxxxxxxxxxxxxxxx.rev’
公鑰和私鑰已經生成並被簽名。
pub   rsa3072 2021-12-06 [SC] [有效至：2023-12-06]
      8BDxxxxxxxxxxxxxxxxxxxxxxxxxxxxB50F
uid                      xxxxxxxx <xxxxxxxx@foxmail.com>
sub   rsa3072 2021-12-06 [E] [有效至：2023-12-06]

祕鑰生成好後，需要你把公鑰上傳到公共伺服器供sonatype驗證。

官網教程裡有三個地址可以用：

keyserver.ubuntu.com
keys.openpgp.org
pgp.mit.edu

我按照官網給的辦法上傳：

➜  ~ gpg --keyserver pgp.mit.edu:11371 --send-keys 8BD96B0EA18E5162B94EA7F754EC3C8FA3A5B50F
gpg: 正在傳送金鑰 54EC3C8FA3A5B50F 到 pgp.mit.edu:11371
gpg: 傳送至公鑰伺服器失敗：檔案結尾
gpg: 傳送至公鑰伺服器失敗：檔案結尾
➜  ~ gpg --keyserver keyserver.ubuntu.com --send-keys 8BD96B0EA18E5162B94EA7F754EC3C8FA3A5B50F
gpg: 正在傳送金鑰 54EC3C8FA3A5B50F 到 hkp://keyserver.ubuntu.com
gpg: 傳送至公鑰伺服器失敗：Network is unreachable
gpg: 傳送至公鑰伺服器失敗：Network is unreachable
➜  ~ gpg --keyserver pgp.mit.edu:11371 --send-keys 54EC3C8FA3A5B50F
gpg: 正在傳送金鑰 54EC3C8FA3A5B50F 到 pgp.mit.edu:11371
gpg: 傳送至公鑰伺服器失敗：檔案結尾
gpg: 傳送至公鑰伺服器失敗：檔案結尾

但是，報錯了，反覆嘗試了各種網上教程，依然報錯。我以為是我網路的問題，或者是那幾個伺服器也失效了，反正一遍遍的排查，折騰了一個晚上。

就當快要崩潰時，我無意中發現gunpg還是有應用可以開啟的，也就是有GUI介面，於是我進去看了看，然後在我的祕鑰點選右鍵，有上傳的伺服器的選項：

這樣居然傳成功了，真是大無語啊兄弟們。

配置pom.xml和setting.xml

第三步，你需要按照官網的教程，來配置你的pom.xml和setting.xml檔案。大家看到這裡已經很累了，我就不按照官網教程那樣一步步演示了，直接給你們總結下成功需要新增的配置。

首先是setting.xml。

你需要新增一個profile：

<profiles>
    <profile>
      <id>ossrh</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <properties>
        <gpg.executable>gpg2</gpg.executable>
        <gpg.passphrase>yzdbwj1993</gpg.passphrase>
      </properties>
    </profile>
  </profiles>

還需要一個server，裡面需要填寫你的ossrh賬號密碼:

  <servers>
    <server>
      <id>ossrh</id>
      <username>你上面註冊的賬號</username>
      <password>你上面註冊的密碼</password>
    </server>
  </servers>
</settings>

setting.xml配置好了，接下來是你專案的pom.xml。

首先，你需要申明很多plugin，以及一個snapshotRepository，我把所有的都貼在了這裡。

<distributionManagement>
    <!--  申明打包到Maven公有倉庫  -->
    <snapshotRepository>
        <id>ossrh</id>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
    </snapshotRepository>
</distributionManagement>

<build>
    <plugins>
        <plugin>
            <groupId>org.sonatype.plugins</groupId>
            <artifactId>nexus-staging-maven-plugin</artifactId>
            <version>1.6.7</version>
            <extensions>true</extensions>
            <configuration>
                <serverId>ossrh</serverId>
                <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
                <autoReleaseAfterClose>true</autoReleaseAfterClose>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>2.2.1</version>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <goals>
                        <goal>jar-no-fork</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.9.1</version>
            <configuration>
                <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>
            </configuration>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-gpg-plugin</artifactId>
            <version>1.5</version>
            <executions>
                <execution>
                    <id>sign-artifacts</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>sign</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

注意，在maven-javadoc-plugin這個外掛新增後，最好像上面一樣，加上一個官方教程沒有提到的：

<configuration>
    <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>
</configuration>

否則你可能會編譯失敗，提示找不到你的JAVA_HOME環境變數，就像下圖這樣：

MavenReportException: Error while creating archive: Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set.

之後，你還可以新增上你的一些個人資訊：

<licenses>
  <license>
    <name>The Apache Software License, Version 2.0</name>
    <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
    <distribution>actable</distribution>
  </license>
</licenses>

<developers>
  <developer>
    <name>xxxxxxxxx Yang</name>
    <email>xxxxxxxxx@foxmail.com</email>
    <organization>xxxxxxxxxx</organization>
  </developer>
</developers>

<scm>
  <tag>master</tag>
  <url>git@github.com:qqxx6661/logRecord.git</url>
  <connection>git@github.com:qqxx6661/logRecord.git</connection>
  <developerConnection>git@github.com:qqxx6661/logRecord.git</developerConnection>
</scm>

正式打包釋出

最後，一切都準備好了，你可以進行最神聖的一個指令

mvn clean deploy

緊接著就上傳成功了

你的工單這時候也會更新一條資訊：

Central sync is activated for cn.monitor4all. After you successfully release, your component will be available to the public on Central https://repo1.maven.org/maven2/, typically within 30 minutes, though updates to https://search.maven.org can take up to four hours.

你的Jar包會在30分鐘左右能夠被拉取。

下圖就是成功的截圖拉。

後記

不知道看完文章，你覺不覺得麻煩呢？其實我自己看一遍寫的文字，感覺步驟還是蠻簡單的。但自己之前搞不定的時候，還是感覺蠻痛苦的。

希望我走的彎路，能幫大家避開大坑，更快的完成自己專案的上傳。

我是目前在阿里搬磚的工程師蠻三刀醬。

持續的創作離不開你的點贊和轉發分享！

參考

https://segmentfault.com/a/11...

手把手教你提交Jar包到Maven公共倉庫 | 萌新寫開源02

總體流程

在sonatype提交工單

配置gpg祕鑰

配置pom.xml和setting.xml

正式打包釋出

後記

參考

相關文章