2020-12-01 mac使用Maven将jar包发布到中心仓库

我不是女神ヾ 2022-12-25 07:57 79阅读 0赞

能够将完成的jar包作品发布到中心仓库是一件非常酷的事情。

这篇文章简要记述了博主自己动手发布jar包到Maven中心仓库的过程。

环境：macOS 10.15.7 (19H2)  
Maven版本：3.6.1  
我的测试github项目：[mine-spring手写Spring实现][mine-spring_Spring]

--------------------

1.  **注册JIRA账号**  
    [https://issues.sonatype.org][https_issues.sonatype.org]

--------------------

1.  **创建一个新的issue**  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70]  
    新建之后会有人负责给你处理。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 1]
    
    如果使用第三方域名，需要在服务器的dns解析器下添加一个TXT记录值进行验证：
    
    ![在这里插入图片描述][20201201130422824.png]
    
    使用如下指令查看TXT配置情况
    
        nslookup -q=txt ossrh-xxxxx.domain.com
    
    添加完成后，在下面回复：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 2]  
    然后管理员会回复你，让你在提交了第一个release后回复他  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 3]

--------------------

1.  **接下来安装并且配置gpg**
    
        brew install gpg
    
    创建一个秘钥
    
        gpg --generate-key
    
    根据提示创建即可，期间会让你设置一个**passphrase**，也就是你的秘钥密码，这个要自己记好
    
    创建完成后，会输入如下内容给你，其中有pub的字符串就是公钥，这里我打码了：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 4]
    
    接下来向服务器上传这个公钥
    
        gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys <你的pub字符串>
    
    注意必须要带端口号，不是http是hkp  
    上传完成后，使用如下内容查看
    
        gpg --keyserver hkp://keyserver.ubuntu.com:11371 --recv-keys <你的pub字符串>
    
    查看是否有回复：  
    ![在这里插入图片描述][20201201131653310.png]

--------------------

1.  **配置Maven**
    
    找到你使用的Maven路径，一般是~/.m2  
    打开里面的setting.xml，如果没有就自己创建一个，内容如下：
    
        <?xml version="1.0" encoding="UTF-8"?>
        <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
        
          <servers>
        	  <server>
        	    <id>ossrh</id>
        	    <username>注册JIRA用户名</username>
        	    <password>注册JIRA密码</password>
        	  </server>
        	</servers>
        
          <profiles>
            <profile>
              <activation>
                <activeByDefault>true</activeByDefault>
              </activation>
              <properties>
              	
                <gpg.executable>/usr/local/Cellar/gnupg/2.2.23/bin/gpg</gpg.executable>
                <gpg.passphrase>创建秘钥时的passphrase</gpg.passphrase>
              </properties>
            </profile>
          </profiles>
        </settings>
    
    可以直接照搬上面我的配置，亲测可以用，替换到自己的内容。

--------------------

1.  **配置项目的pom.xml**
    
    在你要发布的项目的pom.xml文件中添加如下内容，scm、license、developer改成你自己的内容
    
    这些插件的兼容性我都测试了，可以正常运行，具体内容自己改下即可
    
        <build>
            <finalName>${project.artifactId}-${project.version}</finalName>
            <plugins>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-jar-plugin</artifactId>
                    <version>3.0.2</version>
                    <configuration>
                        <archive>
                            <addMavenDescriptor>false</addMavenDescriptor>
                            <manifestEntries>
                            	
                                <Built-By>你的作者名字</Built-By>
                            </manifestEntries>
                        </archive>
                    </configuration>
                </plugin>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-source-plugin</artifactId>
                    <version>3.0.0</version>
                    <configuration>
                        <attach>true</attach>
                    </configuration>
                    <executions>
                        <execution>
                            <phase>compile</phase>
                            <goals>
                                <goal>jar</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-javadoc-plugin</artifactId>
                    <version>2.10.2</version>
                    <configuration>
                        <aggregate>true</aggregate>
                        <additionalparam>-Xdoclint:none</additionalparam>
                        <additionalJOption>-Xdoclint:none</additionalJOption>
                    </configuration>
                    <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.6</version>
                    <executions>
                        <execution>
                            <phase>verify</phase>
                            <goals>
                                <goal>sign</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                
                <plugin>
                    <groupId>org.sonatype.plugins</groupId>
                    <artifactId>nexus-staging-maven-plugin</artifactId>
                    <version>1.6.8</version>
                    <extensions>true</extensions>
                    <configuration>
                        <serverId>ossrh</serverId>
                        <nexusUrl>https://oss.sonatype.org/</nexusUrl>
                        <autoReleaseAfterClose>false</autoReleaseAfterClose>
                    </configuration>
                </plugin>
            </plugins>
        </build>
        
        <licenses>
        	<license>
                <name>The Apache Software License, Version 2.0</name>
                <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
                <distribution>actable</distribution>
            </license>
            
        	
            
        </licenses>
        <developers>
            <developer>
                <name>dzzhyk</name>
                <email>dzzhyk@qq.com</email>
                <organization>yankaizhang.com</organization>
            </developer>
        </developers>
        <scm>
            <tag>master</tag>
            <connection>https://github.com/dzzhyk/mine-spring</connection>
            <developerConnection>https://github.com/dzzhyk/</developerConnection>
            <url>https://github.com/dzzhyk/mine-spring/tree/${project.scm.tag}</url>
        </scm>
        
        
        <distributionManagement>
            <snapshotRepository>
                <id>ossrh</id>
                <url>https://oss.sonatype.org/content/repositories/snapshots</url>
            </snapshotRepository>
            <repository>
                <id>ossrh</id>
                <name>Nexus Release Repository</name>
                <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
            </repository>
        </distributionManagement>

--------------------

1.  **尝试发布jar包**
    
    在直接deploy之间最好先用package测试一下，target里面应该可以正常生成3个jar包，分别是代码、源码、javadoc
    
    **这里大概率会报错如下：**
    
        maven-gpg-plugin:1.6 xxxx Exited Code 2
    
    此时去~/.gnupg目录下新建两个文件，内容如下：
    
    gpg.conf
    
        use-agent
        pinentry-mode loopback
    
    gpg-agent.conf
    
        allow-loopback-pinentry
    
    保存即可解决。
    
    检查pom.xml文件是否填写完整，有几个标签比如name、description、url也需要加上
    
    另外最好确保连接中央仓库的网络畅通
    
    执行如下命令进行部署：
    
        mvn clean deploy
    
    如果部署成功，去你的issue页面给管理员回复：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 5]

--------------------

1.  **进入缓存管理，确认并release**
    
    此时管理员会回复如下：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 6]  
    他为这个release创建了一个cache缓存，你需要进入下面的网址查看这个stage
    
    [https://oss.sonatype.org/\#stagingRepositories][https_oss.sonatype.org_stagingRepositories]
    
    登录账号就是JINA的用户名和密码
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 7]  
    如果你发布成功，应该会显示出一个新的stage，选中这个stage，点击Close，尝试关闭它
    
    在关闭的过程中，会检查你的release是否合格，是否有文件缺失等等，如果合格，就可以点击上面的Release按钮进行发布了。
    
    发布之后，这个暂存的stage就会被删除，取而代之的是你可以在Release仓库中找到你的jar包了  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 8]  
    等待10Min左右，就可以在release中找到
    
    此时管理员会回复：
    
    ![在这里插入图片描述][20201201133507914.png]  
    2小时左右，你的jar包就会被同步到中央仓库了。

等待许久之后，新建一个Maven项目，把本地~/.m2/repository中的你的jar包删除，然后重新用坐标导入，从中心仓库下载，应该就可以下载到了：

<dependency>
        <groupId>com.yankaizhang</groupId>
        <artifactId>mine-spring</artifactId>
        <version>0.0.2</version>
    </dependency>

--------------------

**注意：**

*  阿里云等镜像仓库可以找不到你的jar包，需要时间同步
 *  秘钥最好妥善保管
 *  如果发布失败就检查网络、pom.xml是否信息完整，settings.xml配对了没有，标签有没有闭合等等。。
 *  如果gpg插件报错，查看第六步的解决方法

祝大家发布顺利！

[mine-spring_Spring]: https://github.com/dzzhyk/mine-spring
[https_issues.sonatype.org]: https://issues.sonatype.org
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70]: /images/20221120/cc105299935f4e10b76a6c392c9e2e07.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201201130230421.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[20201201130422824.png]: https://img-blog.csdnimg.cn/20201201130422824.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201201130906557.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201201131001881.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201201131327647.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[20201201131653310.png]: https://img-blog.csdnimg.cn/20201201131653310.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20201201132843605.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20201201132916459.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[https_oss.sonatype.org_stagingRepositories]: https://oss.sonatype.org/#stagingRepositories
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/202012011331377.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20201201133427700.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyNjI0Mg==,size_16,color_FFFFFF,t_70
[20201201133507914.png]: https://img-blog.csdnimg.cn/20201201133507914.png