BUILD.bazel 文件样式指南和最佳实践

概览

Fuchsia 项目遵循官方 Bazel BUILD 样式指南,但有少数例外情况。本页面上的指导是对常见 Bazel 样式指南和最佳实践的补充。

本页是 Bazel 样式指南和最佳实践的一部分。

公开范围

避免使用软件包 default_visibility

最好为必须在软件包外部访问的每个目标指定可见性,而不是声明软件包 default_visibility。一般来说,如果目标定义中指定了可见性,则 BUILD.bazel 文件会更易于理解。此外,使用 default_visibility 意味着私有目标默认具有一定程度的公开可见性。

default_visibility 仅应在极少数情况下使用,即 BUILD.bazel 文件中的每个目标(无论是现在还是将来)都应具有相同的可见性。这意味着 BUILD.bazel 文件中未定义任何私有辅助目标。例如,当定义了许多 widget,并且它们都需要对另一个软件包(目录)中的 widget 加载器或 widget 测试可见时。

请勿将 default_visibility 用于 //visibility:public 和其他广泛的可见性,例如 //:__subpackages__ 或 //src:__subpackages__。

在 GN 方面,在 BUILD.bazel 文件中使用 default_visibility = [...] 相当于将 visibility = [...] 放在 BUILD.gn 文件的顶部。在这两种情况下,您都需要确保为每个内部目标指定私有 visibility。

目标可见性

概览

在 Bazel 中:

  • 可见性是在软件包(目录)级别。无法将可见性限制为同一软件包或另一软件包中的特定目标。

    • 如果需要这样做,请考虑将目标重构为可单独引用的子目录。
  • 目标默认情况下是 package-private,这意味着它们对同一软件包(BUILD.bazel 文件)中的其他目标可见。

    • 这相当于 visibility = [ ":__pkg__" ]。

    • 虽然可以扩大可见性(见下文),但无法阻止同一软件包(BUILD.bazel 文件)中的其他目标使用。

    • 如果需要这样做,请考虑将其他目标重构到子目录中。

  • 必须指定目标 visibility,以便在定义它们的软件包(目录)之外访问它们。

对于熟悉 GN
  • Bazel 目标默认是私有的,而 GN 目标默认是公开的。

    • BUILD.bazel 文件中的默认可见性相当于在每个 BUILD.gn 文件的顶部放置 visibility = [":*"]。
  • ...:__pkg__ 相当于 "...:*"

  • ...:__subpackages__ 相当于 ".../*"

  • 在 Bazel 中,目标始终对同一软件包(目录)中的其他目标可见,并且无法更改此行为。

    • 在 GN 中,这相当于 visibility 始终包含 ":*"。

    • 当 bazel2gn 用于具有相互依赖的目标的 BUILD.bazel 文件时,即使 Bazel 不需要,您可能也需要将 ":__pkg__", 显式添加到 BUILD.bazel 文件中的 visibility。

    • 添加此类条目时,请添加引用 bazel2gn 的注释,以便在移除 GN 目标时移除这些条目。

为每个目标使用适当的可见性

每个目标的 visibility 都应尽可能缩小范围。

请勿使用公开可见性 ("//visibility:public")。对于确实打算在整个代码库中使用的非常常见的目标,"//:__subpackages__" 是合适的字符串。不过,最好指定几个顶级目录(例如 ["//sdk/lib:__subpackages__", "//src:__subpackages__"])。

请根据需要使用 __pkg__ 和 __subpackages__。

如果需要软件包或私享公开范围,请省略 visibility 属性,因为这是默认设置。

非显式目标类型的可见性

config_setting() 和 exports_files() 支持与其他任何目标一样的可见性,只是它们默认是公开的。即使 Bazel 不要求,也要始终为这些指定 visibility。