腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

如何發(fā)布jar包到maven中央倉庫

更新時間：2023年12月13日 09:03:07 作者：是禿子遲早會發(fā)光的

這篇文章主要介紹了發(fā)布jar包到maven中央倉庫的相關(guān)知識,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友參考下吧

1. 環(huán)境

在網(wǎng)上找的很多文章中寫得都有很多問題，這里記錄一下最近一次成功地發(fā)布jar包到maven中央倉庫的過程。并附帶上每一個步驟官方的指導(dǎo)鏈接。

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

2. 項(xiàng)目配置

官方對發(fā)布的項(xiàng)目做了一些必需的要求，如果不按要求來，發(fā)布可能會報(bào)錯。

2.1. javadoc和source

以非pom方式打包的項(xiàng)目（pom.xml配置文件中可以通過標(biāo)簽配置打包方式，默認(rèn)就是jar），在打包完成后，target目錄下必須要包含***-sources.jar和***-javadoc.jar。如下圖：

為了達(dá)成以上效果，需要在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。如下圖：

為了達(dá)成以上效果，需要在pom.xml中依賴插件（加完插件不要急著構(gòu)建，還要下載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. 項(xiàng)目名稱和版本配置

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

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

2.4. 項(xiàng)目名稱、描述和 URL

這個是為了增加可讀性。

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

參考：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. 開發(fā)人員信息

留你自己的藝名和郵箱：

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

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

2.7. SCM 源碼管理系統(tǒng)信息

可以使用github（或gitee）的項(xiàng)目地址。

<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. 文件簽名校驗(yàn)（非必需）

官網(wǎng)說必需要包含.md5和.sha1簽名校驗(yàn)文件，但我沒有特地去配置這個，也是可以發(fā)布的?？梢蕴^這一步。

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

3. 在 JIRA 上提發(fā)布申請

3.1. 注冊 JIRA

點(diǎn)擊如下鏈接注冊賬號并登錄，如果有賬號直接登錄即可：
https://issues.sonatype.org/secure/Signup!default.jspa

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

3.2. 創(chuàng)建項(xiàng)目

點(diǎn)擊新建，按照下面的圖示來填寫：

groupId：要和項(xiàng)目里對應(yīng)上，必須是一個可用的域名的反轉(zhuǎn)字符串，如果項(xiàng)目是放在github上，必須使用io.github.{account}的格式，否則會審核不通過（注意：不能使用com.github）。
Project URL/SCM url：直接使用github的項(xiàng)目地址即可。

3.3. 查看剛剛創(chuàng)建的項(xiàng)目

正常情況下創(chuàng)建好默認(rèn)就會進(jìn)入剛剛創(chuàng)建的項(xiàng)目，如果進(jìn)不去，可以按照路徑項(xiàng)目-查看所有項(xiàng)目-類別-Central即可看到項(xiàng)目鏈接，點(diǎn)進(jìn)去后，切換篩選器我的報(bào)告就能看到創(chuàng)建的項(xiàng)目了。

3.4. 在github中創(chuàng)建一個空項(xiàng)目

創(chuàng)建好的項(xiàng)目，會分配一個唯一標(biāo)識OSSRH-***（見上圖），需要用這個標(biāo)識去github上創(chuàng)建一個空項(xiàng)目，這個是為了向核審管理員證明需要發(fā)布的github項(xiàng)目確實(shí)是你自己的項(xiàng)目。

3.5. 等待管理員審核

管理員都在國外，因?yàn)闀r差，一般隔天才會核審?fù)ㄟ^。沒辦法，耐心等著吧。
審核通過后，會發(fā)郵件（郵箱就是注冊JIRA的那個），也會在JIRA項(xiàng)目下出現(xiàn)活動日志。

4. 獲取 GPG 密鑰

在等待JIRA項(xiàng)目審核的同時，可以并行把GPG密鑰搞定。
注意：mac系統(tǒng)和windows系統(tǒng)在獲取GPG密鑰時有些區(qū)別，mac全程都是通過命令行搞定的，而windows提供了操作界面，可能會方便一點(diǎn)。這里只介紹mac系統(tǒng)的配置方式，windows系統(tǒng)可以自行搜配置教程。

4.1. 安裝 GnuPG

用下面的鏈接下載 GnuPG，選擇系統(tǒng)對應(yīng)的版本。

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

驗(yàn)證安裝是否成功

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

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

4.2. 生成密鑰對

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

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

4.3. 發(fā)布公鑰

使用命令gpg --keyserver pgp.mit.edu --send-keys 公鑰來發(fā)布。

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

使用命令gpg --keyserver pgp.mit.edu --recv-keys 公鑰驗(yàn)證是否發(fā)布成功。

注意：驗(yàn)證的命令要等一會執(zhí)行才能響應(yīng)數(shù)據(jù)，估計(jì)發(fā)布可能有點(diǎn)延時，可以多執(zhí)行幾次。反正如果響應(yīng)如圖所示，就代表發(fā)布成功了。

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

5. JIRA 項(xiàng)目核審?fù)ㄟ^后的配置

5.1. 倉庫地址

核審?fù)ㄟ^后，在JIRA上的項(xiàng)目里可以看到日志，這代表項(xiàng)目已經(jīng)擁有發(fā)布權(quán)限了。下圖標(biāo)記出來的就是倉庫地址。

5.2. 修改 maven 配置

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

配置JIRA賬戶用于發(fā)布
這里的<server>-<id>是有用的，一會要在項(xiàng)目的pom文件配置中要對應(yīng)上。

<servers>
    <server>
        <id>ossrh</id>
        <username>JIRA用戶名</username>
        <password>JIRA登錄密碼</password>
    </server>
</servers>

配置GPG用于文件簽署校驗(yàn)
前文2.2小節(jié)已經(jīng)在項(xiàng)目中配置了GPG插件了，這里要配置GPG的口令才能進(jìn)行正常的簽署。
前文4.2小節(jié)生成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. 配置倉庫地址和插件

這里是在項(xiàng)目的pom文件中配置。

配置發(fā)布的倉庫地址
這里的倉庫域名，可以從JIRA項(xiàng)目的日志里看到，核審?fù)ㄟ^后會給你一個地址，就用那個做為域名。按照下面的格式來配：

<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. 發(fā)布

JIRA 核審?fù)ㄟ^后，就可以發(fā)布了

6.1. 發(fā)布到中央倉庫

可以直接在IntelliJ IDEA中點(diǎn)擊deploy來發(fā)布：

輸出如下結(jié)果說明發(fā)布成功了：

6.2. 驗(yàn)證發(fā)布結(jié)果

發(fā)布成功以后，并不能立刻在maven中央倉庫中搜索到，大概隔一天以后才能搜索得到，所以不要心急，耐心等待。

JIRA 上的回應(yīng)

執(zhí)行完發(fā)布動作以后，大概隔了幾分鐘以后，JIRA項(xiàng)目下會多出一條日志：

這條日志給出了兩個地址和兩個時間，反正差不多要等個那么長的時間才能搜得到。我已經(jīng)發(fā)布到中央倉庫里了，第一個地址里還是找不到，但是第二個地址里能搜到：

下面這個地址好像是執(zhí)行完發(fā)布操作后，過一會就能搜得到，可以試試：
https://s01.oss.sonatype.org/content/groups/public/

在中央倉庫里搜索

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

建議使用groupId來搜，一搜一個準(zhǔn)。用artifactId來搜在第一頁可能找不到，因?yàn)?code>maven會對搜索結(jié)果做排序。

7. 彩蛋

JAVA_HOME 報(bào)錯

如果遇到這樣的報(bào)錯The environment variable JAVA_HOME is not correctly set，不要慌，一般是因?yàn)槟惚镜丨h(huán)境變量沒有設(shè)置JAVA_HOME或者設(shè)置成了jre的目錄。如果是因?yàn)榍罢呖梢匀ピO(shè)置一下JAVA_HOME，如果是因?yàn)楹笳撸梢园袹AVA_HOME的目錄改成jdk/bin的目錄，或者可以改一下項(xiàng)目的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執(zhí)行文件 -->
                <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>
            </configuration>
        </execution>
    </executions>
</plugin>

到此這篇關(guān)于發(fā)布jar包到maven中央倉庫的文章就介紹到這了,更多相關(guān)發(fā)布jar包到maven中央倉庫內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: