函数

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

目录

包裹

package(default_deprecation, default_testonly, default_visibility, features)

此函数声明适用于软件包中每条后续规则的元数据。它最多只能在一个软件包(BUILD 文件)中使用一次。

package() 函数应立即在文件顶部的所有 load() 语句之后、任何规则之前调用。

参数

属性 说明
default_visibility

List of labels; optional

此软件包中规则的默认可见性。

除非在规则的 visibility 属性中另行指定,否则此软件包中的每个规则都会在此属性中指定可见性。如需详细了解此属性的语法,请参阅可见性文档。 软件包的默认可见性不适用于 exports_files(默认情况下是公开的)。

default_deprecation

String; optional

设置此软件包中所有规则的默认 deprecation 消息。

default_testonly

Boolean; optional; default is False except as noted

为该软件包中的所有规则设置默认 testonly 属性。

javatests 下的软件包中,默认值为 1。

features

List strings; optional

设置会影响此 BUILD 文件语义的各种标志。

此功能主要供构建构建系统的人员用于标记需要执行某种特殊处理的软件包。除非有构建系统的开发者明确请求,否则请勿使用此属性。

示例

以下声明声明此软件包中的规则仅对软件包组 //foo:target 的成员可见。针对规则的个别可见性声明(如果存在)会替换此规范。
package(default_visibility = ["//foo:target"])

package_group

package_group(name, packages, includes)

此函数定义一组软件包,并将标签与这组标签相关联。该标签可以在 visibility 属性中引用。

软件包组主要用于可见性控制。可从源代码树中的每个软件包引用可公开查看的目标。不公开可见的目标只能在自己的软件包(而非子软件包)中引用。在这些极端情况下,目标可以允许访问自己的软件包,以及一个或多个软件包组描述的任何软件包。如需详细了解可见性系统,请参阅可见性属性。

如果给定软件包与 packages 属性匹配,或者已包含在 includes 属性中提及的其他软件包组中,则会被视为在该组中。

从技术上来讲,软件包组不是由规则创建的,本身就没有任何可见性保护。

参数

属性 说明
name

Name; required

此定位条件的唯一名称。

packages

List of strings; optional

零个或多个软件包规范的列表。

每个软件包规范字符串都可以采用以下格式之一:

  1. 软件包的全名(不带代码库),以双斜杠开头。例如,//foo/bar 指定具有该名称的软件包,并且该软件包与软件包组位于同一代码库中。
  2. 同上,但结尾为 /...。例如, //foo/... 指定 //foo 集及其所有子软件包。//... 指定当前代码库中的所有软件包。
  3. 字符串 publicprivate,分别用于指定每个软件包或未指定软件包。(此表单要求设置 --incompatible_package_group_has_public_syntax 标志。)

此外,前两种软件包规范也可以添加前缀 - 来指示它们已被否定。

该软件包组包含至少符合一个正向规范但与其所有否定规范都不匹配的软件包。例如,值 [//foo/..., -//foo/tests/...] 包括 //foo 的所有子软件包,这些子软件包也不是 //foo/tests 的子软件包。(//foo 本身已包含在内,而 //foo/tests 本身不包括在内。)

除了公开可见性之外,无法直接指定当前代码库之外的软件包。

如果缺少此属性,则等同于将其设为一个空列表,这与将其设置为仅包含 private 的列表相同。

注意:规范 //... 的旧版行为与 public 相同。启用 --incompatible_fix_package_group_reporoot_syntax 后,此行为会被停用。

注意:此属性作为 bazel query --output=proto(或 --output=xml)的一部分进行序列化时,如果未启用 --incompatible_package_group_includes_double_slash,系统会省略前导斜杠。例如,//pkg/foo/... 将输出为 \"pkg/foo/...\"

includes

List of labels; optional

此软件包中包含的其他软件包组。

此属性中的标签必须引用其他软件包组。 引用的软件包组中的软件包是此软件包组的一部分。这是传递性的 - 如果软件包组 a 包含软件包组 b,且 b 包含软件包组 c,那么 c 中的每个软件包也都将是 a 的成员。

请注意,与否定软件包规范结合使用时,系统会先独立计算每个组的软件包集合,然后将结果结合在一起。这意味着,一个组中的否定规范不会影响另一个组中的规范。

示例

以下 package_group 声明指定了一个名为“热带”的软件包组,其中包含热带水果。

package_group(
    name = "tropical",
    packages = [
        "//fruits/mango",
        "//fruits/orange",
        "//fruits/papaya/...",
    ],
)

以下声明指定了虚构应用的软件包组:

package_group(
    name = "fooapp",
    includes = [
        ":controller",
        ":model",
        ":view",
    ],
)

package_group(
    name = "model",
    packages = ["//fooapp/database"],
)

package_group(
    name = "view",
    packages = [
        "//fooapp/swingui",
        "//fooapp/webui",
    ],
)

package_group(
    name = "controller",
    packages = ["//fooapp/algorithm"],
)

导出文件

exports_files([label, ...], visibility, licenses)

exports_files() 用于指定属于此软件包且导出到其他软件包的文件列表。

只有在使用 exports_files() 语句明确导出属于其他软件包的源文件时,该软件包的 build 文件才能直接引用它们。详细了解文件的公开范围

作为一种旧版行为,也会在提到 --incompatible_no_implicit_file_export 标志被翻转之前,以默认可见性导出被提及为规则的文件。但是,不应依赖于此行为,并且不应主动迁移。

参数

参数是当前软件包中的文件名列表。您还可以指定可见性声明;在这种情况下,文件将对指定的目标可见。如果未指定可见性,则文件将在每个软件包中可见,即使在 package 函数中指定软件包的默认可见性也是如此。您还可以指定许可

示例

以下示例从 test_data 软件包中导出一个 golden.txt 文件,以便其他软件包可以使用它,例如在测试的 data 属性中使用该文件。

# from //test_data/BUILD

exports_files(["golden.txt"])

glob

glob(include, exclude=[], exclude_directories=1, allow_empty=True)

Glob 是一个辅助函数,用于查找与特定路径模式匹配的所有文件,并返回其路径的新可变排序列表。Glob 仅在其自己的软件包中搜索文件,并且仅查找源文件(而非生成的文件和其他目标)。

如果源文件的相对路径与任意 include 格式匹配,但不符合任何 exclude 格式,则结果中会包含源文件的标签。

includeexclude 列表包含相对于当前软件包的路径模式。每个模式都可能由一个或多个路径段组成。与通常的 Unix 路径一样,这些段由 / 分隔。段可以包含 * 通配符:这会匹配路径段中的任何子字符串(甚至包括空子字符串),不包括目录分隔符 /。此通配符可在一个路径段中多次使用。此外,** 通配符可以匹配零个或更多个完整路径段,但必须将其声明为独立的路径段。

示例:
  • foo/bar.txt 与此软件包中的 foo/bar.txt 文件完全匹配
  • 如果文件以 .txt 结尾,则 foo/*.txt 会匹配 foo/ 目录中的每个文件(除非 foo/ 是子软件包)
  • foo/a*.htm* 匹配 foo/ 目录中以 a 开头的每个文件,接着是任意字符串(可以为空),然后是 .htm,最后是另一个任意字符串;例如 foo/axx.htmfoo/a.htmlfoo/axxx.html
  • **/a.txt 与此软件包的每个子目录中的每个 a.txt 文件匹配
  • 如果生成的路径中至少有一个目录名为 bar,例如 **/bar/**/*.txtbar/a.txt(请注意,** 也匹配零个段)或 bar/zzz/a.txt,则 **/bar/**/*.txt 会与此软件包的每个子目录中的每个 .txt 文件匹配。
  • ** 与此软件包的每个子目录中的每个文件匹配
  • foo**/a.txt 是无效格式,因为 ** 必须作为一个独立的细分

如果启用了 exclude_directories 参数(设置为 1),则结果中将省略类型为目录的文件(默认为 1)。

如果 allow_empty 参数设置为 False,则 glob 函数在返回结果时会是空列表时发生错误。

有一些重要限制和注意事项:

  1. 由于 glob() 在 BUILD 文件评估期间运行,因此 glob() 只会匹配源代码树中的文件,而不会匹配生成的文件。如果您要构建同时需要源文件和生成的文件的目标,则必须将生成的文件的明确列表附加到 glob。请参阅下面的示例,了解 :mylib:gen_java_srcs

  2. 如果规则与匹配的源文件同名,则规则将“影子”文件。

    请注意,glob() 会返回路径列表,因此在其他规则(例如 srcs = glob(["*.cc"]))规则中使用 glob() 与明确列出匹配路径具有相同的效果。例如,如果 glob() 会生成 ["Foo.java", "bar/Baz.java"],但软件包中还有一条名为“Foo.java”的规则(虽然 Bazel 对此有所警告),那么 glob() 的使用方将使用“Foo.java”规则(其输出),而不是“Foo.java”文件。如需了解详情,请参阅 GitHub 问题 10395

  3. glob 可能与子目录中的文件匹配。子目录名称可以采用通配符。不过...
  4. 不允许标签超出软件包边界,并且 glob 与子软件包中的文件不匹配。

    例如,如果 x/y 以软件包的形式存在(作为 x/y/BUILD 或位于软件包路径上的其他位置),则软件包 x 中的 glob 表达式 **/*.cc 不会包含 x/y/z.cc。这意味着 glob 表达式的结果实际上取决于是否存在 BUILD 文件;也就是说,如果没有名为 x/y 的软件包或者使用 --deleted_packages 标记将其标记为已删除,则同一 glob 表达式将包含 x/y/z.cc

  5. 上述限制适用于所有 glob 表达式,无论它们使用哪种通配符。
  6. 文件名以 . 开头的隐藏文件将由 *** 通配符完全匹配。如果要将隐藏文件与复合模式匹配,则模式必须以 . 开头。例如,*.*.txt 将匹配 .foo.txt,但 *.txt 不会匹配。 隐藏目录的匹配方式也与之相同。隐藏的目录可能包含不需要的输入文件,并且可能会增加不必要的 glob 文件和内存消耗量。如需排除隐藏目录,请将其添加到“排除”列表参数中。
  7. “**”通配符有一种极端情况:模式 "**" 与软件包的目录路径不匹配。也就是说,glob(["**"], exclude_directories = 0) 会严格匹配当前软件包目录下的所有文件和目录(但当然不会进入子软件包的目录 - 请参阅前面的有关说明)。

一般来说,对于 glob 模式,您应该尝试提供适当的扩展(例如 *.html),而不是使用裸 #*9.;'。更明确的名称既是自行记录的名称,又可确保您不会意外匹配备份文件或 emacs/vi/... 自动保存文件。

编写构建规则时,您可以枚举 glob 的元素。例如,这样可以为每个输入生成单独的规则。请参阅下面的扩展的 glob 示例部分。

Glob 示例

创建一个通过此目录中的所有 Java 文件以及通过 :gen_java_srcs 规则生成的所有文件构建的 Java 库。

java_library(
    name = "mylib",
    srcs = glob(["*.java"]) + [":gen_java_srcs"],
    deps = "...",
)

genrule(
    name = "gen_java_srcs",
    outs = [
        "Foo.java",
        "Bar.java",
    ],
    ...
)

在目录中添加除 testal.txt 之外的所有 txt 文件。 请注意,测试数据子目录中的文件不会包含在内。如果要包含这些文件,请使用递归 glob (**)。

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(
        ["testdata/*.txt"],
        exclude = ["testdata/experimental.txt"],
    ),
)

递归 Glob 示例

让测试依赖于 testdata 目录及其所有子目录(及其子目录等)中的所有 txt 文件。 包含 BUILD 文件的子目录将被忽略。(请参阅上文的限制和注意事项。)

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(["testdata/**/*.txt"]),
)

创建一个库,从此目录中的所有 Java 文件以及所有子目录(库的路径中包括一个名为 testing 的子目录除外)构建。请尽量避免这种模式,因为它可以减少构建增量,进而延长构建时间。

java_library(
    name = "mylib",
    srcs = glob(
        ["**/*.java"],
        exclude = ["**/testing/**"],
    ),
)

扩展的 Glob 示例

在当前目录中为 *_test.cc 创建单个 Genrule,以统计文件中的行数。

# Conveniently, the build language supports list comprehensions.
[genrule(
    name = "count_lines_" + f[:-3],  # strip ".cc"
    srcs = [f],
    outs = ["%s-linecount.txt" % f[:-3]],
    cmd = "wc -l $< >$@",
 ) for f in glob(["*_test.cc"])]

如果上面的 BUILD 文件位于软件包 //foo 中,并且软件包中包含三个匹配的文件(a_test.cc、b_test.cc 和 c_test.cc),则运行 bazel query '//foo:all' 时会列出已生成的所有规则:

$ bazel query '//foo:all' | sort
//foo:count_lines_a_test
//foo:count_lines_b_test
//foo:count_lines_c_test

select

select(
    {conditionA: valuesA, conditionB: valuesB, ...},
    no_match_error = "custom message"
)

select() 是一个辅助函数,用于将规则属性设为可配置。它可以替换几乎任何特性分配的右侧,因此其值取决于命令行 Bazel 标志。例如,您可以使用此方法来定义平台专用依赖项,或根据规则是在“开发者”模式还是在“发布”模式下构建的,嵌入不同的资源。

基本用法如下:

sh_binary(
    name = "mytarget",
    srcs = select({
        ":conditionA": ["mytarget_a.sh"],
        ":conditionB": ["mytarget_b.sh"],
        "//conditions:default": ["mytarget_default.sh"]
    })
)

这使得 sh_binarysrcs 属性可以配置,方法是将其正常标签列表分配替换为 select 调用,后者将配置条件映射到匹配的值。每个条件都是对 config_settingconstraint_value 的标签引用,如果目标配置与预期的一组值匹配,则“匹配”这两个标签。然后,mytarget#srcs 的值将成为与当前调用匹配的标签列表。

备注:

  • 任何调用都只选择一个条件。
  • 如果有多个条件匹配,并且其中一个条件是其他条件的专用项,则优先考虑其他方面。如果条件 B 具有与 A 相同的所有标记和约束值,加上一些其他标志或约束条件值,则条件 B 会被视为条件 A 的特例。这也意味着专精领域解决方案不会用于创建排序,如下面的示例 2 所示。
  • 如果有多个条件匹配,并且其中一个条件不是所有其他条件的专用项,则 Bazel 会失败并显示错误。
  • 如果没有其他条件匹配,则特殊伪标签 //conditions:default 会被视为匹配。如果遗漏了此条件,则其他一些规则必须匹配才能避免错误。
  • select 可以嵌入在更大的属性分配中。因此,srcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...}) srcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]}) 是有效表达式。
  • select 适用于大多数(但并非全部)属性。不兼容的属性在各自的文档中带有 nonconfigurable 标记。

    子软件包

    subpackages(include, exclude=[], allow_empty=True)

    subpackages() 是一个辅助函数,类似于 glob(),其中会列出子软件包而不是文件和目录。它使用与 glob() 相同的路径模式,并且可以匹配属于当前加载的 BUILD 文件的直接后代的任何子软件包。如需详细了解包含模式和排除模式,请参阅 glob

    返回的子软件包列表按排序顺序排序,包含相对于当前加载软件包的路径,这些软件包与 include 中的指定模式匹配,但不匹配 exclude 中的模式。

    示例

    以下示例列出了软件包 foo/BUILD 的所有直接子软件包

    # The following BUILD files exist:
    # foo/BUILD
    # foo/bar/baz/BUILD
    # foo/sub/BUILD
    # foo/sub/deeper/BUILD
    #
    # In foo/BUILD a call to
    subs = subpackages(include = ["**"])
    
    # results in subs == ["sub", "bar/baz"]
    #
    # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of
    # 'foo'
    

    一般而言,最好让用户不要使用此函数,而是使用 skylib 的 'subpackages' 模块。