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

程序员文章站 2024-03-01 21:12:52

将jar包发布到maven*仓库(maven central repository)，这样所有的java开发者都可以使用maven直接导入依赖，例如： <...

将jar包发布到maven*仓库(maven central repository)，这样所有的java开发者都可以使用maven直接导入依赖，例如：

<!-- 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

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

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

summary
description
group id
project url
scm url

大家可以参考我申请发布与时所填写的内容：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包了：

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

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

release成功大概2个小时之后，该构件就会同步到maven*仓库：

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

参考

guide to uploading artifacts to the central repository
ossrh guide
maven入门教程

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

上一篇： mysql如何处理varchar与nvarchar类型中的特殊字符

下一篇： firefox推荐与个人理解的css书写顺序

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