starter搞好了怎么让其它人使用？上传到maven中央仓库吧

最新推荐文章于 2023-07-18 15:49:55 发布

宇云轩

最新推荐文章于 2023-07-18 15:49:55 发布

阅读量978

点赞数 1

分类专栏： springboot java 文章标签： maven springboot starter java spring

本文链接：https://blog.csdn.net/u014704879/article/details/108801880

版权

java 同时被 2 个专栏收录

6 篇文章 0 订阅

订阅专栏

springboot

2 篇文章 0 订阅

订阅专栏

starter搞好了怎么让其它人使用？上传到maven中央仓库吧

前言

上次说到在starter封装好后要上传到仓库，下边就是具体的操作步骤以及期间遇到的问题了。
电梯直达：springboot自定义starter的过程以及遇到的坑

背景

如果我们想让其他同事使用自定义好的starter，但是又想像maven管理jar包一样方便使用，怎么办呢？那就把我们的starter上传到中央仓库中吧~

环境

名称	版本
系统	win7
maven	3.2.5
lego-frame-spring-boot-starter	1.0.RELEASEA
gpg(GnuPG)	1.4.13
GpgWin	2.2.17

操作步骤

1. sonatype准备

注册Sonatype账户，访问地址。
创建issue。

上图中需要注意的是groupId需要填写maven坐标中的groupId。如果你想简单直接写com.github,如果你想用自己的（比如我的net.yunqihui）,则要保证你对此域名的拥有权。
可参考我的内容：https://issues.sonatype.org/browse/OSSRH-52945
3) issue审核
当你创建完issue后，大概1小时候左右会有审核反馈，有的文章说需要等到隔天，因为时差的原因。但是我的大概十来分钟便有了反馈。因为我使用的是单独的域名，审核人员让我证明我对此域名的拥有权。

简单来说，就是让你把域名进行DNS解析，解析到此issue的地址即可。

之后再次更改issue状态，大概再一小时左右，审核反馈便会提示已经成功，接下来可以deploy你的snapshot版本或者release版本了。当然了，你再最后成功发布（第一次成功发布）你的jar包后需要在此评论一下你已成功发布。

2. gpg准备

gpg的作用是用来生成密钥对，为后续的上传jar包提供安全保障。

下载安装

因为我的环境为win7系统，所以只演示Windows环境版本。下载并安装gpg:https://www.gpg4win.org/
安装步骤就不贴了，总之一直“下一步”即可。

创建密钥

Windows环境下的工作图形化操作比较多，我一开始也是直接图形化进行密钥的创建，但是后续发现竟然不管用！最后还是使用命令行进行操作的。下边只是对图形化操作步骤进行一个演示，不做具体说明，重点在后续的命令行操作中。
密钥创建

在这里插入图片描述
好了，上边只是一个图形化操作的演示，我使用上述方法发现创建的密钥并没有什么卵用，因为即使将公钥上传到服务器上仍然提示公钥不存在。之后便更换为命令行操作。

首先检查是否安装成功，命令：gpg --version。然而，不论我输入gpg的什么命令，都提示我：gpg: error loading ‘iconv.dll’:找不到指定的模块。
找不到指定模块

根据后续提示，在https://www.gnupg.org/download/iconv.html中给出了解决方案，即：

方案1. 下载libiconv-1.9.1.dll.zip,并将iconv.dll文件拷贝到相应目录下。（页面上说的让参考COPYING.LIB，这个基本上不用看，都是废话，具体看此文章下边的操作即可）
方案2. 如果你是使用Gpgwin安装的GnuPG,你应该不会看到这个错误。如果真出现了，（看到这我都笑了。。）那就是你系统上的其它应用已经安装过这个dll文件了。你的解决方案就是重装一次即可。

因为我一开始并没有直接看提示的网址的内容，而是选择直接百度，发现基本上提示这个问题的都是git操作才会提示，我就很纳闷跟Git有什么关系，后来看到方案2的时候才恍然大悟，原来git也是用到了这个gpg,正是因为git的使用，导致了我使用GpgWin没有正确安装这个dll文件。我怕按照方案二重新安装万一导致git再不可用，就悲催了，所以选择使用方案1。但是放在哪里呢，文章底部有提示：如果你不知道把他放在那里，那就最好放在跟gpg.exe文件同一目录。

那么问题来了。我的gpg.exe在哪？妈蛋，这个我也不知道啊~，后来使用win按键，然后输入gpg.exe，才查找到了,真的就在git安装目录下。

好了，现在使用命令gpg --version查看（注意下图的Home,在后续配置中需要使用）:
gpg version

使用命令创建key：gpg --gen-key,创建过程中会有类似于“下一步”的选项，按照图中选择即可（当然也可按照你自己的意愿选择其他的）。 gen key

其中在这一步需要输入userId的时候，提示要按照一定的格式，然后给出了示范，我一开始以为Real name:的待输入项就是按照他们的格式填写（参考上图最后一个红框），结果怎么都提示realname格式不正确，后来恍然大悟，他喵的，他们是分开填写的。。。。（即输入real name后回车，再输入email。。）
gen key

注意：记住此时最后生成的公钥，下边发送到服务器时需使用（上图最后一个红框内，例如上图中：3E979678D53B487C24B37971DB4DE5DED31505F4）

查看公钥

使用命令：gpg --list-keys
查看公钥

将公钥发布到GPG密钥服务器

使用命令：gpg --keyserver hkp://pool.sks-keyservers.net --send-keys xxxx
这里的xxxx是你刚刚生成的公钥(第2步最后生成的那串公钥)
发布公钥

检验公钥是否发送成功（这步很重要，我后边就因为没发送成功出了一点问题）
使用命令：gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys xxxx
这里的xxx也是公钥，注意：命令为revc,不是revc,有的文章有可能是打错字了，我一开始一直提示不是内部命令。

3. 配置maven相关

setting.xml设置
此处的setting指的是maven的配置文件，并不是pom中。

<servers>
    <server>
      <!-- 此id可以随便写，但是一定要保证和pom中的snapshotRepository一致 -->
      <id>sonatype-nexus</id>
      <!-- 此处是注册sonatype的账号 -->
      <username>coder_michael</username>
      <!-- 此处是注册sonatype的密码 -->
      <password>xxxxxx</password>
    </server>
</servers>

 <profiles>
	<profile>
		<id>sonatype-nexus</id>
		<activation>
			<activeByDefault>true</activeByDefault>
		</activation>
		<properties>
			<gpg.executable>gpg</gpg.executable>
			<!-- 此处是设置的gpg密钥的密码 -->
			<gpg.passphrase>xxxxxx</gpg.passphrase>
			<!-- 此处是gpg.exe的位置路径 -->
			<gpg.executable>D:\Git\bin\gpg.exe</gpg.executable>
			<!-- 此处是生成密钥的位置，还记得gen --version的时候么？ -->
			<gpg.homedir>C:/Users/Administrator/AppData/Roaming/gnupg</gpg.homedir>
		</properties>
	</profile>
  </profiles>

pom.xml设置
项目中pom文件中需要配置license、scm、developer、snapshotRepository、maven-source-plugin、maven-javadoc-plugin、maven-gpg-plugin（其中需要特别注意source和javadoc的plugin要配置对，不然最后会上传到sonatype的oss后无法close）,以下为详细pom：

<?xml version="1.0" encoding="UTF-8"?>
<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.2.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>


    <groupId>net.yunqihui</groupId>
    <artifactId>lego-frame-spring-boot-starter</artifactId>
    <version>1.0.RELEASE</version>
    <name>lego-frame-spring-boot-starter</name>
    <description>Base frame for company`s service</description>


    <!-- 版权许可 -->
    <licenses>
        <license>
            <name>The Apache Software License, Version 2.0</name>
            <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
            <distribution>repo</distribution>
        </license>
    </licenses>
    <!-- 代码库 -->
    <scm>
        <tag>master</tag>
        <url>https://github.com/qismyq/spring-lego.git</url>
        <connection>scm:git:git@github.com:qismyq/spring-lego.git</connection>
        <developerConnection>scm:git:git@github.com:qismyq/spring-lego.git</developerConnection>
    </scm>
    <!-- 开发者信息 -->
    <developers>
        <developer>
            <name>coder_michael</name>
            <email>michael_wang90@163.com</email>
            <roles>
                <role>owner</role>
            </roles>
            <timezone>+8</timezone>
        </developer>
    </developers>
    <!-- 定义snapshots库和releases库的nexus地址 -->
    <distributionManagement>
        <snapshotRepository>
            <id>sonatype-nexus</id>
            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        </snapshotRepository>
        <repository>
            <id>sonatype-nexus</id>
            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
        </repository>
    </distributionManagement>


    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                </plugin>
                <!--deploy插件-->
                <plugin>
                    <artifactId>maven-deploy-plugin</artifactId>
                    <version>2.8.2</version>
                    <executions>
                        <execution>
                            <id>default-deploy</id>
                            <phase>deploy</phase>
                            <goals>
                                <goal>deploy</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>

                <!--sonatype的staging插件-->
                <!--<plugin>-->
                    <!--<groupId>org.sonatype.plugins</groupId>-->
                    <!--<artifactId>nexus-staging-maven-plugin</artifactId>-->
                    <!--<version>1.6.7</version>-->
                    <!--<extensions>true</extensions>-->
                    <!--<configuration>-->
                        <!--&lt;!&ndash;<serverId>sonatype-nexus-snapshots</serverId>&ndash;&gt;-->
                        <!--<serverId>sonatype-nexus-staging</serverId>-->
                        <!--<nexusUrl>https://oss.sonatype.org/</nexusUrl>-->
                        <!--<autoReleaseAfterClose>true</autoReleaseAfterClose>-->
                    <!--</configuration>-->
                <!--</plugin>-->
                <!--SCM插件-->
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-scm-plugin</artifactId>
                    <version>1.8.1</version>
                </plugin>

            </plugins>
        </pluginManagement>

    </build>

    <profiles>
        <profile>
            <id>release</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-source-plugin</artifactId>
                        <version>2.1.2</version>
                        <executions>
                            <execution>
                                <id>attach-sources</id>
                                <phase>package</phase>
                                <goals>
                                    <goal>jar-no-fork</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>

                    <!-- Javadoc -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>2.9.1</version>
                        <configuration>
                            <aggregate>true</aggregate>
                            <!--需要配置，不然会出现“错误: 未知标记:xxxx”-->
                            <charset>UTF-8</charset>
                            <encoding>UTF-8</encoding>
                            <docencoding>UTF-8</docencoding>
                            <additionalparam>-Xdoclint:none</additionalparam>
                        </configuration>
                        <executions>
                            <execution>
                                <phase>package</phase>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                    <!-- GPG -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-gpg-plugin</artifactId>
                        <executions>
                            <execution>
                                <phase>verify</phase>
                                <goals>
                                    <goal>sign</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

</project>

由上可看到，使用了 Maven 的 profile 功能，只有在 release 的时候，创建源码包、创建文档包、使用 GPG 进行数字签名。

此外，snapshotRepository 与 repository 中的 id 一定要与 setting.xml 中 server 的 id 保持一致。由于有的文档使用的是ossrh,有的是oss，导致我打包的时候出了问题。而且上边有一个plugin是被注释掉的，我其实最后并没有使用到，autoReleaseAfterClose 的值为true，则脚本会自动完成在sonatype平台上后续close、release的操作。

4. 打包上传

执行命令mvn clean deploy -P release
打包上传

由上图可以看出已经构建成功了，但是还是要注意一下上图中的uploaded的一些提示，通常包含但不限于.jar、sources.jar、javadoc.jar、.asc等文件，否则再一下步在平台上操作close时有可能会出错。

5. sonatype上close并release等

在平台上（https://oss.sonatype.org/index.html）登录，然后选择Staging Repositories,会出现你刚刚构建的包。
登陆 sonatype

由上图可以看到列表上方有close、Release等按钮，因为我截图时已经点过close了，所以是灰色的。

此时点击close，如果您有以下错误，请检查第三步的配置，并确保第四步的截图。
close

以下为close正确的图片：
close

release

点击close后，点击右侧的Release按钮，查看activity栏，你会发现是否成功（这里因为我勾选了Automatically Drop,所以后续刷新了一下没有保存到成功结果图，不过仍可再下图中搜索到你的组件）。
release

issue回复
activity栏中最后一句是提示会给你发送一封邮件。并且你会发现https://issues.sonatype.org中审核人员会同步有一条评论，提示你大概2个小时后可以再 search.maven.org搜索到你的组件。

至此，所有操作完成！

参考文章：

发布组件类：
https://juejin.im/post/5cb03e1a5188251b0e4e3583
https://www.jianshu.com/p/5f6135e1925f
https://monkeywie.github.io/2018/07/23/publish-jar-to-maven/
https://www.jdon.com/idea/publish-to-center-maven.html
https://www.jianshu.com/p/69e54a6b6c45
细节类：
https://blog.csdn.net/ys_zk/article/details/80924469
https://www.cnblogs.com/softidea/p/4186090.html
https://blog.csdn.net/u010667011/article/details/86287979

感谢以上文章的作者！！

宇云轩

关注

1
点赞
踩
4

收藏

觉得还不错? 一键收藏
11
评论
starter搞好了怎么让其它人使用？上传到maven中央仓库吧

starter搞好了怎么让其它人使用？上传到maven中央仓库吧前言背景环境操作步骤1. sonatype准备2. gpg准备3. 配置maven相关4. 打包上传5. sonatype上close并release等参考文章：前言上次说到在starter封装好后要上传到仓库，下边就是具体的操作步骤以及期间遇到的问题了。电梯直达：springboot自定义starter的过程以及遇到的坑背景如果我们想让其他同事使用自定义好的starter，但是又想像maven管理jar包一样方便使用，怎
复制链接

扫一扫