6.4 Artifactory

6.4 Artifactory

6.4 Artifactory：Maven 生态系统的基石

在 Maven 的世界里，构建的生命周期不仅仅是编译、测试和打包。一个成熟的项目通常需要考虑依赖管理、构建产物存储、版本控制、安全访问以及构建流程的自动化。随着项目规模的增长和团队协作的深入，传统的本地 Maven 仓库已经无法满足日益复杂的需求。这时，像 Artifactory 这样的仓库管理工具就显得至关重要。

6.4.1 Artifactory 概述：不仅仅是仓库

Artifactory，由 JFrog 公司开发，是一款通用的 仓库管理器 (Repository Manager)，它不仅支持 Maven，还支持包括 Docker、npm、PyPI、Gradle 等多种包格式。在 Maven 的背景下，Artifactory 扮演着中央仓库的角色，它为团队提供了一个集中化、安全可靠的平台来管理和共享 Maven 项目的 依赖 (Dependencies) 和 构建产物 (Artifacts)。

与传统的 Maven 本地仓库相比，Artifactory 提供了以下核心优势：

• 集中化管理: 将所有团队成员的依赖和构建产物集中存储在统一的仓库中，避免了本地仓库分散、版本不一致等问题。

• 远程仓库代理: Artifactory 可以作为 Maven Central、JCenter 等公共仓库的代理，缓存下载的依赖，加速构建速度，并减少对外部网络的依赖。

• 访问控制与安全: 提供细粒度的权限管理，可以控制用户对仓库的访问权限，确保构建产物的安全性和合规性。

• 构建产物生命周期管理: 支持构建产物的版本控制、元数据管理、部署流程管理，以及构建晋升 (Build Promotion) 等高级功能。

• 高可用与扩展性: Artifactory 支持集群部署，提供高可用性和可扩展性，满足大型团队和高负载场景的需求。

• 全面的搜索和元数据: 提供强大的搜索功能，可以根据各种元数据 (groupId, artifactId, version, properties 等) 快速定位到需要的构建产物。

• 与 CI/CD 工具集成: Artifactory 可以与 Jenkins、GitLab CI、Bamboo 等主流 CI/CD 工具无缝集成，实现自动化构建和部署流程。

简而言之，Artifactory 不仅仅是一个简单的文件存储服务器，它是一个 智能的、企业级的 Maven 仓库管理解决方案，可以极大地提升 Maven 项目的开发效率、构建速度、安全性和可维护性。

6.4.2 Artifactory 的核心概念：仓库类型

Artifactory 的核心概念之一是 仓库 (Repository)。为了更好地组织和管理不同类型的构建产物，Artifactory 引入了三种主要的仓库类型：

• 本地仓库 (Local Repository): 用于存储组织内部自行开发的、需要共享的 Maven 构建产物。例如，公司内部的公共组件、共享库、发布的应用程序等。本地仓库完全由组织控制，可以自定义其结构、权限和策略。

• 远程仓库 (Remote Repository): 作为外部 Maven 仓库（如 Maven Central、JCenter、企业内部私有仓库等）的代理。当 Maven 构建需要下载远程依赖时，Artifactory 会先检查本地缓存，如果缓存不存在，则从配置的远程仓库下载，并缓存到本地。远程仓库可以加速依赖下载，减少对外部网络的依赖，并提供对外部仓库的统一访问入口。

• 虚拟仓库 (Virtual Repository): 将多个本地仓库和远程仓库聚合到一个统一的访问入口。Maven 构建可以通过访问虚拟仓库，透明地访问其包含的所有仓库。虚拟仓库可以简化仓库配置，提高灵活性，并允许组织根据不同的需求组合不同的仓库。

这三种仓库类型之间的关系可以用下图表示：

图 6.4.2-1：Artifactory 仓库类型关系图

总结仓库类型的选择策略：

• 本地仓库: 存储组织内部生成的 Maven 构建产物。

• 远程仓库: 代理外部 Maven 仓库，加速依赖下载和缓存。

• 虚拟仓库: 作为 Maven 构建统一的仓库访问入口，聚合多个仓库。

在实际项目中，通常会结合使用这三种仓库类型，例如：

1. 创建一个或多个 本地仓库 用于存储内部构建产物。

2. 创建 远程仓库 代理 Maven Central 和其他必要的外部仓库。

3. 创建一个 虚拟仓库，包含所有本地仓库和远程仓库代理，作为 Maven 项目的默认仓库配置。

6.4.3 Artifactory 的 Maven 集成配置

要将 Maven 项目与 Artifactory 集成，主要需要配置两个关键文件：

• settings.xml: Maven 的全局或用户级别配置文件，用于配置 Maven 的全局行为，包括仓库镜像 (mirrors)、认证信息 (servers) 等。

• pom.xml: Maven 项目的项目描述文件，用于配置项目的构建信息，包括依赖管理、构建产物发布配置 (distributionManagement) 等。

6.4.3.1 配置 settings.xml

settings.xml 主要用于配置 Maven 的仓库 镜像 (mirrors) 和 认证信息 (servers)。

1. 配置镜像 (mirrors):

镜像配置允许 Maven 将对特定仓库的请求重定向到另一个仓库。在 Artifactory 的场景下，通常会将对 Maven Central 等公共仓库的请求镜像到 Artifactory 的虚拟仓库，从而实现所有依赖都通过 Artifactory 下载。

在 settings.xml 中添加以下配置：

<settings>
  <mirrors>
    <mirror>
      <id>artifactory-virtual</id>
      <mirrorOf>*</mirrorOf> <url>http://<your-artifactory-domain>/artifactory/virtual-maven</url>
    </mirror>
  </mirrors>
</settings>
​

配置详解:

• <mirror>: 定义一个镜像配置。

• <id>artifactory-virtual</id>: 镜像的唯一 ID，可以自定义。

• <mirrorOf>*</mirrorOf>: 指定要镜像的仓库。* 表示镜像所有仓库，包括 Maven Central 等。也可以指定具体的仓库 ID，例如 central 表示只镜像 Maven Central。

• <url>http://<your-artifactory-domain>/artifactory/virtual-maven</url>: Artifactory 虚拟仓库的 URL。需要替换 <your-artifactory-domain> 为你的 Artifactory 服务器域名或 IP 地址，virtual-maven 为你创建的虚拟仓库的名称。

2. 配置认证信息 (servers):

如果 Artifactory 仓库需要认证才能访问（例如，发布构建产物到本地仓库），需要在 settings.xml 中配置认证信息。

在 settings.xml 中添加以下配置：

<settings>
  <servers>
    <server>
      <id>artifactory-local</id> <username>your-username</username> <password>your-password</password>
    </server>
  </servers>
</settings>
​

配置详解:

• <servers>: 定义服务器认证信息。

• <server>: 定义一个服务器认证配置。

• <id>artifactory-local</id>: 服务器 ID，需要与 pom.xml 中 distributionManagement 配置的仓库 ID 保持一致。

• <username>your-username</username>: Artifactory 用户名。

• <password>your-password</password>: Artifactory 密码。 注意： 生产环境中不建议直接在 settings.xml 中明文存储密码，可以考虑使用 Maven 密码加密功能或环境变量。

6.4.3.2 配置 pom.xml

pom.xml 主要用于配置项目的 构建产物发布 (distributionManagement) 信息。

在 pom.xml 中添加以下配置：

<project>
  ...
  <distributionManagement>
    <repository>
      <id>artifactory-local</id> <url>http://<your-artifactory-domain>/artifactory/local-maven</url>
    </repository>
    <snapshotRepository>
      <id>artifactory-local</id> <url>http://<your-artifactory-domain>/artifactory/local-maven-snapshots</url>
    </snapshotRepository>
  </distributionManagement>
  ...
</project>
​

配置详解:

• <distributionManagement>: 定义构建产物发布配置。

• <repository>: 配置发布 release 版本构建产物的仓库。

  • <id>artifactory-local</id>: 仓库 ID，需要与 settings.xml 中配置的 server 的 id 保持一致，以便 Maven 在发布时使用对应的认证信息。

  • <url>http://<your-artifactory-domain>/artifactory/local-maven</url>: Artifactory 本地仓库的 URL，用于存储 release 版本构建产物。 需要替换 <your-artifactory-domain> 为你的 Artifactory 服务器域名或 IP 地址，local-maven 为你创建的本地仓库的名称。

• <snapshotRepository>: 配置发布 snapshot 版本构建产物的仓库。

  • 配置方式与 <repository> 类似，但 URL 指向用于存储 snapshot 版本构建产物的本地仓库，例如 local-maven-snapshots。

总结 Maven 集成配置步骤:

1. 在 Artifactory 中创建本地仓库、远程仓库和虚拟仓库 (可选)。

2. 在 settings.xml 中配置镜像，将 Maven 仓库请求镜像到 Artifactory 虚拟仓库。

3. 在 settings.xml 中配置认证信息，用于访问需要认证的 Artifactory 仓库 (例如，本地仓库)。

4. 在 pom.xml 中配置 distributionManagement，指定构建产物发布的仓库 (通常是 Artifactory 本地仓库)。

配置完成后，Maven 项目就可以通过 Artifactory 进行依赖管理和构建产物发布了。

6.4.4 Artifactory 的代码实践：常用 Maven 命令

配置好 Artifactory 后，Maven 构建流程与之前基本一致，但依赖下载和构建产物发布都会通过 Artifactory 进行。以下是一些常用的 Maven 命令示例，并结合 Artifactory 进行说明：

1. mvn clean install:

• 作用: 清理项目，编译代码，运行测试，打包项目，并将构建产物安装到 本地 Maven 仓库 (默认是 ~/.m2/repository)。

• Artifactory 影响: 在配置了 Artifactory 镜像后，Maven 下载依赖时会通过 Artifactory 虚拟仓库，如果依赖在 Artifactory 缓存中，下载速度会更快。但 mvn install 命令仍然是将构建产物安装到本地 Maven 仓库，不会发布到 Artifactory。

2. mvn deploy:

• 作用: 清理项目，编译代码，运行测试，打包项目，并将构建产物 发布到远程仓库 (由 pom.xml 的 distributionManagement 配置)。

• Artifactory 影响: 在配置了 distributionManagement 后，mvn deploy 命令会将构建产物发布到 pom.xml 中配置的 Artifactory 本地仓库。如果配置了认证信息，Maven 会使用 settings.xml 中配置的认证信息进行身份验证。

示例：发布 release 版本构建产物到 Artifactory:

假设 pom.xml 和 settings.xml 已经按照 6.4.3 节配置完成。

执行以下命令发布 release 版本构建产物：

mvn deploy
​

Maven 会将构建产物 (例如，JAR 包、POM 文件等) 发布到 pom.xml 中 <repository> 配置的 Artifactory 本地仓库。

示例：发布 snapshot 版本构建产物到 Artifactory:

要发布 snapshot 版本构建产物，需要在 pom.xml 中修改版本号为 snapshot 版本 (例如，1.0.0-SNAPSHOT)，然后执行 mvn deploy 命令。

Maven 会将构建产物发布到 pom.xml 中 <snapshotRepository> 配置的 Artifactory 本地仓库。

3. mvn dependency:tree:

• 作用: 显示项目的依赖树。

• Artifactory 影响: 依赖树的信息仍然是从 Maven 解析的项目依赖关系中生成的，但由于依赖是通过 Artifactory 下载的，因此依赖来源实际上是 Artifactory 虚拟仓库。

4. mvn dependency:get:

• 作用: 下载指定的依赖到本地 Maven 仓库。

• Artifactory 影响: 依赖下载会通过 Artifactory 虚拟仓库。

总结常用 Maven 命令与 Artifactory 的关系：

• mvn clean install: 依赖下载通过 Artifactory，但构建产物安装到本地仓库。

• mvn deploy: 依赖下载通过 Artifactory，构建产物发布到 Artifactory 本地仓库。

• mvn dependency:*: 依赖操作会通过 Artifactory 下载依赖信息。

6.4.5 Artifactory 的高级功能：构建晋升 (Build Promotion)

Artifactory 不仅仅是一个仓库，它还提供了许多高级功能，其中 构建晋升 (Build Promotion) 是一个非常重要的特性，尤其在企业级软件开发中。

构建晋升 指的是将构建产物从一个仓库 (例如，开发环境仓库) 移动或复制到另一个仓库 (例如，测试环境仓库、生产环境仓库) 的过程，通常伴随着状态的变更和元数据的更新。构建晋升旨在管理软件交付流程，确保只有经过充分测试和验证的构建产物才能最终发布到生产环境。

构建晋升的流程通常如下：

图 6.4.5-1：Artifactory 构建晋升流程图

构建晋升的步骤通常包括：

1. 构建部署到开发环境仓库: CI/CD 系统 (例如，Jenkins) 构建完成后，将构建产物发布到 Artifactory 的 开发环境仓库 (Dev Repository)。

2. 测试和验证: 在开发环境或测试环境对构建产物进行测试和验证。

3. 晋升到测试环境仓库: 如果测试通过，将构建产物从开发环境仓库 晋升 (Promote) 到 测试环境仓库 (Test Repository)。晋升操作可以复制或移动构建产物，并更新构建产物的元数据，例如添加 "测试通过" 标签。

4. 集成测试和验证: 在集成测试环境对构建产物进行更全面的测试和验证。

5. 晋升到准生产环境仓库: 如果集成测试通过，将构建产物从测试环境仓库晋升到 准生产环境仓库 (Staging Repository)。

6. UAT 测试和最终验证: 在准生产环境进行用户验收测试 (UAT) 和最终验证。

7. 晋升到生产环境仓库: 如果 UAT 测试通过，将构建产物从准生产环境仓库晋升到 生产环境仓库 (Production Repository)。

8. 发布到生产环境: 从生产环境仓库部署构建产物到生产环境。

Artifactory 构建晋升的优势：

• 流程化管理: 规范化软件交付流程，确保构建产物经过多层验证。

• 环境隔离: 不同环境使用不同的仓库，避免环境之间的干扰。

• 版本追溯: 清晰记录构建产物的晋升路径和状态。

• 自动化集成: 可以与 CI/CD 工具集成，实现自动化构建晋升流程。

Artifactory 构建晋升的实践:

Artifactory 提供了多种方式进行构建晋升，包括：

• 手动晋升: 通过 Artifactory Web UI 手动选择构建并进行晋升操作。

• REST API 晋升: 通过 Artifactory REST API 自动化构建晋升流程，可以集成到 CI/CD 脚本中。

• Artifactory CLI 晋升: 使用 Artifactory 命令行工具进行构建晋升。

• 插件集成: 使用 Artifactory 提供的 Maven 插件或其他构建工具插件进行构建晋升。

示例：使用 Artifactory REST API 进行构建晋升 (假设使用 curl 命令):

假设要将构建 my-app:1.0.0 从 dev-maven-local 仓库晋升到 test-maven-local 仓库，并添加 "tested" 状态。

curl -u <username>:<password> -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "targetRepo": "test-maven-local",
    "buildName": "my-app",
    "buildNumber": "1.0.0",
    "status": "tested",
    "copy": true,
    "artifacts": true,
    "dependencies": true
  }' \
  "http://<your-artifactory-domain>/artifactory/api/build/promote"
​

代码详解:

• -u <username>:<password>: Artifactory 认证信息。

• -X POST: 使用 POST 请求。

• -H "Content-Type: application/json": 指定请求头为 JSON 格式。

• -d '{...}': 请求体，JSON 格式，包含晋升参数：

  • targetRepo: 目标仓库名称 (test-maven-local)。

  • buildName: 构建名称 (my-app)。

  • buildNumber: 构建版本号 (1.0.0)。

  • status: 晋升状态 (tested)。

  • copy: 是否复制构建产物 (true 表示复制，false 表示移动)。

  • artifacts: 是否晋升构建产物 (true)。

  • dependencies: 是否晋升依赖 (true)。

• "http://<your-artifactory-domain>/artifactory/api/build/promote": Artifactory 构建晋升 API 端点。

通过构建晋升功能，Artifactory 可以更好地支持企业级的软件交付流程，提高软件质量和发布效率。

6.4.6 Artifactory 的其他重要功能

除了上述核心功能和构建晋升，Artifactory 还提供了许多其他重要的功能，进一步增强了其作为 Maven 仓库管理器的能力：

• 权限管理 (Security): 提供完善的权限管理系统，可以控制用户和用户组对仓库的访问权限，包括读取、写入、删除、管理等操作。支持多种认证方式，包括本地用户、LDAP、Active Directory 等。

• 搜索功能 (Search): 提供强大的搜索功能，可以根据各种元数据 (groupId, artifactId, version, properties, checksum 等) 快速定位到需要的构建产物。支持 Web UI 搜索和 REST API 搜索。

• 元数据管理 (Metadata Management): 自动提取和管理 Maven 构建产物的元数据，例如 POM 文件信息、依赖关系、构建信息等。用户可以自定义元数据，方便进行更精细化的管理和搜索。

• 存储管理 (Storage Management): 支持多种存储后端，包括本地文件系统、云存储 (AWS S3, Azure Blob Storage, Google Cloud Storage) 等。提供存储配额管理、存储清理策略等功能，优化存储空间利用率。

• 复制和同步 (Replication and Synchronization): 支持仓库复制和同步功能，可以将仓库内容复制到另一个 Artifactory 实例，实现异地备份、灾难恢复、多数据中心部署等场景。

• 插件和扩展 (Plugins and Extensions): Artifactory 提供了丰富的插件和扩展机制，可以扩展其功能，例如支持新的包格式、集成新的工具、自定义业务逻辑等。

• 高可用和集群 (High Availability and Clustering): 支持集群部署，提供高可用性和可扩展性，满足大型团队和高负载场景的需求。

6.4.7 总结：Artifactory 在 Maven 生态系统中的价值

Artifactory 作为 Maven 生态系统中的关键组件，为团队带来了巨大的价值：

• 提升开发效率: 集中化的仓库管理，加速依赖下载，简化仓库配置，提高开发效率。

• 提高构建速度: 远程仓库代理和本地缓存，减少对外部网络的依赖，加速构建速度。

• 增强安全性: 细粒度的权限管理，保护构建产物的安全性和合规性。

• 改善协作效率: 统一的仓库平台，方便团队成员共享和协作。

• 提升软件质量: 构建晋升流程，规范化软件交付流程，提高软件质量。

• 降低维护成本: 集中化管理，简化运维工作，降低维护成本。

对于任何规模的 Maven 项目，尤其是企业级项目和团队协作项目，引入 Artifactory 都是一个明智的选择。它可以帮助团队构建更健壮、高效且可管理的 Maven 生态系统，最终提升软件交付能力和业务价值。

希望本章节能够帮助读者深入理解 Artifactory 在 Maven 生态系统中的作用和价值，并能够在实际项目中有效地应用 Artifactory。