如何发布 Jar 包到 Maven 中央仓库

发表于 2019-06-17 本文字数： 6.3k 阅读时长 ≈ 6 分钟

本文将介绍如何把自己开发出来的 jar 包发布到 Maven 中央仓库，以便将好用的工具共享给其他需要的人.

第一步注册 jira 账号，将 jira 账号名密码配置到 maven 的 settings.xml 文件中

JIRA 注册地址

修改 mavan 配置文件 settings.xml ，加入以下配置

<servers>
   <server>
     <id>sonatype-nexus-snapshots</id>
     <username>刚才注册的账号</username>
     <password>刚才注册的密码</password>
   </server>
   <server>
     <id>sonatype-nexus-staging</id>
     <username>刚才注册的账号</username>
     <password>刚才注册的密码</password>
   </server>
 </servers>

构件第一次发布需要创建 ISSUE，可以参考我之前创建的 ISSUE

弹出页面：
1560743214766

需要填写如下几项：

Project：Community Support - Open Source Project Repository Hosting
Issue Type：New Project
Summary：JAR包名称，如：code-generator
Group Id：例如：com.github.zhuyizhuo
Project URL：项目站点，如：https://github.com/zhuyizhuo/code-generator
SCM url：项目源码仓库，如：https://github.com/zhuyizhuo/code-generator.git

提示：

group Id 如果自己有个人网址，可填写为自己的网址，如果代码托管在 git ，则填写 com.github.xxx
填写个人网址的话，Sonatype 的工作人员会询问你那个 Group Id 是不是你的域名，你只需要在上面回答是就行，然后就会通过审核。

其他内容不用填写，创建 Issue 后需要等待工作人员审核处理，一般一个工作日以内，审批通过后会发邮件通知，当 Issue 的 Status 变为RESOLVED 后，就可以进行下一步操作了，此外，在自己提交的 Issue 下面会看到 Sonatype 工作人员的回复：

1560758351233

如图，工作人员提示在第一次发布构件后需要提交一下评论，

此处工作人员回复了项目分发位置即 pom.xml 中需要配置的信息

第二步配置需要发布项目的 `pom.xml` 文件加入如下配置：（对应路径改为自己项目路径）

<!-- Sonatype 官方的一个通用配置 oss-parent 无需更改 -->
<parent>
        <groupId>org.sonatype.oss</groupId>
        <artifactId>oss-parent</artifactId>
        <version>7</version>
</parent>
<!-- 许可证 可根据需要修改 -->
<licenses>
    <license>
        <name>Apache 2</name>
        <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
        <distribution>repo</distribution>
        <comments>A business-friendly OSS license</comments>
    </license>
</licenses>
<!-- 项目分发信息，在执行 mvn deploy 后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。-->
<distributionManagement>
    <snapshotRepository>
        <!-- 这个 id 与第一步 setting.xml 中设置的对应 -->
        <id>sonatype-nexus-snapshots</id>
        <name>OSS Snapshots Repository</name>
        <!-- 这里的 url 就是 Issue 中回复的 snapshots 的 repository 地址-->
        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </snapshotRepository>
    <repository>
        <!-- 这个 id 与第一步 setting.xml 中设置的对应 -->
        <id>sonatype-nexus-staging</id>
        <name>OSS Staging Repository</name>
        <!-- 这里的 url 就是 Issue 中回复的 staging 的 repository 地址-->
        <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
</distributionManagement>
<!-- 问题管理 -->
<issueManagement>
    <system>github</system>
    <url>https://github.com/zhuyizhuo/code-generator/issues</url>
</issueManagement>
<!-- SCM(Source Control Management)标签允许你配置你的代码库，供 Maven web 站点和其它插件使用。 -->
<scm>
    <url>https://github.com/zhuyizhuo/code-generator</url>
    <connection>https://github.com/zhuyizhuo/code-generator.git</connection>
</scm>
<!-- 项目开发者列表 -->
<developers>
    <developer>
        <name>ZhuYiZhuo</name>
        <id>ZhuYiZhuo</id>
        <email>zhu.yizhuo@163.com</email>
        <roles>
            <role>Developer</role>
        </roles>
        <timezone>+8</timezone>
    </developer>
</developers>

第三步安装 GPG 并生成秘钥，发布构件到仓库时需要用到

GPG Windows 客户端下载地址 | GPG Mac OS 客户端下载地址

安装 GPG 完毕，打开 CMD 窗口执行命令 gpg --gen-key 按提示输入个人信息，最终输出如下图：

提示： passphrase 需要记住，这个相当于是是密钥的密码，第四步 发布过程中进行签名操作的时候会用到

C:\Windows\system32>gpg --gen-key
gpg (GnuPG) 2.2.15; Copyright (C) 2019 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Note: Use "gpg --full-generate-key" for a full featured key generation dialog.

GnuPG needs to construct a user ID to identify your key.

Real name: zhuyizhuo
Email address: zhu.yizhuo@163.com
You selected this USER-ID:
    "zhuyizhuo <zhu.yizhuo@163.com>"

Change (N)ame, (E)mail, or (O)kay/(Q)uit? O
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
gpg: key 33111BCFE53BEE51 marked as ultimately trusted
gpg: directory 'C:/Users/zhuo/AppData/Roaming/gnupg/openpgp-revocs.d' created
gpg: revocation certificate stored as 'C:/Users/zhuo/AppData/Roaming/gnupg/openpgp-revocs.d\9E2FB80F2047C634965B5F2C33111BCFE53BEE51.rev'
public and secret key created and signed.

pub   rsa2048 2019-06-06 [SC] [expires: 2021-06-05]
      9E2FB80F2047C634965B5F2C33111BCFE53BEE51
uid                zhuyizhuo <zhu.yizhuo@163.com>
sub   rsa2048 2019-06-06 [E] [expires: 2021-06-05]

C:\Windows\system32>

1560760395431

上传公钥到服务器，用来发布 jar 的时候进行签名验证，执行命令：
gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys [密钥]

执行结果如下：

1
2
3

C:\Windows\system32>gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys 9E2FB80F2047C634965B5F2C33111BCFE53BEE51

gpg: sending key 9E2FB80F2047C634965B5F2C33111BCFE53BEE51 to hkp server keyserver.ubuntu.com

(此步骤为建议配置，并非必须，方便忘记 passphrase 后查看)

将 passphrase 配置到 maven 的 setting.xml 文件中标签中

<profiles>
    <profile>
        <id>sonatype-oss-release</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <!-- 此处根据GPG版本填写，<2.0的填写GPG，2.0以上的填写gpg2 -->
            <gpg.executable>gpg</gpg.executable> 
            <gpg.passphrase>你的 Passphase 密码</gpg.passphrase>
        </properties>
    </profile>
</profiles>