【Java教程】Day16-07 Maven基础：发布库到Maven仓库

Maven 是 Java 开发中常用的构建工具，通过其强大的依赖管理功能，可以自动下载所需的依赖库和文件。当我们使用诸如 commons-logging 这些第三方开源库时，Maven 会自动从中央仓库下载它们的 JAR 文件，并将相关的依赖项自动加入项目中，确保项目的构建和运行。

那么，假如我们自己写了一个开源库，如何让别人也能方便地使用呢？直接放一个 JAR 文件下载链接显然不够方便。将库发布到 Maven 仓库中，就能让其他开发者通过标准的方式引用并自动下载依赖。本文将介绍如何将自己的库发布到 Maven 仓库，并分享三种常用的发布方法。

1. 将开源库发布到 Maven 仓库

1.1 方式一：通过静态文件发布到 GitHub Pages

通过将开源库发布到 GitHub Pages，可以在静态网页上托管 Maven 仓库，使其他开发者可以方便地引用和下载该库。

1.1.1 创建 Maven 项目结构

假设我们有一个名为 how-to-become-rich 的开源项目，首先在本地创建如下的 Maven 项目结构：

luahow-to-become-rich├── maven-repo        <-- Maven 本地文件仓库├── pom.xml           <-- 项目文件├── src│   ├── main│   │   ├── java      <-- 源码目录│   │   └── resources <-- 资源目录│   └── test│       ├── java      <-- 测试源码目录│       └── resources <-- 测试资源目录└── target            <-- 编译输出目录

 

1.1.2 配置 pom.xml 文件

在 pom.xml 文件中，我们需要添加仓库配置，指定发布的位置：

xml<project ...>    ...    <distributionManagement>        <repository>            <id>local-repo-release</id>            <name>GitHub Release</name>            <url>file://${project.basedir}/maven-repo</url>        </repository>    </distributionManagement>​    <build>        <plugins>            <plugin>                <artifactId>maven-source-plugin</artifactId>                <executions>                    <execution>                        <id>attach-sources</id>                        <phase>package</phase>                        <goals>                            <goal>jar-no-fork</goal>                        </goals>                    </execution>                </executions>            </plugin>            <plugin>                <artifactId>maven-javadoc-plugin</artifactId>                <executions>                    <execution>                        <id>attach-javadocs</id>                        <phase>package</phase>                        <goals>                            <goal>jar</goal>                        </goals>                    </execution>                </executions>            </plugin>        </plugins>    </build></project>

 

这里，<distributionManagement> 标签指定了发布的目标目录为项目中的 maven-repo 目录。通过两个插件（maven-source-plugin 和 maven-javadoc-plugin），我们可以在构建时附加源码和文档文件。

1.1.3 使用 Maven 发布包

在项目根目录运行以下命令进行发布：

bashmvn clean package deploy

 

这会将生成的 JAR 文件、源码和 Javadoc 等文件部署到 maven-repo 目录下。

1.1.4 推送到 GitHub 并启用 GitHub Pages

将项目推送到 GitHub，并在 GitHub 设置中启用 GitHub Pages 服务。启用后，可以通过以下链接访问 Maven 仓库：

vbnethttps://michaelliao.github.io/how-to-become-rich/maven-repo/

 

1.1.5 依赖库的引用

其他开发者可以通过以下方式在自己的项目中引用该库：

xml<dependency>    <groupId>com.itranswarp.rich</groupId>    <artifactId>how-to-become-rich</artifactId>    <version>1.0.0</version></dependency>

 

此外，还需要在 pom.xml 中声明仓库地址：

xml<repositories>    <repository>        <id>github-rich-repo</id>        <name>The Maven Repository on Github</name>        <url>https://michaelliao.github.io/how-to-become-rich/maven-repo/</url>    </repository></repositories>

 

通过这种方式，其他开发者可以直接引用该库，无需手动下载 JAR 文件。

1.2 方式二：通过 Nexus 发布到 Maven 中央仓库

如果想要将库发布到 Maven 中央仓库，可以使用 Nexus 进行发布。通过将库发布到 Nexus，它会定期同步到 Maven 中央仓库。下面是操作步骤。

1.2.1 配置 Nexus 发布

首先，需要在 ~/.m2/settings.xml 配置中添加登录信息，并生成 GPG 签名。

xml<settings>    <servers>        <server>            <id>ossrh</id>            <username>OSSRH-USERNAME</username>            <password>OSSRH-PASSWORD</password>        </server>    </servers>    <profiles>        <profile>            <id>ossrh</id>            <activation>                <activeByDefault>true</activeByDefault>            </activation>            <properties>                <gpg.executable>gpg2</gpg.executable>                <gpg.passphrase>GPG-PASSWORD</gpg.passphrase>            </properties>        </profile>    </profiles></settings>

 

1.2.2 配置 pom.xml 发布信息

在 pom.xml 中，添加 Nexus 的 Maven 仓库地址配置：

xml<distributionManagement>    <repository>        <id>ossrh</id>        <name>Nexus Release Repository</name>        <url>http://oss.sonatype.org/service/local/staging/deploy/maven2/</url>    </repository></distributionManagement>

 

1.2.3 发布命令

完成配置后，使用以下命令将库发布到 Nexus：

bashmvn clean package deploy

 

1.3 方式三：通过 GitHub Packages 发布

1.3.1 配置 GitHub Tokens

在 GitHub 上，首先需要生成 Personal Access Tokens，并赋予正确的权限，特别是 write:packages 和 read:packages 权限。

1.3.2 配置 pom.xml 和 GitHub 仓库

在 pom.xml 中配置发布到 GitHub Packages 的信息，并确保 ~/.m2/settings.xml 中有正确的认证信息。

xml<distributionManagement>    <repository>        <id>github-release</id>        <name>GitHub Release</name>        <url>https://maven.pkg.github.com/michaelliao/complex</url>    </repository></distributionManagement>

 

发布命令：

bashmvn clean package deploy

 

发布成功后，GitHub 会为你提供 Artifact 的访问地址。

2. 小结

通过 Maven 发布一个开源库，可以选择多种方式：

• 静态文件发布：通过 GitHub Pages 托管 Maven 仓库，需要手动配置和上传文件，适用于小型项目。

• Nexus 发布：通过 Nexus 发布到 Maven 中央仓库，适用于较为专业的开源项目，需进行申请和配置。

• GitHub Packages：通过 GitHub Packages 作为私有仓库发布，需要正确配置认证和权限。

 

每种方式都有其适用的场景，开发者可以根据自己的需求选择合适的发布方式。