發佈jar包到maven中央倉庫

来源:https://www.cnblogs.com/wind-wound/archive/2023/12/12/17893935.html
-Advertisement-
Play Games

1. 環境 在網上找的很多文章中寫得都有很多問題，這裡記錄一下最近一次成功地發佈jar包到maven中央倉庫的過程。並附帶上每一個步驟官方的指導鏈接。 系統：mac（windows系統在下載輔助工具時不太一樣，在配置上和mac系統沒有區別） IDE：IntelliJ IDEA JDK：1.8 mav ...


1. 環境

在網上找的很多文章中寫得都有很多問題，這裡記錄一下最近一次成功地發佈jar包到maven中央倉庫的過程。並附帶上每一個步驟官方的指導鏈接。

  • 系統：mac（windows系統在下載輔助工具時不太一樣，在配置上和mac系統沒有區別）
  • IDE：IntelliJ IDEA
  • JDK：1.8
  • maven：3.8.1（IDEA自帶的版本）
  • 代碼：上傳到github上（使用gitee也行）
  • 發佈形式：以jar包發佈release版本（非SNAPSHOT版本）

2. 項目配置

官方對發佈的項目做了一些必需的要求，如果不按要求來，發佈可能會報錯。

2.1. javadoc和source

以非pom方式打包的項目（pom.xml配置文件中可以通過標簽配置打包方式，預設就是jar），在打包完成後，target目錄下必須要包含***-sources.jar和***-javadoc.jar。如下圖：

為了達成以上效果，需要在pom.xml中依賴兩個插件：

<build>
    <plugins>
        <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>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

參考：https://central.sonatype.org/publish/requirements/#supply-javadoc-and-sources

2.2. 使用 GPG/PGP 簽署文件

打包完成後，target目錄下必須要包含***.jar.sac。如下圖：

為了達成以上效果，需要在pom.xml中依賴插件（加完插件不要急著構建，還要下載GPG生成密鑰，後面會說）：

<build>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-gpg-plugin</artifactId>
        <version>3.1.0</version>
        <executions>
            <execution>
                <id>sign-artifacts</id>
                <phase>verify</phase>
                <goals>
                    <goal>sign</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
</build>

參考：https://central.sonatype.org/publish/requirements/#sign-files-with-gpgpgp

2.3. 項目名稱和版本配置

  • groupId：使用正確的反向功能變數名稱。如果有私人功能變數名稱，可以配置成私人功能變數名稱（後面配置起來比較麻煩）。如果沒有私人功能變數名稱，可以直接使用github的功能變數名稱：io.github.{account}（gitee同理，推薦使用這種方式， account是github註冊的登錄賬號）。
  • artifactId：項目名稱，可以隨意發揮。
  • version：版本，可以使用1.1.1這種格式，不推薦帶-SNAPSHOT，快照版本不會直接發佈到中央倉庫。

參考：https://central.sonatype.org/publish/requirements/#correct-coordinates

2.4. 項目名稱、描述和 URL

這個是為了增加可讀性。

  • name：推薦使用這種格式：<name>${project.groupId}:${project.artifactId}</name>，當然也可以自定義。
  • description：項目描述，自己發揮。
  • url：項目地址，直接使用github（或gitee）上項目的地址即可。

參考：https://central.sonatype.org/publish/requirements/#project-name-description-and-url

2.5. 許可證書

可以使用Apache/MIT的許可證書，直接拷貝下麵的即可：

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

參考：https://central.sonatype.org/publish/requirements/#license-information

2.6. 開發人員信息

留你自己的藝名和郵箱：

<developers>
        <developer>
        <name>你的藝名</name>
        <email>你的郵箱</email>
    </developer>
</developers>

參考：https://central.sonatype.org/publish/requirements/#developer-information

2.7. SCM 源碼管理系統信息

可以使用github（或gitee）的項目地址。

<scm>
    <connection>scm:git:git://github.com:maidoubaobao/easy-tool.git</connection>
    <developerConnection>scm:git:ssh://github.com:maidoubaobao/easy-tool.git</developerConnection>
    <url>https://github.com/maidoubaobao/easy-tool/tree/master</url>
</scm>

參考：https://central.sonatype.org/publish/requirements/#scm-information

2.8. 文件簽名校驗（非必需）

官網說必需要包含.md5和.sha1簽名校驗文件，但我沒有特地去配置這個，也是可以發佈的。可以跳過這一步。

參考：https://central.sonatype.org/publish/requirements/#provide-files-checksums

3. 在 JIRA 上提發佈申請

3.1. 註冊 JIRA

點擊如下鏈接註冊賬號並登錄，如果有賬號直接登錄即可：
https://issues.sonatype.org/secure/Signup!default.jspa

參考：https://central.sonatype.org/publish/publish-guide/#initial-setup

3.2. 創建項目

點擊新建，按照下麵的圖示來填寫：

  • groupId：要和項目里對應上，必須是一個可用的功能變數名稱的反轉字元串，如果項目是放在github上，必須使用io.github.{account}的格式，否則會審核不通過（註意：不能使用com.github）。
  • Project URL/SCM url：直接使用github的項目地址即可。

3.3. 查看剛剛創建的項目

正常情況下創建好預設就會進入剛剛創建的項目，如果進不去，可以按照路徑項目-查看所有項目-類別-Central即可看到項目鏈接，點進去後，切換篩選器我的報告就能看到創建的項目了。

3.4. 在github中創建一個空項目

創建好的項目，會分配一個唯一標識OSSRH-***（見上圖），需要用這個標識去github上創建一個空項目，這個是為了向核審管理員證明需要發佈的github項目確實是你自己的項目。

3.5. 等待管理員審核

管理員都在國外，因為時差，一般隔天才會核審通過。沒辦法，耐心等著吧。
審核通過後，會發郵件（郵箱就是註冊JIRA的那個），也會在JIRA項目下出現活動日誌。

4. 獲取 GPG 密鑰

在等待JIRA項目審核的同時，可以並行把GPG密鑰搞定。
註意：mac系統和windows系統在獲取GPG密鑰時有些區別，mac全程都是通過命令行搞定的，而windows提供了操作界面，可能會方便一點。這裡只介紹mac系統的配置方式，windows系統可以自行搜配置教程。

4.1. 安裝 GnuPG

  • 用下麵的鏈接下載 GnuPG，選擇系統對應的版本。

https://gnupg.org/download/index.html#sec-1-2

  • 驗證安裝是否成功

使用gpg --version命令來驗證，如果輸出了版本則說明安裝成功。

參考：https://central.sonatype.org/publish/requirements/gpg/#installing-gnupg

4.2. 生成密鑰對

使用命令gpg --full-generate-key生成密鑰對，2年內有效。執行命令後，需要輸入姓名和郵箱（建議和註冊JIRA時用的一致），然後輸入o（註意是字母o）確認生成。隨後會提示輸入一個passphrase口令來保護你的密鑰對，這個口令要記住，後面配置需要使用。
註意：這個命令不建議執行多次，不然生成了多個密鑰對，發佈時還要去配置使用哪個密鑰對，比較麻煩。

參考：https://central.sonatype.org/publish/requirements/gpg/#generating-a-key-pair

4.3. 發佈公鑰

  • 使用命令gpg --keyserver pgp.mit.edu --send-keys 公鑰來發佈。

官網提供了3個地址，有的地址可能不能用，上面這個地址親測有效。（所以官方也不一定靠譜）

  • 使用命令gpg --keyserver pgp.mit.edu --recv-keys 公鑰驗證是否發佈成功。

註意：驗證的命令要等一會執行才能響應數據，估計發佈可能有點延時，可以多執行幾次。反正如果響應如圖所示，就代表發佈成功了。

參考：https://central.sonatype.org/publish/requirements/gpg/#distributing-your-public-key

5. JIRA 項目核審通過後的配置

5.1. 倉庫地址

核審通過後，在JIRA上的項目里可以看到日誌，這代表項目已經擁有發佈許可權了。下圖標記出來的就是倉庫地址。

5.2. 修改 maven 配置

這裡修改的是maven的setting.xml配置文件，如果不知道配置文件在哪裡（那麼你不是一個合格的程式猿），可以在IntelliJ IDEA的settings > Build,Execution,Deployment > Builds Tools > Maven頁面找到User settings file。

  • 配置JIRA賬戶用於發佈
    這裡的<server>-<id>是有用的，一會要在項目的pom文件配置中要對應上。
<servers>
    <server>
        <id>ossrh</id>
        <username>JIRA用戶名</username>
        <password>JIRA登錄密碼</password>
    </server>
</servers>
  • 配置GPG用於文件簽署校驗
    前文2.2小節已經在項目中配置了GPG插件了，這裡要配置GPG的口令才能進行正常的簽署。
    前文4.2小節生成GPG密鑰對的時候，輸入過一個口令passphrase，就用那個。
<profiles>
    <profile>
        <id>ossrh</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <gpg.executable>gpg2</gpg.executable>
            <gpg.passphrase>GPG口令</gpg.passphrase>
        </properties>
    </profile>
</profiles>

5.3. 配置倉庫地址和插件

這裡是在項目的pom文件中配置。

  • 配置發佈的倉庫地址
    這裡的倉庫功能變數名稱，可以從JIRA項目的日誌里看到，核審通過後會給你一個地址，就用那個做為功能變數名稱。按照下麵的格式來配：
<distributionManagement>
    <snapshotRepository>
        <id>ossrh</id>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
    </snapshotRepository>
    <repository>
        <id>ossrh</id>
        <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
</distributionManagement>
  • 配置倉庫插件
    這裡的serverId要和前面maven配置文件setting.xml中配置的<server>-<id>保持一致。nexusUrl就是倉庫地址，和上面配置的一樣。
<build>
    <plugins>
        <plugin>
            <groupId>org.sonatype.plugins</groupId>
            <artifactId>nexus-staging-maven-plugin</artifactId>
            <version>1.6.13</version>
            <extensions>true</extensions>
            <configuration>
                <serverId>ossrh</serverId>
                <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
                <autoReleaseAfterClose>true</autoReleaseAfterClose>
            </configuration>
        </plugin>
    </plugins>
</build>

6. 發佈

JIRA 核審通過後，就可以發佈了

6.1. 發佈到中央倉庫

  • 可以直接在IntelliJ IDEA中點擊deploy來發佈：
  • 輸出如下結果說明發佈成功了：

6.2. 驗證發佈結果

發佈成功以後，並不能立刻在maven中央倉庫中搜索到，大概隔一天以後才能搜索得到，所以不要心急，耐心等待。

  • JIRA 上的回應

執行完發佈動作以後，大概隔了幾分鐘以後，JIRA項目下會多出一條日誌：

這條日誌給出了兩個地址和兩個時間，反正差不多要等個那麼長的時間才能搜得到。我已經發佈到中央倉庫里了，第一個地址里還是找不到，但是第二個地址里能搜到：

下麵這個地址好像是執行完發佈操作後，過一會就能搜得到，可以試試：
https://s01.oss.sonatype.org/content/groups/public/

  • 在中央倉庫里搜索

一般是隔天，才能在中央倉庫里搜得到，在阿裡雲的倉庫里也可以搜得到，阿裡雲本來就是從中央倉庫同步的。

建議使用groupId來搜，一搜一個準。用artifactId來搜在第一頁可能找不到，因為maven會對搜索結果做排序。

7. 彩蛋

  • JAVA_HOME 報錯

如果遇到這樣的報錯The environment variable JAVA_HOME is not correctly set，不要慌，一般是因為你本地環境變數沒有設置JAVA_HOME或者設置成了jre的目錄。如果是因為前者可以去設置一下JAVA_HOME，如果是因為後者，可以把JAVA_HOME的目錄改成jdk/bin的目錄，或者可以改一下項目的pom配置文件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9.1</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
            <configuration>
                <!-- 這裡需要指定jdk的bin目錄下的javadoc執行文件 -->
                <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>
            </configuration>
        </execution>
    </executions>
</plugin>

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Django學習(三) 之 模板中標簽的使用
    寫在前面 最近看到稀土掘金在搞2023年終總結徵文活動，一直想嘗試投稿試試，周末我就花了近一下午時間寫完初稿，然後周一、周二完成精讀再改稿，感覺OK，昨晚凌晨第一時間在稀土掘金投稿。 結果，又發生了同樣的事情。 同樣的文章，在博客園上、公號上閱讀量很OK，在稀土掘金上就上不來。 這應該是我博客園第四 ...
  • 使用C++和QT實現Log自定義日誌系統
    從0到1，手把手帶你使用QT的qInstallMessageHandler函數結合qDebug，qInfo實現自定義的日誌系統，支持輸出日誌到文件和控制台，支持自動檢測日誌文件大小，支持自動更新日誌文件修改日期，自動備份，自動刪除一個月前的日誌文件，支持多線程程式， 支持擴展，可輸出日誌到資料庫，網... ...
  • C++學習筆記八：極限和數學運算<limits><cmath>
    背景 公司的海外業務需要將雲上的操作讀取到內部的日誌文件中，永久保存，供內部審計使用。 由於之前沒有用過AWS相關的SDK，在使用過程中也遇到一些困難，這裡記錄一下，並且總結一下過程。 代碼 快速開始 代碼參考地址：https://github.com/awsdocs/aws-doc-sdk-exa ...
  • C++ Qt開發：SpinBox數值微調框組件
    Qt 是一個跨平臺C++圖形界面開發庫，利用Qt可以快速開發跨平臺窗體應用程式，在Qt中我們可以通過拖拽的方式將不同組件放到指定的位置，實現圖形化開發極大的方便了開發效率，本章將重點介紹`QSpinBox`精度數值組件的常用方法及靈活運用。`QSpinBox`是Qt框架中的一個部件（Widget），... ...
  • 一篇搞定發佈自己的類庫到Maven中央倉庫
    在Maven項目中，90%以上的jar包是通過pom文件直接從開源倉庫中獲取依賴jar包文件，然後在項目中進行集成使用。 此時如果你有一個開源項目，那麼如何將該開源項目發佈到Maven中央倉庫，讓其他人可以方便的使用，而不是先下載jar，然後install的本地？ 本文將通過一步步的操作帶領大家講自 ...
  • python中x[:] x[::]用法總結
    isdigit 字元串的isdigit方法用於判斷字元串是否只包含數字，即0-9的字元 print('1233'.isdigit()) # True print('12.33'.isdigit()) # False isnumeric 字元串的isnumeric方法可用於判斷字元串是否是數字，數字包 ...
  • python將資源打包進exe
    前言 之前py打包的exe一直是不涉及圖片等資源的，直到我引入圖片後打包，再雙擊exe發現直接提示未找到資源。 分析 我py代碼中的圖片引入使用的是項目相對路徑，打包時pyinstaller只會引入py模塊，這種路徑引入的資源其實是不會打包進exe的。有人想的是可以直接將資源放到exe旁邊，但這不是 ...
  • IDEA 2023.3 正式發佈，新特性太強了！
    來源：https://www.jetbrains.com/zh-cn/idea/whatsnew/ 大家好，我是棧長。 IDEA 2023.3 正式發佈啦，有不少實用的新特性，一起來看看！ 推薦一個開源免費的 Spring Boot 實戰項目： https://github.com/javastac ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類