Bazel Skylib安装与使用指南

Bazel Skylib是一个强大的Starlark库，旨在提供给Bazel用户一系列实用功能，包括集合操作、路径处理、单元测试等功能。下面我们将详细介绍如何理解和使用这个项目。

1. 项目目录结构及介绍

Bazel Skylib的项目结构精心设计，便于扩展和维护：

• lib: 核心模块所在目录，每个.bzl文件定义了一个“模块”，包含了相关联的函数或符号，方便作为单个单位加载。

  • collections.bzl: 集合操作函数。
  • dicts.bzl, partial.bzl, paths.bzl, 等等：分别处理字典、部分应用、路径管理等。

• rules: 包含自定义的构建规则，如analysis_test, build_test等，增强Bazel的测试能力。

• tests: 单元测试，用于确保库中提供的各项功能正确无误。

• WORKSPACE, MODULE.bazel: 项目的外部依赖配置与Bzlmod设置文件，引导其他项目如何引入本库。

• docs: 文档和说明，帮助开发者理解如何使用这些库和规则。

• examples (虽然在引用内容中未直接提及，但通常此类项目会有示例目录): 可能包含使用Skylib功能的实例代码，帮助快速上手。

2. 项目的启动文件介绍

对于Bazel项目，没有传统意义上的“启动文件”。然而，要开始使用Bazel Skylib，关键在于将它集成到你的Bazel工作区中。这主要通过修改两个文件实现：

• WORKSPACE（或MODULE.bazel）: 引入Skylib作为依赖。早期版本通常通过HTTP Archive的方式添加依赖：

  http_archive(
      name = "bazel_skylib",
      urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/..."],
      sha256 = "...",
  )
  

  对于支持Bzlmod的新版Bazel，则在MODULE.bazel中加入：

  bazel_dep(name = "bazel_skylib", version = "特定版本号")
  

• 若使用了2018年12月后发布的unittest.bzl，还需在WORKSPACE文件中加载bazel_skylib_workspace()。

3. 项目的配置文件介绍

• WORKSPACE 文件是Bazel工作区的配置中心，用于声明外部依赖。通过上述步骤，我们在其中添加对Bazel Skylib的引用。

• BUILD 和 *.bzl 文件：在你的项目中，通过load语句引用Skylib的模块，例如：

  load("@bazel_skylib//lib:paths.bzl", "paths")
  load("@bazel_skylib//lib:shell.bzl", "shell")
  

  这样就可以在你的构建逻辑中使用Skylib提供的功能了。

• .bzlmod 或 MODULE.bazel （适用于Bazel 5及以上版本）: 新型的依赖管理系统，简化了模块间的依赖声明方式，使得引入如Bazel Skylib这样的外部库变得更加直接。

为了成功集成并利用Bazel Skylib的功能，确保遵循其最新文档中的指导原则，并注意不同Bazel版本可能需要的特殊配置。这样，你就能充分利用Skylib来提升你的Bazel构建脚本的灵活性和效率。