一篇搞定發佈自己的類庫到Maven中央倉庫

来源:https://www.cnblogs.com/ykbb/archive/2023/12/12/17897143.html
-Advertisement-
Play Games

在Maven項目中，90%以上的jar包是通過pom文件直接從開源倉庫中獲取依賴jar包文件，然後在項目中進行集成使用。 此時如果你有一個開源項目，那麼如何將該開源項目發佈到Maven中央倉庫，讓其他人可以方便的使用，而不是先下載jar，然後install的本地？ 本文將通過一步步的操作帶領大家講自 ...


在Maven項目中，90%以上的jar包是通過pom文件直接從開源倉庫中獲取依賴jar包文件，然後在項目中進行集成使用。
此時如果你有一個開源項目，那麼如何將該開源項目發佈到Maven中央倉庫，讓其他人可以方便的使用，而不是先下載jar，然後install的本地？
本文將通過一步步的操作帶領大家講自己的開源項目發佈到Maven中央倉庫(Maven Central Repository)中，https://mvnrepository.com/。
Maven中央倉庫並不支持直接發佈jar包，需要將jar包發佈到一些指定的第三方Maven倉庫，然後該倉庫再將jar包同步到Maven中央倉庫，Sonatype便是這樣的角色

準備工作

  1. 註冊Github賬戶，在申請的時候需要用到GroupId，這邊如果沒有自己的網站及功能變數名稱建議註冊Github。

  2. 註冊Sonatype賬戶，註冊地址：sonatype sign up

    1. Username和Password作為登錄的賬號密碼
    2. 密碼有強度要求
    3. Email用於後續關聯的通知，務必使用真實地址

項目發佈申請

  1. 點擊導航欄的"新建"進行項目發佈申請創建。
    image

    通過在JIRA上創建issue來申請發佈新的jar包，Sonatype的工作人員會進行審核，一般按照要求填寫不會有問題。

    註意：

    1. Group Id：如果有功能變數名稱可以填寫自己的功能變數名稱，如果沒有可以使用Github，Gitee，Gitlib等地址例如:io.github.you_account，此處註意必須是 io 的
    2. Project Url及SCM Url建議都採用Git地址，其中SCM的地址需要帶.git
    3. Already Synced to Central選擇No

  2. 提交後等待一小段時間再來查看剛提交的問題。你會收到類似下圖的回覆。此時會要求進行Group Id的所有權驗證。

    image

    如果填寫的是Github則會要求創建一個指定的倉庫，創建一個即可。

    如果填寫的是自己的自己的功能變數名稱則會要求創建個指定文件到此功能變數名稱下。

  3. 填寫按要求完成後修改狀態為開放狀態 。點擊Wait for Reponse在彈出的狀態列表中選擇 開放 。
    image

    如果按要求完成了所有的操作等待一段時間後一般就自動通過了。這時會給予推送伺服器的地址，後續所有的相關地址都需要用到。
    image

    到此發佈申請也就完成了。

安裝GPG

發佈到Maven倉庫中的所有文件都要使用GPG簽名，以保障完整性。因此，我們需要在本地安裝並配置GPG。

  1. 進入gnupg下載，https://www.gnupg.org/download/index.html

  2. 根據操作系統下載不同的版本併進行安裝。

    此處以Windows為例：

    建議下載2個安裝包分別為

    1. Gpg4win：Full featured Windows version of GnuPG

      此工具通過Windows視窗進行密鑰的管理。

    2. download sig：Simple installer for GnuPG 1.4

      此工具用於後續Maven發佈使用

  3. 創建密鑰

    1. Gpg4win

      生成秘鑰，按步步驟提示進行操作
      必須勾選密碼
      image
      按提示輸入密碼
      image

      秘鑰生成好後，右鍵選擇密鑰，需要你把公鑰上傳到公共伺服器供sonatype驗證。
      image

    2. 命令行

      生成秘鑰，按步驟提示進行操作

      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
電子郵件地址： [email protected]
您選定了此用戶標識：
    “xxxxxxxx <[email protected]>”
更改姓名（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 <[email protected]>
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: 發送至公鑰伺服器失敗：文件結尾

配置setting.xml

setting.xml為Maven的全局配置文件，一般路徑為$MAVEN_HOME/conf/settings.xml

找到Services節點進行如下配置

<servers>
    <server>
        <id>ossrh</id>
        <username>你的Sonatype賬號</username>
        <password>你的Sonatype密碼</password>
    </server>
</servers>

找到profiles節點進行如下配置,gpg.executable節點建議配置第二個安裝包安裝的gpg路徑，這一步一定要做不然容易發佈的時候提示找不到gpg。

<profiles>
      <profile>
          <id>ossrh</id>
          <activation>
              <activeByDefault>true</activeByDefault>
          </activation>
          <properties>
              <gpg.executable>"D:\Program Files (x86)\GnuPG\bin\gpg.exe"</gpg.executable>
              <gpg.passphrase>你的密鑰創建時候的密碼</gpg.passphrase>
          </properties>
      </profile>
</profiles>

配置pom.xml

以下為一些關鍵點的配置示例

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!--Maven相關信息配置-->
    <name>fluent-validation</name>
    <url>https://github.com/yikuaibaiban/fluent-validation</url>
    <description>fluent-validation is a streaming validation framework.</description>
    <!--Issue 配置-->
    <issueManagement>
        <system>Github Issue</system>
        <url>https://github.com/yikuaibaiban/fluent-validation/issues</url>
    </issueManagement>
    <licenses>
        <license>
            <name>The Apache Software License, Version 2.0</name>
            <url>https://apache.org/licenses/LICENSE-2.0.txt</url>
        </license>
    </licenses>
    <!--開發人員信息配置-->
    <developers>
        <developer>
            <name>yikuaibaiban</name>
            <email>[email protected]</email>
            <timezone>+8</timezone>
        </developer>
    </developers>
    <!--scm信息配置-->
    <scm>
        <url>https://github.com/yikuaibaiban/fluent-validation</url>
        <connection>scm:https://github.com/yikuaibaiban/fluent-validation.git</connection>
        <developerConnection>scm:git:https://github.com/yikuaibaiban/fluent-validation.git</developerConnection>
    </scm>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>${maven.compiler.source}</source>
                    <target>${maven.compiler.target}</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <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>
                                <id>attach-sources</id>
                                <goals>
                                    <goal>jar-no-fork</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                    <!-- Javadoc -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>3.5.0</version>
                        <configuration>
                            <windowtitle>${project.name}</windowtitle>
                            <doctitle>${project.name}</doctitle>
                            <show>private</show>
                            <detectLinks>false</detectLinks>
                            <detectOfflineLinks>true</detectOfflineLinks>
                            <linksource>true</linksource>
                            <detectJavaApiLink>true</detectJavaApiLink>
                            <source>8</source>
                        </configuration>
                        <executions>
                            <execution>
                                <id>attach-javadocs</id>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                    <!-- 以下是GPG -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-gpg-plugin</artifactId>
                        <version>1.6</version>
                        <executions>
                            <execution>
                                <phase>verify</phase>
                                <goals>
                                    <goal>sign</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
            <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>
        </profile>
    </profiles>
</project>

發佈到Maven中央倉庫

推送代碼

  1. 使用命令行發佈 mvn clean deploy -P release
  2. 使用Idea發佈
    image

後續操作(必須要操作)

此時進入https://s01.oss.sonatype.org並登錄(登錄的賬號密碼與剛開始註冊的賬號密碼一致)查看發佈好的構件，點擊左側的Staging Repositories。

此時需註意，如果項目中版本信息為1.0.0-SNAPSHOT，即SNAPSHOT為尾碼，則發佈的項目位於Snapshots目錄下。在左上角的Artifact Search中能夠搜到。

如果是Release尾碼，則可直接在Staging Repositories中看到（有可能要稍等一下，等待平臺處理）。
選中對於的repository之後，點擊的close，close時會檢查發佈的構件是否符合要求。若符合要求，則close成功，成功之後點擊箭頭所指的release，即可正式將jar包發佈到Sonatype OSSRH倉庫。
image

當點擊Release之後，郵件中會收到Issues變化的信息，提示同步已經被激活，正常10分鐘就可以更新同步。

release成功大概2個小時之後，該構件就會同步到Maven中央倉庫，屆時會有郵件通知。

實踐過程中發現十分鐘之內已經成功同步到https://repo1.maven.org/的中央倉庫當中。

逐步的其他Maven倉庫，包括阿裡鏡像都會進行同步。

本文來自博客園，作者：一塊白板，轉載請註明原文鏈接：https://www.cnblogs.com/ykbb/p/17897143.html


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

-Advertisement-
Play Games
更多相關文章
  • NestJs系列之使用Vite搭建項目
    介紹 在使用nest創建項目時,預設使用webpack進行打包,有時候啟動項目需要1-2分鐘。所以希望採用vite進行快速啟動項目進行開發。 本文主要使用NestJs、Vite和swc進行配置。文章實操較多，概念性的東西可訪問對應的官方文檔進行瞭解。tips: 個人認為概念性的東西,在文章中指出。對 ...
  • 面向對象編程，看這篇就夠了
    面向對象編程是一種強大而靈活的編程範式，它可以幫助我們更好地組織和管理代碼，提高代碼的可讀性和可維護性，這使得它特別適合用在大型工程項目中。然而，我們也需要註意其可能帶來的問題，尤其是在併發和複雜系統中。 ...
  • Windows下獲取設備管理器列表信息-setupAPI
    背景及問題： 在與硬體打交道時，經常需要知道當前設備連接的硬體信息，以便連接正確的硬體，比如串口通訊查詢連接的硬體及埠，一般手工的方式就是去設備管理器查看相應的信息，應用程式如何讀取這一部分信息呢，Windows下的SetupAPI系列就可以解決這個問題 示常式序 #include<Windows ...
  • C 語言函數：入門指南
    C 語言中的函數聲明和定義 您可以通過以下方式創建並調用函數： // 創建一個函數 void myFunction() { printf("我剛被執行了!"); } int main() { myFunction(); // 調用函數 return 0; } 一個函數包括兩個部分： 聲明：函數名稱、 ...
  • 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），... ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類