构建自己的jar包上传至Mvaen中央仓库

引言

作为一个喜欢造轮子的选手,自然是希望自己写的小工具能被大家使用,本次就以自己上传小工具类到maven仓库举例,一步一步演示上传过程

创建一个新的项目issue

第一步 注册工单管理

Maven 中央仓库是由企业Sonatype,Inc.负责运营维护的,但是,Maven中央仓库并不支持直接发布jar包。我们需要将jar包发布到一些指定的第三方Maven仓库,然后该仓库再将jar包同步到Maven中央仓库。其中,最”简单”的方式是通过Sonatype OSSRH仓库来发布jar包。接下来,我会介绍如何将jar包发布到Sonatype OSSRH。

首先前往issues.sonatype.org注册一个账号(如果你已经有了账号,可以跳过此步骤)。JIRA是一个项目管理服务,类似于国内的Teambition。Sonatype通过JIRA来管理OSSRH仓库。需要填写Email, Full Name, Username以及password,其中Username与Password后面的步骤需要用到,请记下来。

第二步 创建issue

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

image-20210112205005218

需要注意的是Group Id 是唯一标识,我用的是com.hanzoy,管理员会问要求你证明这个域名是属于你的,简单的修改一下域名解析就可以证明了(用com.github.xxxxx 这种比较方便)。官方文档

image-20210112205423854

ProjectURL 是填项目源码的地址,官方有一篇文章说,如果不想公布源码,那么填写一个只含README 的项目的地址就可以了。

管理员主要审核的也只是Group Id而已

这时你的工单的状态StatusOpen ,等到审核通过状态会变为RESOLVED ,第一次审核要一天左右 ,因为时差原因,他们工作时间是我们的晚上,由于我在凌晨三点申请的,几分钟就审核通过了。

之后管理员会通知你说已经准备好了仓库

image-20210112205934489

至此,我们便完成了创建

配置Maven Settings.xml & pom.xml

配置 Maven 中的conf/settings.xml

servers 中添加如下代码

  <server>
    <id>sonatype-nexus-snapshots</id>
    <username>https://issues.sonatype.org的账号</username>
    <password>https://issues.sonatype.org的密码</password>
  </server>
  <server>
    <id>sonatype-nexus-staging</id>
    <username>https://issues.sonatype.org的账号</username>
    <password>https://issues.sonatype.org的密码</password>
  </server>

这里的账号密码就是上面注册时候的账号和密码

配置使用项目中的 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,根据需要修改即可。

dependencies填写你自己项目所依赖的jar包

build可以直接复制

其他则根据自己情况修改,这些都是描述信息

注意:如果version填写的是SNAPSHOT,即快照版的话可以上传到 oss.sonatype.org 但是不会上传至中央仓库

image-20210112211826156

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>

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.1</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<groupId>com.hanzoy</groupId>
<artifactId>utils</artifactId>
<version>1.0</version>
<packaging>jar</packaging>

<name>JWTUtils</name>
<url>https://github.com/Hanzoy/JWTUtils</url>
<description>Fast token generation and parsing based on springboot</description>

<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>Hanzoy</name>
        <email>hanzoy@stud.tjut.edu.cn</email>
        <timezone>+8</timezone>
    </developer>
</developers>
<scm>
    <connection>scm:git:git://github.com/Hanzoy/JWTUtils.git</connection>
    <developerConnection>scm:git:ssh://github.com/Hanzoy/JWTUtils.git</developerConnection>
    <url>http://github.com/Hanzoy/JWTUtils</url>
</scm>
<distributionManagement>
    <snapshotRepository>
        <id>sonatype-nexus-snapshots</id>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    </snapshotRepository>
    <repository>
        <id>sonatype-nexus-snapshots</id>
        <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
</distributionManagement>

<properties>
    <java.version>1.8</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <gpg.executable>gpg</gpg.executable>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.auth0/java-jwt -->
    <dependency>
        <groupId>com.auth0</groupId>
        <artifactId>java-jwt</artifactId>
        <version>3.11.0</version>
    </dependency>
</dependencies>


<build>
    <plugins>
        <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>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.9</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                    <!-- JDK8必须使用下面的配置 -->
                    <configuration>
                        <encoding>UTF-8</encoding>
                        <charset>UTF-8</charset>
                        <additionalparam>-Xdoclint:none</additionalparam>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-gpg-plugin</artifactId>
            <version>1.6</version>
            <executions>
                <execution>
                    <id>sign-artifacts</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>sign</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

</project>

如果maven无法下载plugin则建议大家手动下载,例如:

mvn dependency:get -DrepoUrl=http://repo.maven.apache.org/maven2/ -Dartifact=org.apache.maven.plugins:maven-javadoc-plugin:2.9.1

当然也可以在 IntelliJ IDEA 中更新 Indexed Maven Repositories

步骤: IntelliJ IDEA -> Preferences -> Build,Execution,Deployment -> Build Tools -> Maven -> Repositories -> Remote URL -> Update

这个过程耗时视网速而定,大概 5~10 分钟所以还是建议第一种方法

配置GPG环境

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

安装GPG

安装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]

发布jar包

在命令行中执行一下命令

-X可以查看详细信息

mvn clean deploy -X 

GPG版本问题

很神奇,执行命令时总是报找不到gpg2,仔细查看后,发现是在 terminal 输入的指令是 gpg2 而不是 gpg但 Maven 里面的 maven-gpg-plugin 插件默认是使用 gpg 指令,不是 gpg2

于是。。。。。。。。。。。。。。

我找到bin目录下的gpg,复制一个并重命名为gpg2 。

真就。。。。。成功了。。╰( ̄ω ̄o)

之后会弹出一个输入密码的框

image-20210112214604138

输入之前设置好的密码就可以了

close并release

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

image-20210112214758787

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

如果不满足要求那么需要在下面的信息栏中找到不合格的属性。Google搜索解决问题。我也是不停的更换pom.xml内容,最后才搞定了这个,一般来讲使用上面我xml配置不会出错(jdk1.8)。

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

image-20210112215029547


一个好奇的人