将jar发布到maven中央仓库小记

dexcoder-assistant发布也经历几个版本了，很多人反映使用不太方便，需要将源码下来后本地编译安装一下，如果能直接使用就好了。

osc提供了第三方的maven库，但终究没有官方的maven库来得方便。

本文是将dexcoder-assistant发布到Maven中央库的记录。

注册一个 Sonatype 用户

注册地址：https://issues.sonatype.org/secure/Signup!default.jspa

使用了JIRA来管理流程，记住用户名和密码，后面会用到。

此外，Sonatype 还提供了一个名为 OSS 的系统，具体的构件发布是在这个oss系统上，

Sonatype OSS 地址：https://oss.sonatype.org

这里的用户名和密码就是上面在JIRA中注册的，在这里可以查询到全世界已发布的构件，当然我们发布构件的操作也在这里进行。

创建一个发布构件的 Issue

上面已经提到使用了JIRA来管理流程，提交发布构件申请的方式就是创建一个Issue。

点击Create按钮

会弹出一个层让你填写Issue的详细信息，把带*号的填一下，其它的默认就行。

这里最重要的就是Group Id，一般会带上域名，千万别弄错了，这关系到以后发布其它的构件。

我这里是com.dexcoder。

一般来说Sonatype是不会要求验证域名的，我是没有碰到，这可能也跟我发布的构件命名和包名及项目主页有dexcoder.com的链接有关。

等待 Issue 审核通过

这个审核还是很及时的，但是因为时间差的关系那边是晚上上班(按北京时间算)，因此需要等到第二天才能看到审核结果。

审核通过后会收到邮件通知(我收到的邮件被划到了垃圾箱内-.-)，同时在Issue下面会看到 Sonatype 工作人员的回复，一般是添加一个comment，内容大致如下：

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

使用 GPG 生成密钥对

Windows 系统，可以下载 Gpg4win 软件来生成密钥对。下载地址：https://www.gpg4win.org/download.html

推荐使用 Gpg4win-Vanilla 版本，因为它仅包括 GnuPG，这个工具才是我们所需要的。

Linux 系统，直接从源中安装gpg软件包就行。

安装 GPG 软件后，打开命令行窗口，依次做以下操作：

查看是否安装成功

  
  
  
  

   
   
   
   
gpg --version
  
  
  
  

出现版本等信息说明安装成功了。

生成密钥对

  
  
  
  

   
   
   
   
gpg --gen-key
  
  
  
  

会让你选择加密的方式：

lease select what kind

(1) RSA and RSA (default)

(2) DSA and Elgamal

(3) DSA (sign only)

(4) RSA (sign only)

这里选择默认的第一个。

之后往下，会让你输入用户名和邮箱，还有一个Passphase，相当于密钥库密码，不要忘记。

查看公钥

  
  
  
  

   
   
   
   
gpg --list-keys
  
  
  
  

输出如下：

  
  
  
  

   
   
   
   
C:\Users\liyd>gpg --list-keys
   
   
   
   
C:/Users/liyd/AppData/Roaming/gnupg/pubring.gpg
   
   
   
   
-----------------------------------------------
   
   
   
   
pub 2048R/48981BD3 2015-12-23
   
   
   
   
uid [ultimate] selfly <selfly@foxmail.com>
   
   
   
   
sub 2048R/F2CBBD66 2015-12-23
  
  
  
  

我这里的公钥ID是48981BD3，马上就会用到了。

将公钥发布到 PGP 密钥服务器

C:\Users\liyd>gpg --keyserver hkp://pool.sks-keyservers.net --send-keys 48981BD3

gpg: sending key 48981BD3 to hkp server pool.sks-keyservers.net

此后，可使用本地的私钥来对上传构件进行数字签名，而下载该构件的用户可通过上传的公钥来验证签名，也就是说，大家可以验证这个构件是否由本人上传的，因为有可能该构件被坏人给篡改了。

查询公钥是否发布成功

  
  
  
  

   
   
   
   
C:\Users\liyd>gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 48981BD3
   
   
   
   
gpg: requesting key 48981BD3 from hkp server pool.sks-keyservers.net
   
   
   
   
gpg: key 48981BD3: "selfly <[email protected]>" not changed
   
   
   
   
gpg: Total number processed: 1
   
   
   
   
gpg: unchanged: 1
  
  
  
  

修改Maven配置文件

需要修改全局的setting.xml和项目的pom.xml文件。

setting.xml

找到maven的全局配置文件settings.xml，在里面找到 节点，这个节点默认是注释掉的，增加如下配置：

  
  
  
  

   
   
   
   
<servers>
   
   
   
   
 <server>
   
   
   
   
 <id>oss</id>
   
   
   
   
 <username>用户名</username>
   
   
   
   
 <password>密码</password>
   
   
   
   
 </server>
   
   
   
   
</servers>
  
  
  
  

这里的id是要在pom.xml里面使用的，用户名和密码就是在Sonatype上面注册的用户名和密码。

pom.xml

  
  
  
  

   
   
   
   
<project>
   
   
   
   
...
   
   
   
   
 <name>dexcoder-assistant</name>
   
   
   
   
 <description>dexcoder-assistant is a rapid development kit.</description>
   
   
   
   
 <url>http://www.dexcoder.com/</url>
   
   
   
   
 <licenses>
   
   
   
   
 <license>
   
   
   
   
 <name>The Apache Software License, Version 2.0</name>
   
   
   
   
 <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
   
   
   
   
 </license>
   
   
   
   
 </licenses>
   
   
   
   
 <developers>
   
   
   
   
 <developer>
   
   
   
   
 <name>selfly</name>
   
   
   
   
 <email>[email protected]</email>
   
   
   
   
 </developer>
   
   
   
   
 </developers>
   
   
   
   
 <scm>
   
   
   
   
 <connection>scm:git:[email protected]:selfly/dexcoder-assistant.git</connection>
   
   
   
   
 <developerConnection>scm:git:[email protected]:selfly/dexcoder-assistant.git</developerConnection>
   
   
   
   
 <url>[email protected]:selfly/dexcoder-assistant.git</url>
   
   
   
   
 </scm>
   
   
   
   
...
   
   
   
   
 <profiles>
   
   
   
   
 <profile>
   
   
   
   
 <id>release</id>
   
   
   
   
 <build>
   
   
   
   
 <plugins>
   
   
   
   
 <!-- Source -->
   
   
   
   
 <plugin>
   
   
   
   
 <groupId>org.apache.maven.plugins</groupId>
   
   
   
   
 <artifactId>maven-source-plugin</artifactId>
   
   
   
   
 <version>2.2.1</version>
   
   
   
   
 <executions>
   
   
   
   
 <execution>
   
   
   
   
 <phase>package</phase>
   
   
   
   
 <goals>
   
   
   
   
 <goal>jar-no-fork</goal>
   
   
   
   
 </goals>
   
   
   
   
 </execution>
   
   
   
   
 </executions>
   
   
   
   
 </plugin>
   
   
   
   
 <!-- Javadoc -->
   
   
   
   
 <plugin>
   
   
   
   
 <groupId>org.apache.maven.plugins</groupId>
   
   
   
   
 <artifactId>maven-javadoc-plugin</artifactId>
   
   
   
   
 <version>2.9.1</version>
   
   
   
   
 <executions>
   
   
   
   
 <execution>
   
   
   
   
 <phase>package</phase>
   
   
   
   
 <goals>
   
   
   
   
 <goal>jar</goal>
   
   
   
   
 </goals>
   
   
   
   
 </execution>
   
   
   
   
 </executions>
   
   
   
   
 </plugin>
   
   
   
   
 <!-- GPG -->
   
   
   
   
 <plugin>
   
   
   
   
 <groupId>org.apache.maven.plugins</groupId>
   
   
   
   
 <artifactId>maven-gpg-plugin</artifactId>
   
   
   
   
 <version>1.5</version>
   
   
   
   
 <executions>
   
   
   
   
 <execution>
   
   
   
   
 <phase>verify</phase>
   
   
   
   
 <goals>
   
   
   
   
 <goal>sign</goal>
   
   
   
   
 </goals>
   
   
   
   
 </execution>
   
   
   
   
 </executions>
   
   
   
   
 </plugin>
   
   
   
   
 </plugins>
   
   
   
   
 </build>
   
   
   
   
 <distributionManagement>
   
   
   
   
 <snapshotRepository>
   
   
   
   
 <id>oss</id>
   
   
   
   
 <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
   
   
   
   
 </snapshotRepository>
   
   
   
   
 <repository>
   
   
   
   
 <id>oss</id>
   
   
   
   
 <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
   
   
   
   
 </repository>
   
   
   
   
 </distributionManagement>
   
   
   
   
 </profile>
   
   
   
   
 </profiles>
   
   
   
   
...
   
   
   
   
</project>
  
  
  
  

pom.xml中必须包括：name、description、url、licenses、developers、scm 等基本信息，使用了 Maven 的 profile 功能，只有在 release 的时候，创建源码包、文档包、使用 GPG 进行数字签名。

此外，snapshotRepository 与 repository 中的 id 一定要与 setting.xml 中 server 的 id 保持一致。

如果是多模块项目的话，只需要在父pom.xml中声明这些，子pom.xml中只需要修改相应的一些信息，如name标签。

上传构件到 OSS 中

  
  
  
  

   
   
   
   
mvn clean deploy -P release
  
  
  
  

当执行以上 Maven 命令时，会自动弹出一个对话框，需要输入上面提到的 Passphase，它就是刚才设置的 GPG 密钥库的密码。

随后会看到大量的 upload 信息，因为在国内网络的缘故，时间有点久，耐心等待吧。

注意：此时上传的构件并未正式发布到中央仓库中，只是部署到 OSS 中了，下面才是真正的发布。

在 OSS 中发布构件

在 OSS 中，使用自己的 Sonatype 账号登录后，可在 Staging Repositories 中查看刚才已上传的构件，这些构件目前是放在 Staging 仓库中，可进行模糊查询，快速定位到自己的构件。

此时，该构件的状态为 Open，需要勾选它，然后点击 Close 按钮。系统会自动验证该构件是否满足指定要求，当验证完毕后，状态会变为 Closed。

最后，点击 Release 按钮来发布该构件，这一步没有截图，将就看吧知道就行：

这里页面可能要刷新一下才能看到新的状态。

通知 Sonatype 构件已成功发布

这个前面的Sonatype工作人员其实在审核你的Issue时，在comment中已经提示你了，

在Issue下面回复一条“构件已成功发布”的评论，这是为了通知 Sonatype 的工作人员为需要发布的构件做审批，发布后会关闭该Issue。

等待构件审批通过

这个，又只能等待了，当然他们晚上上班，还是第二天看。当审批通过后，将会收到邮件通知。

从中央仓库中搜索构件

这时，就可以在maven的中央仓库中搜索到自己发布的构件了，以后可以直接在pom.xml中使用了！

中央仓库搜索网站：http://search.maven.org/

第一次成功发布之后，以后就不用这么麻烦了，可以直接使用Group Id发布任何的构件，当然前提是Group Id没有变。

以后的发布流程：

a）构件完成后直接使用maven在命令行上传构建；

b）在https://oss.sonatype.org/ close并release构件；

c)等待同步好（大约2小时多）之后，就可以使用了