原创

如何使用Maven将jar包发布到中央仓库?

maven的仓库只有两大类:1.本地仓库 2.远程仓库,而在远程仓库中又分成了3种:1)中央仓库 2)私服 3)其它公共库

maven本地仓库的默认位置无论是Windows还是Linux都是在用户的目录下都有一个.m2/repository/的仓库目录;更改maven默认的本地仓库的位置引入一个新的元素:localRepository,它存在于maven的settings.xml配置文件中。


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

<!-- https://mvnrepository.com/artifact/com.yoodb/yoodb-java -->
<dependency>
    <groupId>com.yoodb</groupId>
    <artifactId>yoodb-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

1547443962(1).png

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


2. 创建issue

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


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

1547444561(1).png

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

Summary
Description
Group Id
Project URL
SCM url

大家可以参考我申请发布yoodb-java与yoodb-spring时所填写的内容:OSSRH-45238。但是由于时差问题当前创建issue,第二天才会有回应。当issue的status变为RESOLVED,我们就可以进行下一步操作了。


3. 安装并配置GPG

发布到Maven仓库中的所有文件都要使用GPG签名,以保障完整性。因此,我们需要在本地安装并配置GPG。安装GPG,MacBook安装GPG非常简单,下载并安装GPG Suite即可。下载地址:https://gpgtools.org/


生成GPG密钥对命令:gpg --gen-key,注意:生成密钥时将需要输入name、email以及password。password在之后的步骤需要用到,请记下来。

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

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


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

gpg --list-keys
/Users/kiwenlau/.gnupg/pubring.kbx
----------------------------------
pub   dsa2048 2010-08-19 [SC] [expires: 2020-06-15]
      86E38F69046B66C1EC9FB09B75D78F0500D034E8
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]
      BVC0042C69B699D989D2A62BD74A11D3F9F80574
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.yoodb</groupId>
    <artifactId>yoodb-java-notifier</artifactId>
    <version>0.2.0</version>
    <packaging>pom</packaging>
    <name>yoodb-java-notifier</name>
    <url>https://github.com/Fundebug/yoodb-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/yoodb-java-notifier</url>
        <connection>https://github.com/Fundebug/yoodb-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>yoodb-java</module>
        <module>yoodb-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 yoodb-java,yoodb-spring

我们的项目yoodb-java-notifier含有多个模块,仅需部署yoodb-java与yoodb-spring,因此使用-projects选项来指定。第一次执行mvn clean deploy命令时,需要输入GPG密钥的密码。

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

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] yoodb-java 0.2.0 ................................ SUCCESS [ 12.183 s]
[INFO] yoodb-spring 0.2.0 .............................. SUCCESS [ 22.383 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 34.728 s
[INFO] Finished at: 2019-01-14T20:11: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中央仓库:

image.png


关注下方微信公众号“Java精选”(w_z90110),回复关键字领取资料:如HadoopDubboCAS源码等等,免费领取资料视频和项目。 

涵盖:程序人生、搞笑视频、算法与数据结构、黑客技术与网络安全、前端开发、Java、Python、Redis缓存、Spring源码、各大主流框架、Web开发、大数据技术、Storm、Hadoop、MapReduce、Spark、elasticsearch、单点登录统一认证、分布式框架、集群、安卓开发、iOS开发、C/C++、.NET、Linux、Mysql、Oracle、NoSQL非关系型数据库、运维等。

评论

  1. #1

    SugarLiny (2019/02/12 09:46:23)回复
    四爷,在pom.xml文件中应该将最关键的部分配置信息着重加粗,以区别常用的一些配置信息,对新人来说还是很关键的。

分享:

支付宝

微信