标签

所有目标都恰好属于一个软件包。目标的名称称为其标签。每个标签唯一标识目标。规范形式的典型标签如下所示:

@myrepo//my/app/main:app_binary

标签的第一部分是代码库名称 @myrepo//。在典型的情况下,标签是指使用它的代码库,代码库标识符可以缩写为 //。因此,在 @myrepo 内,此标签通常写为

//my/app/main:app_binary

标签的第二部分是非限定软件包名称 my/app/main,是软件包相对于代码库根目录的路径。代码库名称和非限定软件包名称共同构成了完全限定软件包名称 @myrepo//my/app/main。当标签引用其使用的同一软件包时,可省略软件包名称(也可以省略英文冒号)。因此,在 @myrepo//my/app/main 内,此标签可通过以下任一方式编写:

app_binary
:app_binary

按照惯例,对于文件,系统会省略英文冒号,但系统会为规则保留英文冒号,但这在其他方面没有意义。

冒号后面的标签部分 app_binary 是非限定目标名称。当它与软件包路径的最后一个组成部分匹配时,该组成部分和冒号可以省略。因此,以下两个标签是等效的:

//my/app/lib
//my/app/lib:lib

软件包子目录中的文件目标名称是文件相对于软件包根目录(包含 BUILD 文件的目录)的路径。因此,此文件位于代码库的 my/app/main/testdata 子目录中:

//my/app/main:testdata/input.txt

//my/app@some_repo//my/app 等字符串具有两种含义,具体取决于使用它们的上下文:当 Bazel 需要标签时,它们分别表示 //my/app:app@some_repo//my/app:app。但是,当 Bazel 需要软件包时(例如在 package_group 规范中),它们会引用包含该标签的软件包。

BUILD 文件中的一个常见错误是使用 //my/app 引用软件包,或引用软件包中的所有目标,但这并非如此。请注意,它等同于 //my/app:app,因此它会在当前代码库的 my/app 软件包中命名 app 目标。

不过,在 package_group.bzl 文件中的规范中建议使用 //my/app 引用软件包,因为它明确地传达了软件包名称是绝对的且位于工作区的顶层目录中。

相对标签不能用于引用其他软件包中的目标;在这种情况下,必须始终指定代码库标识符和软件包名称。例如,如果源代码树同时包含软件包 my/app 和软件包 my/app/testdata(这两个目录都有自己的 BUILD 文件),则后一个软件包会包含名为 testdepot.zip 的文件。您可以通过以下两种方式在 //my/app:BUILD 中引用此文件:一种错误,一种正确:

错误 - testdata 是不同的软件包,因此您无法使用相对路径

testdata/testdepot.zip

正确 - 请参阅 testdata 及其完整路径

//my/app/testdata:testdepot.zip

@// 开头的标签是对主代码库的引用,主代码库即使在外部代码库中也仍然有效。因此,从外部代码库引用时,@//a/b/c//a/b/c 不同。前者是指主仓库,而后者是指在外部仓库本身中查找 //a/b/c。在主代码库中编写引用主代码库中的目标的规则时,这点尤为重要,并且将用于外部代码库。

如需了解引用目标的不同方式,请参阅目标模式

标签的词汇规范

标签语法不建议使用对 shell 具有特殊含义的元字符。这有助于避免无意中引出问题,并可让您更轻松地构建操作标签的工具和脚本(如 Bazel 查询语言)。

下面详细说明了允许使用的目标名称。

目标名称 - package-name:target-name

target-name 是软件包中目标的名称。规则的名称是 BUILD 文件中规则声明的 name 属性的值;文件的名称是相对于包含 BUILD 文件的目录的路径名。

目标名称必须完全由从 a-zA-Z0-9 集合以及标点符号 !%-@^_"#$&'()*-+,;<=>?[]{|}~/. 中绘制的字符组成。

文件名必须是正常格式的相对路径名,也就是说,文件名不得以斜杠开头或结尾(例如禁止使用 /foofoo/),也不得包含多个连续斜杠作为路径分隔符(例如 foo//bar)。同样,禁止使用高级引用 (..) 和当前目录引用 (./)。

错误 - 请勿使用“..”引用其他软件包中的文件

正确 - 请使用 `//package-name:filename`

虽然在文件目标的名称中通常会使用 /,但请避免在规则名称中使用 /。特别是在使用标签的简写形式时,它可能会使读者感到困惑。标签 //foo/bar/wiz 始终是 //foo/bar/wiz:wiz 的简写,即使没有此类软件包 foo/bar/wiz;它绝不会引用 //foo:bar/wiz,即使该目标存在也是如此。

但是,在某些情况下,使用斜杠很方便,有时甚至有必要。例如,某些规则的名称必须与其主源文件一致,该文件可能位于软件包的子目录中。

软件包名称 - //package-name:target-name

软件包的名称是包含其 BUILD 文件的目录的名称,相对于所含代码库的顶级目录而言。例如:my/app

软件包名称必须完全由从 A-Za-z0-9、“/”“-”“.”“@”和“_”集合中绘制的字符组成,并且不能以正斜线开头。

如果语言的目录结构对其模块系统非常重要(例如 Java),请务必选择该语言中有效标识符的目录名称。

虽然 Bazel 支持工作区根软件包中的目标(例如 //:foo),但最好将该软件包留空,以便所有有意义的软件包都具有描述性名称。

软件包名称不得包含子字符串 //,也不得以斜杠结尾。

规则

规则指定了输入和输出之间的关系以及构建输出的步骤。规则可以是多种不同类型中的一种(有时称为规则类),这类类会生成经过编译的可执行文件和库、测试可执行文件以及其他受支持的输出,如构建百科全书中所述。

BUILD 文件通过调用规则来声明目标。

在下面的示例中,我们会看到使用 cc_binary 规则声明的目标 my_app

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    deps = [
        "//absl/base",
        "//absl/strings",
    ],
)

每个规则调用都有一个 name 属性(必须是有效的目标名称),用于在 BUILD 文件的软件包中声明目标。

每条规则都有一组属性;适用于给定规则的属性,以及每个属性的重要性和语义都是规则类型的函数;如需查看规则及其对应属性的列表,请参阅构建百科全书每个属性都有一个名称和类型。属性可以具有的一些常见类型包括整数、标签、标签列表、字符串、字符串列表、输出标签、输出标签列表。并非每个规则都需要指定所有属性。因此,属性构成了一个从键(名称)到可选的类型值的字典。

许多规则中的 srcs 属性具有“list of labels”类型;其值(如果存在)是一个标签列表,每个标签都是该规则的输入目标的名称。

在某些情况下,规则种类的名称有些随机,更有趣的是规则生成的文件的名称,这也适用于 Genrule。如需了解详情,请参阅一般规则:genrule

在其他情况下,该名称很重要:例如,对于 *_binary*_test 规则,规则名称决定了 build 生成的可执行文件的名称。

这个目标的有向无环图称为目标图或构建依赖关系图,也是 Bazel 查询工具在其上运行的域。

目标 构建文件