作為 Java 開(kāi)發(fā)者(偽)吃衅,工作中一定離不開(kāi) Maven圆雁。
偶爾也需要發(fā)布自己的構(gòu)件到 Maven 中央倉(cāng)庫(kù)中(https://oss.sonatype.org/)娶耍。
但是經(jīng)常有這樣那樣的坑(因?yàn)榭偸菗Q電腦 XD)梧疲,在這里記錄一下,以備后續(xù)查閱排惨。
上傳步驟
將項(xiàng)目發(fā)布到 maven 中央倉(cāng)庫(kù)的一般步驟如下:
注冊(cè)Sonatype的賬戶吭敢。地址:https://issues.sonatype.org/secure/Signup!default.jspa
-
提交發(fā)布申請(qǐng)。(僅第一次)
- 創(chuàng)建 Issue:https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134
- 項(xiàng)目類型是
Community Support - Open Source Project Repository Hosting
-
groupId
對(duì)應(yīng)的域名你需要有所有權(quán)
-
使用 GPG 生成密鑰對(duì)若贮。
Windows 安裝:http://gpg4win.org/
Mac 安裝:
brew install gpg
-
gpg --version
檢查是否安裝成功 -
gpg --gen-key
生成密鑰對(duì) -
gpg --list-keys
查看公鑰 -
gpg --keyserver hkp://pool.sks-keyservers.net --send-keys 公鑰ID
將公鑰發(fā)布到 PGP 密鑰服務(wù)器 -
gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 公鑰ID
查詢公鑰是否發(fā)布成功
-
-
配置 maven省有。
需要修改的 Maven 配置文件包括:setting.xml
(全局級(jí)別)與pom.xml
(項(xiàng)目級(jí)別)痒留。-
setting.xml
配置一覽<settings> ... <servers> <server> <id>snapshotRepository-id</id> <username>用戶名</username> <password>密碼</password> </server> </servers> ... </settings>
使用自己注冊(cè)的 Sonatype 賬號(hào)的用戶名與密碼來(lái)配置以上 server 信息。
此處 id
snapshotRepository-id
應(yīng)和下面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 的時(shí)候匈子,創(chuàng)建源碼包河胎、創(chuàng)建文檔包、使用 GPG 進(jìn)行數(shù)字簽名虎敦。此外游岳,snapshotRepository 與 repository 中的 id 一定要與setting.xml
中 server 的 id 保持一致。 -
-
上傳構(gòu)件到 OSS 中其徙。
mvn clean deploy -P release
在 OSS 中發(fā)布構(gòu)件胚迫。進(jìn)入 https://oss.sonatype.org/,點(diǎn)擊
Staging Repositories
-> 在搜索欄輸入你的 groupId -> 勾選你的構(gòu)件并點(diǎn)擊 close -> 點(diǎn)擊 tab 欄的 release唾那。通知 Sonatype 的工作人員關(guān)閉 issue访锻。(僅第一次)
參考地址:https://my.oschina.net/huangyong/blog/226738
等待審批通過(guò)后,就可以在中央倉(cāng)庫(kù)中搜索到自己發(fā)布的構(gòu)件了闹获!
但是期犬,事情并不是那么簡(jiǎn)單的〔郑總是會(huì)出現(xiàn)這樣那樣的坑哭懈。
碰到的坑一覽
GPG 生成密鑰對(duì)
消息提示亂碼
出現(xiàn)該步驟其實(shí)是輸入密碼的步驟灾馒。但是由于是中文的緣故茎用,消息提示亂碼了。
只需要在下面橫線上輸入密碼之后睬罗,將光標(biāo)移動(dòng)到下面的好轨功,回車即可。注意容达,密碼需要輸入兩次古涧,請(qǐng)保持兩次一致。
將公鑰發(fā)布到 PGP 密鑰服務(wù)器
gpg: 發(fā)送至公鑰服務(wù)器失敾ㄑ巍:Server indicated a failure
因安裝了新版的 gpg羡滑,在 gpg --list-keys
時(shí)顯示如下:
pub rsa2048 2019-04-12 [SC] [有效至:2021-04-11]
9A1640F7A2551131612D51B12D83594B7B29D86A
uid [ 絕對(duì) ] chengww <chengww5217@163.com>
sub rsa2048 2019-04-12 [E] [有效至:2021-04-11]
發(fā)布公鑰到服務(wù)器時(shí)菇爪,填的公鑰 ID 為 9A1640F7A2551131612D51B12D83594B7B29D86A
,終端上顯示為:
gpg --keyserver hkp://subkeys.pgp.net --send-keys 9A1640F7A2551131612D51B12D83594B7B29D86A
...
gpg: 正在發(fā)送密鑰 2D83594B7B29D86A 到 hkp://subkeys.pgp.net
gpg: 發(fā)送至公鑰服務(wù)器失斊饣琛:Server indicated a failure
gpg: 發(fā)送至公鑰服務(wù)器失數手妗:Server indicated a failure
只需要將公鑰 ID 從 9A1640F7A2551131612D51B12D83594B7B29D86A
修改成 2D83594B7B29D86A
即可:
gpg --keyserver hkp://subkeys.pgp.net --send-keys 2D83594B7B29D86A
配置 maven
全局級(jí)別 setting.xml 在哪里配置
settings.xml
文件一般存在于兩個(gè)位置:
全局配置: ${M2_HOME}/conf/settings.xml
用戶配置:${user.home}/.m2/settings.xml
如果實(shí)在是不清楚的,請(qǐng)自行 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
...
關(guān)于 setting.xml
相關(guān)講解參見(jiàn):http://www.reibang.com/p/110d897a5442
上傳構(gòu)件到 OSS
Maven Sonatype Nexus return 401
401 錯(cuò)誤职祷,一般都是未在 setting.xml
中設(shè)置用戶名密碼所致(或用戶名密碼不正確)氏涩。
參見(jiàn)上述 4.配置 maven 配置下 setting.xml
。
gpg: signing failed: Inappropriate ioctl for device
原因是新版 gpg 在當(dāng)前終端無(wú)法彈出密碼輸入頁(yè)面有梆。
解決:
export GPG_TTY=$(tty)
在當(dāng)前終端中 export(臨時(shí)解決)
或者加入到 ~/.bash_profile
是尖,然后 source ~/.bash_profile
gpg: signing failed: Screen or window too small
執(zhí)行上述命令后在 IntelliJ IDEA 中的終端(Terminal)中還是不能彈出密碼輸入界面,且報(bào)上面的錯(cuò)泥耀。
這個(gè)時(shí)候就要到系統(tǒng)的的終端饺汹,cd 到項(xiàng)目目錄,然后執(zhí)行 mvn clean deploy -P release
結(jié)束語(yǔ)
路漫漫其修遠(yuǎn)兮痰催,愿天下沒(méi)有 BUG首繁。