構建自己的jar包上傳至Mvaen中央倉庫和版本更新
一直羨慕別人製造輪子,開源項目,供別人使用;我也想這樣,可以自己才疏學淺,本次就將自己寫小工具上傳到Maven的中央倉庫。
一步一步詳細教程演示如下:
開始要注意這個幾個Maven相關地址:
就是申請上傳資格和groupId 的地方,註冊賬號、創建和管理issue,Jar包的發佈是以解決issue的方式起步的
把jar包上傳到這裏,Release 之後就會同步到maven中央倉庫。
- 倉庫鏡像: http://search.maven.org/
最終工件可以在這裏搜索到。
創建一個新的項目Issue
第一步:註冊工單管理(register sonatype)
由於Maven 中央倉庫是由企業Sonatype,Inc.負責運營維護的,因此你需要先前往 https://issues.sonatype.org/secure/Signup!default.jspa 註冊一個賬號(如果你已經有了賬號,可以跳過此步驟)。
第二步:創建工單(nexus)
點擊header 頭 “create”按鈕創建一個工單,主要用途註冊你上傳jar包基本信息,主要groupid,通過審覈有兩個目的:1.防止重複,約束groupid規範,定義grupid最好有所屬的域名
登錄了賬號之後,你需要新建一個Issue。Issue是問題的意思,相當於你提交了一個工單給 Sonatype 的工作人員,申請開通Maven中央倉庫的發佈權限。
點擊頂部的【新建】按鈕,填寫申請表單,即可提交申請。
- Project URL:項目地址。
- SCM URL :項目clone的git地址。
- Summary:你的jar包自己起個名字(無要求)。
- Group Id:項目標識。
【提醒】確group id對應的是域名,推薦使用個人域名。
注意:groupId 不能隨意填寫。
- 如果你(或所屬機構)擁有自己的域名,可以填寫自己的域名。工作人員在審覈時,會反饋給你,要求驗證域名的所有權,你可以採取如下兩種方式之一完成驗證:
- 爲域名添加一個指向 Issue編號 的TXT記錄;
- 將域名的訪問重定向到你的項目主頁地址(Project URL)。
- 如果你沒有自己的域名,你只能使用項目託管方的域名。例如 你的項目在Github ,主頁地址爲 https://github.com/username/projectName,那麼你只能使用 io.github.username 或 com.github.username 作爲groupId。
點擊 Create 之後,你就會進入一個 jira 頁面(sonatype 使用jira 來追蹤每一個項目進度),與此同時你註冊時使用的郵箱中也會收到一封郵件提示你,任務創建成功,正在等待處理。
提交成功後,你需要耐心等待審覈。不過,請不用擔心,Sonatype工作人員的審覈效率是很高的,工作時間範圍內,基本上一小時內就會響應。
因爲我這邊用的是自己的域名,所以我需要爲域名添加一個一個指向 Issue編號 的TXT記錄(也就是你新建這個問題的地址:https://issues.sonatype.org/browse/OSSRH-58328)。
添加TXT記錄之後需要回復工作人員
-
新建工單之後,工作人員會回覆你,需要審覈驗證你的域名所有權
-
我這邊添加完TXT記錄之後,回覆工作人員
-
工作人員審覈驗證完之後會回覆你,讓你可以上傳構建你的jar包了,當工單狀態變爲“已解決”,就可以上傳maven項目了
gpg 環境安裝
win下載地址:https://www.gnupg.org/download/
安裝就下一步下一步...
Mac 安裝:brew install gpg
win或者mac安裝之後在命令行輸入:
#gpg 常用命令
gpg --help #幫助
gpg --version #查看版本
gpg --list-keys #查看已生成的密鑰
gpg --delete-key [用戶ID] #刪除密鑰
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} #查詢公鑰是否發佈成功
gpg --keyserver hkp://pool.sks-keyservers.net:11371 --send-keys 3C50A16F87687255F1AB96BC7E7CB475C5DF4735
gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys 3C50A16F87687255F1AB96BC7E7CB475C5DF4735
gpg --keyserver hkp://keys.gnupg.net:11371 --send-keys 3C50A16F87687255F1AB96BC7E7CB475C5DF4735
#查看是否上傳成功
gpg --keyserver hkp://pool.sks-keyservers.net:11371 --recv-keys ${公鑰ID}
gpg --keyserver hkp://pool.sks-keyservers.net:11371 --recv-keys 3C50A16F87687255F1AB96BC7E7CB475C5DF4735
gpg --keyserver hkp://keyserver.ubuntu.com:11371 --recv-keys 3C50A16F87687255F1AB96BC7E7CB475C5DF4735
gpg --keyserver hkp://keys.gnupg.net:11371 --recv-keys 3C50A16F87687255F1AB96BC7E7CB475C5DF4735
#導出密鑰對
gpg --armor --output "輸出文件名" --export "用戶ID"
gpg --armor --output C:\Config\gpg\test-public-key.asc --export "用戶ID"
gpg --armor --output C:\Config\gpg\test-private-key.asc --export-secret-keys
#導入密鑰
gpg --import test-public-key.asc #導入公鑰
gpg --import test-private-key.asc #導入私鑰
- 輸入
gpg --gen-key
生成密鑰對 - 將密鑰對公鑰上傳到服務器
配置Maven
需要修改的 Maven 配置文件包括:setting.xml
(全局級別)與 pom.xml
(項目級別)
setting.xml(全局級別)
這裏的username是你一開始註冊sonatype賬號的username,而不是註冊時填寫的郵箱。
<servers>
<server>
<id>ossrh</id>
<username>用戶名</username>
<password>密碼</password>
</server>
</servers>
使用自己註冊的 Sonatype 賬號的用戶名與密碼來配置以上 server 信息。
此處 id ossrh
應和下面 pom.xml
中 snapshotRepository 和 repository 裏面的 id 保持一致。
pom.xml(項目級別)
說明
<name>ali-tools</name>
<url>https://github.com/452425952/ali-tools</url>
<description>Ali Tools project for Spring Boot</description>
證書
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
scm軟件配置管理
<scm>
<connection>https://github.com/452425952/ali-tools.git</connection>
<developerConnection>https://github.com/452425952/ali-tools.git</developerConnection>
<url>https://github.com/452425952/ali-tools</url>
</scm>
開發者信息
<developers>
<developer>
<id>sky-0914</id>
<name>sky-0914</name>
<email>[email protected]</email>
<roles>
<role>Developer</role>
</roles>
<timezone>+8</timezone>
</developer>
</developers>
打包配置,由於發佈到maven中央倉庫會要求我們在上傳jar到同時,必須同步發佈對應到Javadoc、source、asc(利用gpg生成到校驗),所以需要在maven中添加以下構建插件
<build>
<plugins>
<!-- 打包時跳過測試 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.18.1</version>
<configuration>
<skipTests>true</skipTests>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<!-- 以下都爲上傳jar默認配置不做修改 -->
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.8</version>
<!-- autoReleaseAfterClose的值爲true,則腳本會自動完成在平臺上close、release的操作,至此你將成功發佈了 -->
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.3</version>
<configuration>
<autoVersionSubmodules>true</autoVersionSubmodules>
<useReleaseProfile>false</useReleaseProfile>
<releaseProfiles>release</releaseProfiles>
<goals>deploy</goals>
</configuration>
</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>
<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</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<!-- JDK8必須使用下面的配置 -->
<configuration>
<encoding>UTF-8</encoding>
<charset>UTF-8</charset>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
上傳打包文件配置
這裏的id需要和setting.xml中的 server 標籤中的id對應
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
</repository>
</distributionManagement>
發佈操作
執行以下命令進行發佈(如果 pom.xml 中 autoReleaseAfterClose 的值爲true,則腳本會自動完成在平臺上close、release的操作,至此你將成功發佈了,否則我們繼續查看第2步)
mvn clean deploy -X # -X可以查看詳細信息
打包過程遇到問題:
- javadoc格式錯誤,需要將錯誤問題解決。
- failureMessage No public key,這個是gpg祕鑰沒有上傳成功導致,我在實際操作時,明明上傳成功,但是還是這樣提示,只能多打包幾次就可以了,不知道什麼原因。解決方法: 如果你知道哪個密鑰服務器會被查詢,你可以直接在那裏上傳你的密鑰。
- 實驗過程中我的實際執行結果是(注意可能會超時,多試幾次就好)
登錄https://oss.sonatype.org,然後選擇staging Repositories
如果在pom文件中的 autoReleaseAfterClose的值沒有設置的話,需要手動發佈的組件,依次執行Close、Release操作
如果Release成功,並且你是首次發佈組件,則需要到你創建到issue中回覆 “我已經成功發佈該組件”,經歷大概2小時後,該組件將會同步到對應的maven倉庫 。
如果Close或者Release不成功,你可以如下圖操作查看原因並谷歌定位,或者回復諮詢
查找開源庫
注意開源庫發佈出去之後,還是需要等待一段時間,才能在這裏 https://search.maven.org/ 查找我們的開源庫,以及查看如何依賴自己的開源庫。
後續發佈到中央倉庫
首次發佈都是比較痛苦的,我們首次進行發佈,實際上遇到很多問題,而且還要Sonatype進行驗證。第一次總是比較麻煩的,所謂萬事開通難拿,接下來後續的發佈動作,其實並沒有那麼麻煩了
發佈命令和原來的一樣;如果是和第一次發佈在同一臺電腦(並且沒有重裝過了,gpg密鑰對還在),那麼直接執行
mvn clean deploy -X
如果換電腦發佈了,那麼就需要將原來的gpg密鑰對(公鑰和私鑰)導出來保存之後,重新導入到新電腦上(上述內容介紹了gpg常用命令)
#導出密鑰對
gpg --armor --output "輸出文件名" --export "用戶ID"
gpg --armor --output C:\Config\gpg\test-public-key.asc --export "用戶ID"
gpg --armor --output C:\Config\gpg\test-private-key.asc --export-secret-keys
#導入
gpg --import test-public-key.asc #導入公鑰
gpg --import test-private-key.asc #導入私鑰
參考文章:
http://www.itmuch.com/work/sonartype-deploy-mvn-depencency-to-maven-central/
gpg密鑰對過期解決方案:http://blog.didispace.com/maven-gpg-expire/
gpg: signing failed: Inappropriate ioctl for device
最近上傳jar到中央倉庫的時候,遇到一個問題:
gpg: signing failed: Inappropriate ioctl for device
原因是 gpg 在當前終端無法彈出密碼輸入頁面。
解決辦法很簡單:
export GPG_TTY=$(tty)
重新執行,發現會彈出一個密碼輸入界面。
Mac打maven包——gpg: 簽名時失敗
gpg: signing failed: Inappropriate ioctl for device
原因是GPG版本是最新版本,需要在.gnupg文件夾下增加兩個配置,
mac下在~/.gnupg這兩個文件夾下修改
gpg.conf和gpg-agent.conf兩個文件,
在gpg-agent.conf中新建一行添加
allow-loopback-pinentry
在gpg.conf添加
use-agent
pinentry-mode loopback
保存就可以OK了。
趙小胖個人博客