详解如何将JAR包发布到Maven中央仓库

 更新时间:2019年01月14日 14:42:01   转载 作者:Fundebug  
这篇文章主要介绍了详解如何将JAR包发布到Maven中央仓库,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

将jar包发布到Maven中央仓库(Maven Central Repository),这样所有的Java开发者都可以使用Maven直接导入依赖,例如fundebug-java

<!-- https://mvnrepository.com/artifact/com.fundebug/fundebug-java -->
<dependency>
  <groupId>com.fundebug</groupId>
  <artifactId>fundebug-java</artifactId>
  <version>0.2.0</version>
</dependency>

但是,Maven中央仓库并不支持直接发布jar包。我们需要将jar包发布到一些指定的第三方Maven仓库,然后该仓库再将jar包同步到Maven中央仓库。

其中,最"简单"的方式是通过Sonatype OSSRH仓库来发布jar包。接下来,我会介绍如何将jar包发布到Sonatype OSSRH。

本教程所使用的系统配置如下:

  • OS:macOS 10.14.2
  • JDK:1.8.0_192
  • Maven:3.5.4

1. 注册JIRA账号

JIRA是一个项目管理服务,类似于国内的Teambition。Sonatype通过JIRA来管理OSSRH仓库。

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

需要填写Email, Full Name, Username以及password,其中Username与Password后面的步骤需要用到,请记下来。

2. 创建issue

通过在JIRA上创建issue来申请发布新的jar包,Sonatype的工作人员会进行审核,审核不算严格,一般按照要求填写不会有问题。

创建链接:https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

创建issue的时候需要填写下面这些信息:

  • Summary
  • Description
  • Group Id
  • Project URL
  • SCM url

大家可以参考我申请发布fundebug-javafundebug-spring时所填写的内容:OSSRH-45238

由于时差,前一天创建issue,第二天早上才会有回应。当issue的status变为RESOLVED,我们就可以进行下一步操作了。

3. 安装并配置GPG

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

安装GPG

MacBook安装GPG非常简单,下载并安装GPG Suite即可。

生成GPG密钥对

gpg --gen-key

生成密钥时将需要输入name、email以及password。password在之后的步骤需要用到,请记下来。

上传GPG公钥

将公钥上传到公共的密钥服务器,这样其他人才可以通过公钥来验证jar包的完整性。

gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys CAB4165C69B699D989D2A62BD74A11D3F9F41243

其中CAB4165C69B699D989D2A62BD74A11D3F9F41243为密钥的ID,可以通过gpg --list-keys命令查看

gpg --list-keys

/Users/kiwenlau/.gnupg/pubring.kbx
----------------------------------
pub  dsa2048 2010-08-19 [SC] [expires: 2020-06-15]
   85E38F69046B44C1EC9FB07B76D78F0500D026C4
uid      [ unknown] GPGTools Team <team@gpgtools.org>
sub  elg2048 2010-08-19 [E] [expires: 2020-06-15]
sub  rsa4096 2014-04-08 [S] [expires: 2024-01-02]

pub  rsa2048 2019-01-03 [SC] [expires: 2021-01-02]
   CAB4165C69B699D989D2A62BD74A11D3F9F41243
uid      [ultimate] kiwenlau <kiwenlau@gmail.com>
sub  rsa2048 2019-01-03 [E] [expires: 2021-01-02]

4. 配置Maven的setting.xml

[setting.xml]()为Maven的全局配置文件,在MacBook上的位置为/usr/local/Cellar/maven/3.5.4/libexec/conf/settings.xml,我们需要将第1步配置的Username和Password添加到<servers></servers>标签中,这样我们才能将jar包部署到Sonatype OSSRH仓库:

<servers>
    <server>
        <id>ossrh</id>
        <username>Fundebug</username>
        <password>passsword</password>
    </server>
</servers>

5. 配置项目的pom.xml

pom.xml挺长的。根据Sonatype OSSRH的要求,以下信息都必须配置:

  • Supply Javadoc and Sources
  • Sign Files with GPG/PGP
  • Sufficient Metadata
    • Correct Coordinates
    • Project Name, Description and URL
    • License Information
    • Developer Information
    • SCM Information

配置时参考我的pom.xml,根据需要修改即可。

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.fundebug</groupId>
  <artifactId>fundebug-java-notifier</artifactId>
  <version>0.2.0</version>
  <packaging>pom</packaging>
  <name>fundebug-java-notifier</name>
  <url>https://github.com/Fundebug/fundebug-java-notifier</url>
  <description>Capture Java and Spring exceptions automatically</description>
  <licenses>
    <license>
      <name>Server Side Public License</name>
      <url>https://www.mongodb.com/licensing/server-side-public-license</url>
      <distribution>repo</distribution>
      <comments>A not business-friendly OSS license</comments>
    </license>
  </licenses>
  <scm>
    <url>https://github.com/Fundebug/fundebug-java-notifier</url>
    <connection>https://github.com/Fundebug/fundebug-java-notifier.git</connection>
  </scm>
  <properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <maven.deploy.skip>true</maven.deploy.skip>
  </properties>
  <developers>
    <developer>
      <name>kiwenlau</name>
      <id>kiwenlau</id>
      <email>kiwenlau@gmail.com</email>
      <roles>
        <role>Developer</role>
      </roles>
      <timezone>+8</timezone>
    </developer>
  </developers>
  <profiles>
    <profile>
      <id>default</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <build>
        <plugins>
          <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>
          <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>
          <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>
        </plugins>
      </build>
      <distributionManagement>
        <snapshotRepository>
          <id>ossrh</id>
          <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        </snapshotRepository>
        <repository>
          <id>ossrh</id>
          <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
        </repository>
      </distributionManagement>
    </profile>
  </profiles>
  <modules>
    <module>fundebug-java</module>
    <module>fundebug-spring</module>
    <module>examples/hello-world</module>
    <module>examples/spring-rest-api</module>
  </modules>
</project>

6. 发布jar包

执行mvn clean deploy处理,即可将jar包发布到Sonatype OSSRH仓库。

mvn clean deploy -projects fundebug-java,fundebug-spring

我们的项目fundebug-java-notifier含有多个模块,仅需部署fundebug-java与fundebug-spring,因此使用-projects选项来指定。

第一次执行mvn clean deploy命令时,需要输入GPG密钥的密码。

mvn clean deploy命令执行成功的输出是这样的(部分日志):

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] fundebug-java 0.2.0 ................................ SUCCESS [ 22.183 s]
[INFO] fundebug-spring 0.2.0 .............................. SUCCESS [ 16.383 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 38.728 s
[INFO] Finished at: 2019-01-12T20:10:16+08:00
[INFO] ------------------------------------------------------------------------

7. close并release

mvn clean deploy命令执行成功,使用JIRA账号登陆:https://oss.sonatype.org/#stagingRepositories,就可以看到你所发布的jar包了:

选中对于的repository之后,点击箭头所指的close,close时会检查发布的构件是否符合要求。若符合要求,则close成功,成功之后点击箭头所指的release,即可正式将jar包发布到Sonatype OSSRH仓库。

release成功大概2个小时之后,该构件就会同步到Maven中央仓库:

参考

Guide to uploading artifacts to the Central Repository
OSSRH Guide
Maven入门教程

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Java创建类模式_动力节点Java学院整理

    Java创建类模式_动力节点Java学院整理

    这篇文章主要为大家详细介绍了Java创建类模式的相关方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-08-08
  • Java中比较运算符compareTo()、equals()与==的区别及应用总结

    Java中比较运算符compareTo()、equals()与==的区别及应用总结

    这篇文章主要给大家介绍了关于Java中比较运算符compareTo()、equals()与==的区别及应用的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考借鉴,下面随着小编来一起学习学习吧
    2018-09-09
  • 基于StringUtils工具类的常用方法介绍(必看篇)

    基于StringUtils工具类的常用方法介绍(必看篇)

    下面小编就为大家带来一篇基于StringUtils工具类的常用方法介绍(必看篇)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • Eclipse快速添加get、set方法的操作技巧

    Eclipse快速添加get、set方法的操作技巧

    这篇文章主要介绍了Eclipse快速添加get、set方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07
  • Java仿12306图片验证码

    Java仿12306图片验证码

    这篇文章主要为大家详细介绍了Java仿12306的图片验证码的相关资料,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-04-04
  • springboot使用filter获取自定义请求头的实现代码

    springboot使用filter获取自定义请求头的实现代码

    这篇文章主要介绍了springboot使用filter获取自定义请求头的实例代码,代码简单易懂,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-05-05
  • SpringSecurity权限控制实现原理解析

    SpringSecurity权限控制实现原理解析

    这篇文章主要介绍了SpringSecurity权限控制实现原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • springboot+springmvc实现登录拦截

    springboot+springmvc实现登录拦截

    这篇文章主要介绍了springboot+springmvc实现登录拦截,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • Java实现注册邮箱激活账户实例代码

    Java实现注册邮箱激活账户实例代码

    本篇文章主要介绍了Java实现邮箱激活账户实例代码,这里整理了详细的代码,具有一定的参考价值,有需要的小伙伴可以参考下。
    2017-07-07
  • java同步锁的正确使用方法(必看篇)

    java同步锁的正确使用方法(必看篇)

    下面小编就为大家带来一篇java同步锁的正确使用方法(必看篇)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08

最新评论