共享变量

报告问题 查看源代码 每夜 build · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

BUILD 文件应当具有简单的声明性。它们通常由一系列目标声明组成。随着代码库和 BUILD 文件变大,您可能会注意到一些重复内容,例如:

cc_library(
  name = "foo",
  copts = ["-DVERSION=5"],
  srcs = ["foo.cc"],
)

cc_library(
  name = "bar",
  copts = ["-DVERSION=5"],
  srcs = ["bar.cc"],
  deps = [":foo"],
)

BUILD 文件中的代码重复通常没有问题。这可以提高文件的可读性:每个声明都无需任何上下文即可阅读和理解。这不仅对人类来说很重要,对外部工具也很重要。例如,某个工具或许能够读取和更新 BUILD 文件,以添加缺少的依赖项。代码重构和代码重用可以阻止这种自动修改。

如果共享值很有用(例如,如果值必须保持同步),您可以引入变量:

COPTS = ["-DVERSION=5"]

cc_library(
  name = "foo",
  copts = COPTS,
  srcs = ["foo.cc"],
)

cc_library(
  name = "bar",
  copts = COPTS,
  srcs = ["bar.cc"],
  deps = [":foo"],
)

多个声明现在使用值 COPTS。按照惯例,使用大写字母来命名全局常量。

在多个 BUILD 文件中共享变量

如果您需要在多个 BUILD 文件中共享某个值,则必须将其放在 .bzl 文件中。.bzl 文件包含可在 BUILD 文件中使用的定义(变量和函数)。

path/to/variables.bzl 中,编写以下代码:

COPTS = ["-DVERSION=5"]

然后,您可以更新 BUILD 文件以访问该变量:

load("//path/to:variables.bzl", "COPTS")

cc_library(
  name = "foo",
  copts = COPTS,
  srcs = ["foo.cc"],
)

cc_library(
  name = "bar",
  copts = COPTS,
  srcs = ["bar.cc"],
  deps = [":foo"],
)