依赖项

报告问题 查看源代码

如果 A 在构建或执行时需要 B,则目标 A 依赖于目标 B“依赖”关系会在目标上引发有向无环图 (DAG),这称为“依赖关系图”。

目标的直接依赖项是指可通过依赖关系图中长度为 1 的路径到达的其他目标。目标的传递依赖项是指它通过图中任意长度的路径所依赖的目标。

事实上,在构建的上下文中,有两个依赖关系图,即实际依赖关系图和声明依赖关系图。大多数情况下,这两个图非常相似,以至于不需要区分,但它们对于下面的讨论非常有用。

实际依赖项和声明的依赖项

目标 X 实际上依赖于目标 Y,前提是 Y 必须存在、已构建且处于最新状态才能正确构建 X“构建”可能是指生成、处理、编译、链接、归档、压缩、执行或构建期间定期发生的任何其他类型的任务。

如果 X 软件包中存在从 XY 的依赖关系,则目标 X 声明了对目标 Y 的依赖性

对于正确的构建,实际依赖项 A 的图必须是声明的依赖项 D 的图的子图。也就是说,A 中的每对直接连接节点 x --> y 也必须直接连接 D。可以说,D 是 A 的超近似值。

BUILD 文件写入者必须向构建系统明确声明每条规则的所有实际直接依赖项,不得再有此类声明。

不遵守此原则会导致未定义的行为:构建可能会失败,但更糟糕的是,构建可能依赖于之前的一些操作,或者目标恰好具有传递性声明的依赖项。Bazel 会检查缺少的依赖项并报告错误,但这项检查并非在任何情况下都能完成。

您无需(也不应)尝试列出间接导入的所有内容,即使 A 在执行时需要也是如此。

在构建目标 X 期间,构建工具会检查 X 依赖项的整个传递闭包,以确保这些目标中的任何更改都会反映在最终结果中,并根据需要重新构建中间版本。

依赖项的传递特性导致一种常见的错误。有时,一个文件中的代码可能会使用由“间接”依赖项(声明的依赖关系图中的传递但不是直接的边缘)提供的代码。间接依赖项不会出现在 BUILD 文件中。由于该规则不直接依赖于提供程序,因此无法跟踪更改,如以下示例时间轴所示:

1. 声明的依赖项与实际依赖项匹配

最初,一切正常。软件包 a 中的代码使用软件包 b 中的代码。软件包 b 中的代码使用软件包 c 中的代码,因此 a 以传递方式依赖于 c

a/BUILD b/BUILD
rule(
    name = "a",
    srcs = "a.in",
    deps = "//b:b",
)
      
rule(
    name = "b",
    srcs = "b.in",
    deps = "//c:c",
)
      
a / a.in b / b.in
import b;
b.foo();
    
import c;
function foo() {
  c.bar();
}
      
声明的依赖关系图,其中有连接 a、b 和 c 的箭头
声明的依赖关系图
与声明的依赖关系图匹配的实际依赖关系图,其中有箭头连接 a、b 和 c
实际依赖关系图

声明的依赖项优先于实际依赖项。一切正常。

2. 添加未声明的依赖项

当有人向 a 添加代码,创建对 c 的直接“实际”依赖项,但忘记在 build 文件 a/BUILD 中声明它时,就会引入潜在危害。

a / a.in  
        import b;
        import c;
        b.foo();
        c.garply();
      
 
声明的依赖关系图,其中有连接 a、b 和 c 的箭头
声明的依赖关系图
使用箭头连接 a、b 和 c 的实际依赖关系图。现在,箭头也会将 A 连接到 C。这与声明的依赖关系图不匹配
实际依赖关系图

声明的依赖项不再高估实际依赖项。这样可能会构建成功,因为两个图的传递闭包相等,但掩盖了一个问题:ac 有实际但未声明的依赖项。

3. 声明的依赖关系图与实际依赖关系图之间的偏差

这种危险会在有人重构 b 以使其不再依赖于 c 时显现,从而无意中破坏了 a,而并非由于其自身的过失。

  b/BUILD
 
rule(
    name = "b",
    srcs = "b.in",
    deps = "//d:d",
)
      
  b / b.in
 
      import d;
      function foo() {
        d.baz();
      }
      
声明的依赖关系图,其中有连接 a 和 b 的箭头。b 不再连接到 c,这会断开 a 与 c 的连接
声明的依赖关系图
实际依赖关系图,显示 a 连接到 b 和 c,但 b 不再连接到 c
实际依赖关系图

声明的依赖关系图现在是实际依赖关系的低估值,即使以传递方式关闭也是如此;构建很可能会失败。

确保在 BUILD 文件中正确声明第 2 步中引入的 ac 的实际依赖关系,才能避免此问题。

依赖项类型

大多数构建规则都有三个属性,用于指定不同类型的通用依赖项:srcsdepsdata。具体如下所述。如需了解详情,请参阅所有规则共有的属性

许多规则还具有特定于规则类型的依赖项(例如 compilerresources)的其他属性。如需了解详情,请参阅构建百科全书

srcs 个依赖项

输出源文件的规则所直接使用的文件。

deps 个依赖项

指向提供头文件、符号、库、数据等的单独编译的模块的规则。

data 个依赖项

build 目标可能需要一些数据文件才能正常运行。这些数据文件不是源代码,不会影响目标的构建方式。例如,单元测试可能会将函数的输出与文件的内容进行比较。构建单元测试时,您不需要此文件,但在运行测试时需要。这同样适用于在执行期间启动的工具。

构建系统在一个隔离的目录中运行测试,该目录下只有列为 data 的文件可用。因此,如果二进制文件/库/测试需要运行一些文件,请在 data 中指定这些文件(或包含这些文件的构建规则)。例如:

# I need a config file from a directory named env:
java_binary(
    name = "setenv",
    ...
    data = [":env/default_env.txt"],
)

# I need test data from another directory
sh_test(
    name = "regtest",
    srcs = ["regtest.sh"],
    data = [
        "//data:file1.txt",
        "//data:file2.txt",
        ...
    ],
)

这些文件可通过相对路径 path/to/data/file 获取。在测试中,您可以通过联接测试的源目录的路径与工作区相对路径(例如 ${TEST_SRCDIR}/workspace/path/to/data/file)来引用这些文件。

使用标签引用目录

查看 BUILD 文件时,您可能会注意到某些 data 标签引用了目录。这些标签以 /./ 结尾,如以下示例所示:

不建议 - data = ["//data/regression:unittest/."]

不建议 - data = ["testdata/."]

不建议 - data = ["testdata/"]

这似乎很方便,尤其是对于测试,因为它允许测试使用目录中的所有数据文件。

但尽量不要这样做。为了确保在更改后正确执行增量重新构建(以及重新执行测试),构建系统必须了解作为构建(或测试)输入的完整文件集。指定目录后,仅当目录本身发生更改(由于添加或删除文件)时,构建系统才会执行重新构建,但无法检测到对单个文件的修改,因为这些更改不会影响封装目录。您应该以显式方式或使用 glob() 函数枚举目录中包含的一组文件,而不是将目录指定为构建系统的输入。(使用 ** 可强制 glob() 为递归)。

建议 - data = glob(["testdata/**"])

遗憾的是,在某些情况下,必须使用目录标签。例如,如果 testdata 目录包含名称不符合标签语法的文件,则显式枚举文件或使用 glob() 函数会产生无效标签错误。在这种情况下,您必须使用目录标签,但请注意,上文所述的错误重新编译的相关风险。

如果必须使用目录标签,请注意,不能使用相对 ../ 路径来引用父软件包;而应使用 //data/regression:unittest/. 等绝对路径。

任何需要使用多个文件的外部规则(例如测试)都必须明确声明它依赖于所有这些文件。您可以使用 filegroup()BUILD 文件中将文件组合在一起:

filegroup(
        name = 'my_data',
        srcs = glob(['my_unittest_data/*'])
)

然后,您可以在测试中引用 my_data 标签作为数据依赖关系。

BUILD 文件 可见性