Java 发布 Jar 到 maven中央仓库 邓维

Java 发布 Jar 到 maven中央仓库

1、简介

         Maven中央仓库并不支持直接发布jar包。我们需要将jar包发布到一些指定的第三方Maven仓库，然后该仓库再将jar包同步到Maven中央仓库。其中，最"简单"的方式是通过Sonatype OSSRH仓库来发布jar包。接下来，我会介绍如何将jar包发布到Sonatype OSSRH。

常用地址：

• 工单管理：https://issues.sonatype.org
• 构件仓库 : https://oss.sonatype.org/#welcome
• 仓库镜像： http://search.maven.org/ （把jar包上传到这里，Release 之后就会同步到maven中央仓库。）

2、 注册JIRA账号
JIRA是一个项目管理服务，类似于国内的Teambition（阿里团队协作工具）、TAPD（腾讯团队协作工具）。Sonatype通过JIRA来管理OSSRH仓库。
注册地址：https://issues.sonatype.org/secure/Signup!default.jspa

 3、创建发布jar的工单

点击 Create 创建一个Issue

1. Project: Community Support - Open Source Project Repository Hosting (OSSRH)
2. Issue TypeRequired: New Project
3. Summary: java-demo （自己项目名称）
4. Group Id：com.dw.study（maven项目坐标 Group Id）
5. Project URL：https://github.com/test/java-demo (项目地址)
6. SCM url：https://github.com/test/java-demo.git （源代码地址）

 其他内容可以按照自己实际情况填写，可以用默认值的地方，可以不用填写。当你提交后状态为等待工作人员审核，审核通过后状态会修改为 RESOLVED

审批通过后，通常管理员会给你留言配置方法，大体文字如下： 

Configuration has been prepared, now you can:
Deploy snapshot artifacts into repository https://oss.sonatype.org/content/repositories/snapshots
Deploy release artifacts into the staging repository https://oss.sonatype.org/service/local/staging/deploy/maven2
Promote staged artifacts into repository 'Releases'
Download snapshot and release artifacts from group https://oss.sonatype.org/content/groups/public
Download snapshot, release and staged artifacts from staging group https://oss.sonatype.org/content/groups/staging
please comment on this ticket when you promoted your first release, thanks

配置已经准备好了，现在你可以： 将快照构件部署到存储库https://oss.sonatype.org/content/repositories/snapshots将发布工件部署到分段存储库中https://oss.sonatype.org/service/local/staging/deploy/maven2 将分阶段的工件推入存储库“发布” 从组https://oss.sonatype.org/content/groups/public下载快照并发布工件 从暂存组https://oss.sonatype.org/content/groups/staging下载快照，发布和暂存的工件 请在您宣传第一个版本时对此票发表评论，谢谢

4、生成GPG密钥(默认RSA算法即非对称加解密公私钥对)

发布到Maven仓库中的所有文件都要使用GPG签名，以保障完整性。因此，我们需要在本地安装并配置GPG。

windows 可以到地址 https://www.gpg4win.org/download.html 下载 按照步骤安装即可。

 

因为我们只需要GnuPG，所以其它的可以不必勾选

4.1、使用git bash执行如下命令验证是否安装成功：

gpg --version

 4.2、使用gpg生成密钥对（注意以下命令需要在需要发布的项目路径下执行）

gpg --gen-key

 

 4.3、上传GPG公钥

目的：将公钥上传到公共的密钥服务器（也就是上传到第三方的key验证库）让其他人可以通过公钥来验证jar包的完整性

查看公钥

gpg --list-keys

 其中  FC294527EC31549C3CF5A98295FC26ED9EE5DCA7 为公钥ID。

将公钥或key发布到 PGP 密钥服务器（一次不成功，可多试几次）

gpg --keyserver hkp://pool.sks-keyservers.net --send-keys 公钥ID或上面提到的key
gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys 公钥ID或上面提到的key

查询公钥是否发布成功

gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 公钥ID或上面提到的key
gpg --keyserver hkp://keyserver.ubuntu.com:11371 --recv-keys 公钥ID或上面提到的key

修改密钥过期时间 

$ gpg --edit-key xxxxxxxxxxxxxxx
gpg> expire
# 将要变更主钥的使用期限。 0 = 密钥永不过期
密钥的有效期限是？(0) 0
# 密钥永远不会过期                
以上正确吗？(y/n) y
                        
gpg> key 1
          
gpg> expire
# 将要变更子钥的使用期限。密钥的有效期限是？(0) 0
# 密钥永远不会过期                
以上正确吗？(y/n) y
                        
gpg> save

5、修改Maven的settings.xml文件

id要与pom中snapshotRepository 的id一致 。username&password 配置是https://issues.sonatype.org/和https://oss.sonatype.org/网站的用户名和密码一般情况下默认是一致的。

<servers>
  <server>
      <id>oss</id>
      <username>Sonatype账号</username>
      <password>Sonatype密码</password>
  </server>
</servers>

6、配置项目 pom.xml 文件

可参考Sonatype提供的要求： https://central.sonatype.org/pages/requirements.html
Sonatype提供的pom文件demo：https://github.com/simpligility/ossrh-demo/blob/master/pom.xml
我的pom文件配置如下：

 <?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>io.gitee.dw-project</groupId>
    <artifactId>easy-webmvc</artifactId>
    <version>1.0.0</version>
    <name>easy-webmvc</name>
    <description>easy-webmvc</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <!-- 许可证信息 -->
    <licenses>
        <!-- Apache许可证 -->
        <license>
            <name>The Apache Software License, Version 2.0</name>
            <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
        </license>
    </licenses>
    <!-- SCM信息 -> git在github上托管 -->
    <scm>
        <connection>scm:git:gitee://gitee.com/dw-project/easy-webmvc</connection>
        <developerConnection>scm:git:ssh://gitee.com/dw-project/easy-webmvc.git</developerConnection>
        <url>https://gitee.com/dw-project/easy-webmvc</url>
    </scm>
    <!-- 开发者信息 -->
    <developers>
        <developer>
            <name>dengwei</name>
            <email>2546765805@qq.com</email>
            <url>https://github.com/dengwei</url>
        </developer>
    </developers>

    <dependencies>
      ....
    </dependencies>

    <profiles>
        <profile>
            <id>ossrh</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <!-- 要生成Javadoc和Source jar文件，您必须配置javadoc和源Maven插件 -->
                    <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.10.4</version>
                        <executions>
                            <execution>
                                <phase>package</phase>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                                <configuration>
                                    <additionalparam>-Xdoclint:none</additionalparam>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                    <!--  必须配置GPG插件用于使用以下配置对组件进行签名 -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-gpg-plugin</artifactId>
                        <version>1.6</version>
                        <executions>
                            <execution>
                                <id>sign-artifacts</id>
                                <phase>verify</phase>
                                <goals>
                                    <goal>sign</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
            <!-- 【注】snapshotRepository 与 repository 中的 id 一定要与 setting.xml 中 server 的 id 保持一致！ -->
            <distributionManagement>
                <snapshotRepository>
                    <id>oss</id>
                    <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
                </snapshotRepository>
                <repository>
                    <id>oss</id>
                    <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
                </repository>
            </distributionManagement>
        </profile>
    </profiles>
</project>

7、打包Deploy
       使用 mvn clean deploy -P <profile-id> 命令，一键打包。打包过程中会要求输入gpg密钥的Passphase信息，输入即可。

【友情提示】如果打包过程中出现了401类的错误，可能是因为Maven的配置文件中Server节点配置的用户名和密码不正确，或者 Issue 还未审核通过。

方法一： 命令

部署命令如下：

mvn clean deploy

当我们的项目中含有多个模块时，我们可以使用 -projects 来指定部署哪一个模块

举例：

1、部署一个模块如下： 【demo和demo2为模块名】

mvn clean deploy -projects demo

2、部署两个模块如下：

mvn clean deploy -projects demo,demo2

方法二： idea中

 【注】第一次执行时需要输入之前设置的passphrase密码 ~

上传问题：

如果出现上传问题，可以尝试将 https://oss.sonatype.org/#stagingRepositories 上之前上传的错误项目全部删除【选中点击Drop即可删除】，然后再次上传~

8、发布Release
使用JIRA账号登陆：https://s01.oss.sonatype.org，就可以看到你所发布的jar包了，点击左侧的Staging Repositories，可以使用Group Id或其他信息搜索自己的项目，
此时的构件状态为 Open，选中构件，并点击上方的 Close–>Confirm 在下边的Activity选项卡中查看状态。
当状态变成closed后，执行 Release–>Confirm 并在下边的Activity选项卡中查看状态。
成功后构件自动删除，一小段时间（约1-2个小时）后即可同步到maven的中央仓库。届时会有邮件通知。

 至此，发布到Maven中央仓库完成。

9、踩坑总结

1、deploy 发布不成功, 出现403。

1.   清除本地仓库中的信息后重试。
2.   检查版本号问题

2、在artifact能搜索到，但是构件没有出现在 Staging Repositories。

1. 如果发布的是快照版本 <version>1.0.0-SNAPSHOT</version> 或者 <version>1.0.0</version> 那么就搜不到。正常的应该是<version>1.0.0-RELEASE</version>
2. 或者使用maven插件 nexus-staging-maven-plugin 并且默认 autoReleaseAfterClose 是 true 导致的，直接越过了手工 close 的步骤。