发布自己的jar包到Maven中央仓库

忘是亡心i 2022-11-29 03:17 298阅读 0赞

Maven仍然是目前使用人数很多的、非常受欢迎的项目构建工具。其方便之处在于：我们只需在配置文件pom.xml中引入依赖和插件，他就可以自动从中央仓库下载、配置并运行程序。不过假设我们自己写了一个jar外部包，想放到maven中央仓库并使得别人和我们自己使用的时候更加方便，应该怎么做呢？

# 一，去sonatype网站注册账户并申请工单 #

进入[issues.sonatype.org][]，注册一个账户，然后点击“新建”按钮创建一个工单：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70][]

如下图，项目选择：Community Support - Open Source Project Repository Hosting (OSSRH)

问题类型选择：New Project

其余如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 1][]

等待管理员审核。审核完成，管理员会在下面提示你让你验证这个域名是你的或者证明gitee或者github空间是你的，例如我的：

![20200819095112271.png][] 意思是让我在我的gitee账户中新建一个公开仓库，其空间地址为：

[https://gitee.com/swsk33/OSSRH-60021][https_gitee.com_swsk33_OSSRH-60021]

新建完成后，点击下方的“备注”按钮回复管理员告诉他我已经新建仓库。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 2][]

验证完成，管理员就会接着回复你一些地址，这就说明你的工单通过了，可以上传项目了。

#  二，配置我们的项目 #

现在我们可以上传项目了。

先进入我们的maven安装目录，编辑目录里面的conf文件夹里面的settings.xml文件，找到里面的<servers>标签，添加如下内容：

<server>
        <id>自定义一个snapshot服务器id</id>
        <username>你刚刚注册的sonatype用户名</username>
        <password>你刚刚注册的sonatype用户密码</password>
    </server>
    
    <server>
        <id>自定义一个release服务器id</id>
        <username>你刚刚注册的sonatype用户名</username>
        <password>你刚刚注册的sonatype用户密码</password>
    </server>

这个配置是配置我们sonatype服务器的账户，使得我们的项目可以上传上去，这里举个例子：

<server>
        <id>snapshot</id>
        <username>user</username>
        <password>123456</password>
    </server>
    
    <server>
        <id>release</id>
        <username>user</username>
        <password>123456</password>
    </server>

再配置我们的项目的pom.xml如下形式：

<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>
    	
    	<groupId>组</groupId>
    	<artifactId>包名</artifactId>
    	<version>版本</version>
    	<name>应用名称</name>
    	<description>描述</description>
    	<url>应用网址</url>
    	
    	<packaging>jar</packaging>
    	
    	
    	<properties>
    		<java.version>1.8</java.version>
    		<maven.compiler.source>${java.version}</maven.compiler.source>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<maven.compiler.target>${java.version}</maven.compiler.target>
    	</properties>
    
    	
    	<licenses>
    		<license>
    			<name>The Apache Software License, Version2.0</name>
    			<url>http://www.apache.org/licenses/</url>
    			<distribution>repo</distribution>
    		</license>
    	</licenses>
    
    	
    	<scm>
    		<url>项目地址</url>
    		<connection>项目git地址</connection>
    		<developerConnection>项目地址</developerConnection>
    	</scm>
    
    	
    	<developers>
    		<developer>
    			<name>姓名</name>
    			<email>邮箱</email>
    			<url>主页</url>
    		</developer>
    	</developers>
    
    	
    	<distributionManagement>
    		<snapshotRepository>
    			
    			<id>snapshot</id>
    			<url>https://oss.sonatype.org/content/repositories/snapshots</url>
    		</snapshotRepository>
    		<repository>
    			
    			<id>release</id>
    			<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
    		</repository>
    	</distributionManagement>
    	
    	
    	<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>
    			
    			
    			<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>
    		</plugins>
    	</build>
    </project>

简单的说一下这个配置文件。

<groupId>必须就是我们刚刚工单申请的groupId，包名自己取。

<version>是应用版本，注意版本里面不要带有\-SNAPSHOT字样，否则上传后可能无法在仓库找到并发布。

<url>、<name>和<description>是项目网址、名称和描述，这三者都是必须要的，缺一不可，否则上传项目是无法通过校验的。

<licenses>、<developers>和<scm>这个也是必须的，根据自己的实际情况填写。

<distributionManagement>中要设置snapshot仓库（<snapshotRepository>）和release仓库（<repository>）地址，如上填写，需要注意的是两个仓库配置中的<id>必须和我们前面设置的settings.xml中的<servers>中的<id>对应一致，否则无法上传。

<build>部分是发布项目必要的一些组件，已经在上面的配置文件中配置好了，不用改变了，作用见上面的注释。

上面给出的示例，大家可以全部复制作为一个模板去使用，自己进行修改。

# 三，生成秘钥并上传工程 #

在上传项目时，我们必须先生成秘钥才能上传。

安装git，右键打开git bash输入生成秘钥命令：

gpg --gen-key

然后会提示要你输入姓名和邮箱地址：

![20200819101921806.png][]

输入完成，会弹出个窗口让你设置这个秘钥的密码并确认：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 3][]

自己设定一个密码并牢记，因为后面要用到这个密码的。

然后输入命令查询已经生成的秘钥：

gpg --list-keys

在pub字段下面有一个十六进制数，那就是这个秘钥的id。

![20200819102215922.png][]

然后我们要把这个秘钥上传至公钥服务器，需要上传到两个服务器，使用如下命令：

gpg --keyserver hkp://pool.sks-keyservers.net --send-keys 秘钥ID
    gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys 秘钥ID

秘钥ID就是我们刚刚gpg --list-keys命令查到的自己的秘钥的ID，复制过去即可。

然后验证是否成功地上传到了两个服务器：

gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 秘钥ID
    gpg --keyserver hkp://keyserver.ubuntu.com:11371 --recv-keys 秘钥ID

如果两条命令执行输出结果都如下说明成功：

![20200819102650391.png][]

这样，就完成了秘钥的配置了。

**需要说明的是，上述第一个公钥地址可能会出现上传不成功的情况（pool.sks-keyservers.net），即上传后再使用--recv-keys发现无数据。这时可以重复上传或者将上述地址改为下列镜像站：**

hkp://ha.pool.sks-keyservers.net
    hkp://p80.pool.sks-keyservers.net:80

将上述命令中的地址部分替换即可。

接下来，在我们的项目文件夹下打开git bash，输入上传项目命令：

mvn clean deploy

执行过程中会弹出一个窗口要求输入秘钥密码，就是输入我们先开始生成秘钥时设置的秘钥密码。

等待上传，最后显示绿色的Build Success说明上传成功。

# 四，去仓库发布项目到Maven中央仓库 #

上面的步骤只是把项目传到了sonatype上了，还没有发布出去。

进入[oss.sonatype.org][]，登录，点击旁边的Staging Repositories即可看到我们发布的项目。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 4][]

勾选项目，点击close，开始进行项目校验。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 5][]

我这里已经点过了，所以是灰色的。

再点击下面的active标签可以查看close的进度：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 6][] 显示All rules passed: Central Sync Requirement就说明校验通过，可以发布了。

再点击上面的release按钮即可发布到中央仓库了。

![20200819104230440.png][]

完成后，大约过个2个小时，你就可以在[search.maven.org][]找到你的发布的项目了！

# 五，以后再发布的时候 #

以后发布项目，如果groupId不变的话，我们就不需要再去申请工单了。直接重复上述的二、三、四步中的部分关键步骤即可，其中，settings.xml已经配置了servers，就不用再次配置了，即第二步配置settings.xml可以省略了。秘钥也已经生成过了，也不需要再次生成了， 即第三步的秘钥生成也不需要了。不过如果更换了电脑，那就要重新配置settings.xml并重新生成并上传秘钥了。

[issues.sonatype.org]: https://issues.sonatype.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70]: /images/20221124/8f43aa0c53c748938281ee944cc871a2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 1]: /images/20221124/6e7862bf30a941589cb0260d83b81bf8.png
[20200819095112271.png]: /images/20221124/008e0743599c432ab44be367f808198b.png
[https_gitee.com_swsk33_OSSRH-60021]: https://gitee.com/swsk33/OSSRH-60021
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 2]: /images/20221124/b062b6dbeaef40b6bf52454bcef87c3d.png
[20200819101921806.png]: /images/20221124/e3319c48dd844e6e88a4fa64453ad3ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 3]: /images/20221124/03915d7e996f424aa26e3bb2ef7b018f.png
[20200819102215922.png]: /images/20221124/3c91a876d8694b3f8ba5c0520a389a0b.png
[20200819102650391.png]: /images/20221124/e94473fb86d546afbd9dd3d711ce215a.png
[oss.sonatype.org]: https://oss.sonatype.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 4]: /images/20221124/ca1caa0b2a2f4dd483a2d84a8e92aaa4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 5]: /images/20221124/d150f64b841f427c8045bd15d65de167.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70 6]: /images/20221124/7d0384d304b5465ea352dc51285db8a0.png
[20200819104230440.png]: /images/20221124/fac0628dfe85426d9d9a41072b65a0e2.png
[search.maven.org]: https://search.maven.org/