发布jar到maven中央仓库的方法

发布时间：2021-06-26 10:06:12 作者：chen
来源：亿速云阅读：253

# 发布JAR到Maven中央仓库的方法

## 引言

在Java生态系统中，Maven中央仓库是最重要的依赖管理仓库之一。将项目发布到Maven中央仓库不仅能够方便其他开发者使用你的库，还能提升项目的可见性和可信度。本文将详细介绍如何将JAR包发布到Maven中央仓库，包括前期准备、配置、签名和发布流程。

---

## 1. 准备工作

### 1.1 注册Sonatype账号

Sonatype是Maven中央仓库的管理者，所有发布到中央仓库的JAR包都需要通过Sonatype的审核。首先，你需要注册一个Sonatype账号：

1. 访问 [Sonatype JIRA](https://issues.sonatype.org/)
2. 点击 **Sign Up** 注册账号
3. 完成邮箱验证

### 1.2 申请Group ID

Group ID通常是项目的顶级域名（如`com.github.yourusername`）。如果你没有自己的域名，可以使用GitHub的域名（如`io.github.yourusername`）。

1. 在Sonatype JIRA上创建一个新的Issue：
   - 项目：**Community Support - Open Source Project Repository Hosting (OSSRH)**
   - 类型：**New Project**
   - 标题：**Publish your.group.id to Maven Central**
   - 描述：说明你的项目信息，包括Group ID、项目URL等
2. 等待审核（通常需要1-2个工作日）

### 1.3 安装GPG工具

Maven中央仓库要求所有发布的文件必须经过GPG签名。你需要安装GPG工具并生成密钥对：

- **Windows**：下载 [Gpg4win](https://www.gpg4win.org/)
- **MacOS**：通过Homebrew安装：`brew install gnupg`
- **Linux**：使用包管理器安装（如`apt-get install gnupg`）

生成密钥对：
```bash
gpg --gen-key

按照提示输入姓名、邮箱和密码。生成完成后，导出公钥：

gpg --keyserver hkp://keyserver.ubuntu.com --send-keys YOUR_KEY_ID

2. 配置Maven项目

2.1 添加Maven插件

在项目的pom.xml中添加以下插件和配置：

<build>
    <plugins>
        <!-- 生成源码和Javadoc JAR -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>3.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>3.3.2</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- GPG签名插件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-gpg-plugin</artifactId>
            <version>3.0.1</version>
            <executions>
                <execution>
                    <id>sign-artifacts</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>sign</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- 发布到中央仓库 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-release-plugin</artifactId>
            <version>3.0.0</version>
            <configuration>
                <autoVersionSubmodules>true</autoVersionSubmodules>
                <useReleaseProfile>false</useReleaseProfile>
                <arguments>-Dgpg.passphrase=${gpg.passphrase}</arguments>
            </configuration>
        </plugin>
    </plugins>
</build>

2.2 配置SCM信息

在pom.xml中添加项目的版本控制信息：

<scm>
    <connection>scm:git:https://github.com/yourusername/yourproject.git</connection>
    <developerConnection>scm:git:https://github.com/yourusername/yourproject.git</developerConnection>
    <url>https://github.com/yourusername/yourproject</url>
</scm>

2.3 配置Distribution Management

添加Sonatype的仓库地址：

<distributionManagement>
    <snapshotRepository>
        <id>ossrh</id>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
    </snapshotRepository>
    <repository>
        <id>ossrh</id>
        <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
</distributionManagement>

3. 配置Maven Settings

在~/.m2/settings.xml中添加Sonatype账号和GPG配置：

<settings>
    <servers>
        <server>
            <id>ossrh</id>
            <username>your-sonatype-username</username>
            <password>your-sonatype-password</password>
        </server>
    </servers>
    <profiles>
        <profile>
            <id>gpg</id>
            <properties>
                <gpg.executable>gpg</gpg.executable>
                <gpg.passphrase>your-gpg-passphrase</gpg.passphrase>
            </properties>
        </profile>
    </profiles>
    <activeProfiles>
        <activeProfile>gpg</activeProfile>
    </activeProfiles>
</settings>

4. 发布到Maven中央仓库

4.1 构建和签名

运行以下命令构建项目并生成签名：

mvn clean deploy

4.2 登录Sonatype Nexus

访问 Sonatype Nexus
使用Sonatype账号登录
在 Staging Repositories 中找到你的项目

4.3 关闭和发布

选中你的仓库，点击 Close
等待验证通过后，点击 Release
等待同步到Maven中央仓库（通常需要几小时到几天）

5. 验证发布

访问 Maven Central
搜索你的Group ID和Artifact ID
确认版本已显示

6. 常见问题

6.1 GPG签名失败

确保GPG密钥已上传到服务器
检查settings.xml中的gpg.passphrase是否正确

6.2 403权限错误

确认Sonatype账号有权限发布到申请的Group ID
检查settings.xml中的账号密码是否正确

6.3 同步延迟

首次发布可能需要较长时间同步
如果超过48小时未同步，可以在Sonatype JIRA上提交Issue询问

结语

通过以上步骤，你可以成功将JAR包发布到Maven中央仓库。发布后，其他开发者只需在pom.xml中添加依赖即可使用你的库。记得在项目中添加文档和示例代码，方便他人快速上手！ “`

这篇文章详细介绍了从注册账号到发布完成的完整流程，涵盖了配置、签名和常见问题解决方法。你可以根据需要调整内容或补充更多细节。