记上传jar包到MavenRepository中央库的流程以及踩坑历程

2020-11-23

字数统计: 1.6k字 | 阅读时长≈ 7分

前置准备

首先你得将代码上传至github，其次包的命名也是有规范的，如果你没有自己的域名，那么你的group id需要使用github的包路径，如：io.github.你的github用户名

如果拥有自己的域名，那么可以使用域名倒叙作为group id，如：域名为：mysite.blogs.com，那么group id开头即: com.blogs.mysite。

使用自己的域名需要配置dns，具体做法创建工单后工作人员会提示。

第一步，新建工单

要上传jar库到maven中央库首先得注册他们的工单系统账号：https://issues.sonatype.org/ 。

关于注册： 这里重点注意下密码的坑，不要使用xml中必须要转义的特殊字符作为密码，如’&’ ，否则上传时老是验证失败！

登陆成功后点新建，项目类型选 -> Community Support - Open Source Project Repository Hosting ，问题类型->new project，接着将必填项填上：

1
2
3

Group Id:io.github.yourgithubId    #也可以使用自己的域名
Project URL:https://github.com/user/projectName    #代码的url路径
SCM url:https://github.com/user/projectName.git    #git代码ssh地址

工单创建完毕后等待我们的Orlina小姐姐处理，由于时差关系所以一般是晚上才有动静，所以趁这个时间将代码上的准备工作解决。

第二步，签名密钥

maven central要求我们的jar必须密钥签名，因此需要下载gpg4win，下载地址：https://www.gpg4win.org/download.html 注意安装时其中有个可选项Kleopatra要勾上，这个是图形化操作界面

安装完毕后打开Kleopatra，点击文件 -> 新建密钥对 -> OpenGPG密钥，密钥信息随便填关键是最后一步输入密码，这个密码要记住待会要用到。

密钥创建完后回到Kleopatra操作页面，右键生成好的密钥，点 ‘在服务器上发布’ ！我在上传过程中就是因为忘记点发布结果老是GPG密钥验证失败！

第三步，本地maven配置

在maven的settings.xml中servers标签下添加：

<server>
  <id>snapshots</id>
  <username>sonatype账号</username>
  <password>密码</password>   
</server>
<server>
  <id>release</id>
  <username>sonatype账号</username>
  <password>密码</password>
</server>

pom.xml开源信息配置

首先在pom.xml project标签下添加如下信息：

<!-- 替换成自己的地址 -->
<scm> 
  <connection>
     scm:git:https://github.com/reinershir/projectName.git
  </connection>
  <developerConnection>
     scm:git:https://github.com/reinershir/projectName.git
  </developerConnection>
  <url>https://github.com/reinershir/projectName</url>
 <tag>0.0.1</tag>
</scm>
    
<developers>
<developer>
  <name>reiner</name>
  <email>[email protected]</email>
  <organization>person</organization>
  <organizationUrl>https://github.com/reinershir</organizationUrl>
</developer>
</developers>

<licenses>
<license>
  <name>MIT License</name>
  <url>https://opensource.org/licenses/MIT</url>
  <distribution>repo</distribution>
</license>
</licenses>

<distributionManagement>
  <repository>
    <id>release</id>
    <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
  </repository>
  <snapshotRepository>
<!-- 这里要对应settings.xml server的ID -->
    <id>snapshots</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>

pom.xml插件配置

要上传jar包除了需要用GPG密钥插件外还需要生成javadoc，添加如下插件配置：

<plugins>
        
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.0</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
    </configuration>
</plugin>
<!-- 源码打包插件 -->
<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>
<!-- java doc生成插件 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<executions>
  <execution>
    <id>attach-javadocs</id>
    <goals>
      <goal>jar</goal>
    </goals>
    <configuration> 
        <!-- 跳过javadoc的严格检查 -->
        <additionalOptions>-Xdoclint:none</additionalOptions>
    </configuration>
  </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>

上面的配置已经将javadoc的坑填好，如果你的注释完全遵守w3c标准，那么是可以将javadoc插件的<additionalOptions>-Xdoclint:none</additionalOptions>去掉，但是我想一般没有人会这么严格的写注释吧？

如果不加additionalOptions>-Xdoclint:none</additionalOptions>配置那么javadoc是会生成失败的，因为你的注释不规范

第四步，上传jar包、收功

当 sonatype的工作人员 ossrhCentral OSSRH 告诉你，你的group id已激活中央库，此时可以尝试上传jar包了，登陆：https://oss.sonatype.org 上去看看，是否登陆正常。

接下来在你的maven项目中运行：mvn clean deploy -X -Darguments="gpg.passphrase=你的GPG密钥密码" ，如果一切正常，控制台打印SUCCESS，此时可以进入oss.sonatype.org，

点击Staging Repositories，refresh一下，看看是不是有一行repository数据。

看看上传的jar包有没有报错，它会检查你的GPG密钥、文档、group id、开源协议等，如果一切OK

点击close，表示jar包上传完毕，close后刷新页面点击release，10多分钟后你的jar包就可以直接从中央库下载了

~~想当时就是因为没有点release结果弄半天都无法从中央库下载~~

如果上传失败，是可以drop掉该数据重新上传的 *

好了，大功告成~！

~~坑爹的hexo一个语法错误就把我这偏文章直接从本地给删了！还好有浏览器缓存，只能用html标签的内容了~~

本文作者： reiner
本文链接： https://reiner.host/posts/26a3b465.html
版权声明： 转载请注明出处，并附上原文链接