返回

从小白到高手:Maven Central 发布指南,避雷防坑!

Android

Maven Central 发布流程:避雷指南

前言

作为一名 Android 开发者,将你的 library 发布到 Maven Central 是一个重要的里程碑,因为它使你的代码可以更轻松地被其他人访问和使用。但是,这个过程可能很复杂,尤其是对于初学者来说。本文将引导你完成 Maven Central 发布流程,并避免潜在的陷阱。

环境准备

在开始之前,你需要确保你的开发环境已准备就绪。本文使用的环境如下:

  • Android Studio: Arctic Fox
  • Gradle:7.0.2
  • gpg: 2.2

步骤 1:创建 Maven Central 帐户

首先,你需要在 Maven Central 网站上创建一个帐户。转到 https://search.maven.org/ 并单击“创建帐户”按钮。按照提示填写必要信息,并确保选中“上传工件”复选框。

步骤 2:创建 GPG 密钥对

Maven Central 使用 GPG 密钥对来确保上传工件的真实性和完整性。你需要生成一对 GPG 密钥。按照以下步骤操作:

  • 在终端中运行以下命令:
gpg --generate-key
  • 按照提示生成一个密钥对。确保密钥大小至少为 2048 位,并选择一个安全且易记的密码。

步骤 3:上传你的工件

接下来,你需要上传你的 library 工件到 Maven Central。为此,请遵循以下步骤:

  1. 在你的 library 项目根目录下创建以下文件:
pom.xml
  1. 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.example</groupId>
    <artifactId>my-library</artifactId>
    <version>1.0.0</version>
    <packaging>aar</packaging>

    <distributionManagement>
        <repository>
            <id>ossrh</id>
            <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
        </repository>
    </distributionManagement>
</project>
  1. 将你的 library 的 AAR 文件复制到 build/outputs/aar 目录中。
  2. 在终端中运行以下命令以发布你的工件:
./gradlew publish

步骤 4:审核和发布

你的工件现在已上传到 Maven Central,但尚未可用。它将需要经过一个审核过程才能获得批准。通常需要 1-2 天。

一旦你的工件获得批准,你将收到一封电子邮件通知。你可以在 Maven Central 网站上查看你的工件的状态。

故障排除

在 Maven Central 发布过程中,你可能会遇到一些问题。以下是一些常见的故障排除提示:

  • 无法创建 GPG 密钥对: 确保你有权访问你的终端并已安装 GPG。
  • 无法上传工件: 检查你的 pom.xml 文件是否正确配置,并且你的 library 的 AAR 文件已复制到正确的位置。
  • 审核过程延迟: 请耐心等待审核过程。在繁忙时期,可能需要更长的时间才能获得批准。

结论

遵循本文中的步骤,你可以将你的 library 发布到 Maven Central,并与世界分享你的代码。通过避免常见的陷阱,你可以使这个过程更顺利、更高效。记得定期检查 Maven Central 网站以了解你的工件的状态,并随时寻求帮助。