本教程介绍了如何使用预先创建的 Bazel 项目通过 Bazel 跟踪代码中的依赖项。
如需详细了解语言和 --output
标志,请参阅 Bazel 查询参考文档和 Bazel cquery 参考文档。在命令行中输入 bazel help query
或 bazel help cquery
,即可在 IDE 中获取帮助。
目标
本指南将向您介绍一组基本查询,您可以使用这些查询详细了解项目的文件依赖项。本教程面向对 Bazel 和 BUILD
文件的工作原理有基本了解的新 Bazel 开发者。
前提条件
首先,请安装 Bazel(如果尚未安装)。本教程使用 Git 进行源代码控制,因此为了取得最佳效果,请同时安装 Git。
为了直观呈现依赖项图,我们使用了名为 Graphviz 的工具,您可以下载该工具,以便跟随本教程操作。
获取示例项目
接下来,在您选择的命令行工具中运行以下命令,从 Bazel 的示例代码库中检索示例应用:
git clone https://github.com/bazelbuild/examples.git
本教程的示例项目位于 examples/query-quickstart
目录中。
使用入门
什么是 Bazel 查询?
查询可帮助您通过分析 BUILD
文件之间的关系并检查生成的输出以获取有用信息,从而了解 Bazel 代码库。本指南预览了一些基本查询函数,如需了解更多选项,请参阅查询指南。查询可帮助您了解大型项目中的依赖项,而无需手动浏览 BUILD
文件。
如需运行查询,请打开命令行终端并输入以下命令:
bazel query 'query_function'
场景
假设有一个场景,需要深入探究 Cafe Bazel 与其厨师之间的关系。这家咖啡馆专门出售披萨和奶酪通心粉。请查看下方项目的结构:
bazelqueryguide
├── BUILD
├── src
│ └── main
│ └── java
│ └── com
│ └── example
│ ├── customers
│ │ ├── Jenny.java
│ │ ├── Amir.java
│ │ └── BUILD
│ ├── dishes
│ │ ├── Pizza.java
│ │ ├── MacAndCheese.java
│ │ └── BUILD
│ ├── ingredients
│ │ ├── Cheese.java
│ │ ├── Tomatoes.java
│ │ ├── Dough.java
│ │ ├── Macaroni.java
│ │ └── BUILD
│ ├── restaurant
│ │ ├── Cafe.java
│ │ ├── Chef.java
│ │ └── BUILD
│ ├── reviews
│ │ ├── Review.java
│ │ └── BUILD
│ └── Runner.java
└── MODULE.bazel
在本教程中,除非另有说明,否则请尽量不要在 BUILD
文件中查找所需信息,而应仅使用查询函数。
项目由构成 Cafe 的不同软件包组成。它们分为:restaurant
、ingredients
、dishes
、customers
和 reviews
。这些软件包中的规则使用各种标记和依赖项定义了 Cafe 的不同组件。
运行 build
此项目在 Runner.java
中包含一个主方法,您可以执行该方法来输出咖啡厅的菜单。使用 bazel build
命令通过 Bazel 构建项目,并使用 :
指明目标的名称为 runner
。如需了解如何引用目标,请参阅目标名称。
如需构建此项目,请将以下命令粘贴到终端中:
bazel build :runner
如果构建成功,输出应如下所示。
INFO: Analyzed target //:runner (49 packages loaded, 784 targets configured).
INFO: Found 1 target...
Target //:runner up-to-date:
bazel-bin/runner.jar
bazel-bin/runner
INFO: Elapsed time: 16.593s, Critical Path: 4.32s
INFO: 23 processes: 4 internal, 10 darwin-sandbox, 9 worker.
INFO: Build completed successfully, 23 total actions
成功构建后,请粘贴以下命令以运行应用:
bazel-bin/runner
--------------------- MENU -------------------------
Pizza - Cheesy Delicious Goodness
Macaroni & Cheese - Kid-approved Dinner
----------------------------------------------------
这样,您将获得菜单项列表以及简短说明。
探索目标
该项目会在各自的软件包中列出食材和菜肴。如需使用查询查看软件包的规则,请运行命令 bazel query package/…
在本例中,您可以使用此查询来查看该咖啡馆提供的食材和菜肴,只需运行以下命令即可:
bazel query //src/main/java/com/example/dishes/...
bazel query //src/main/java/com/example/ingredients/...
如果您查询成分软件包的目标,输出应如下所示:
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
查找依赖项
您的运行脚本依赖于哪些目标?
假设您想深入了解项目的结构,但不想深入研究文件系统(这对于大型项目来说可能不可行)。Cafe Bazel 使用哪些规则?
如果,如本例所示,您的运行程序的目标是 runner
,请运行以下命令,以发现目标的底层依赖项:
bazel query --noimplicit_deps "deps(target)"
bazel query --noimplicit_deps "deps(:runner)"
//:runner
//:src/main/java/com/example/Runner.java
//src/main/java/com/example/dishes:MacAndCheese.java
//src/main/java/com/example/dishes:Pizza.java
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:Cheese.java
//src/main/java/com/example/ingredients:Dough.java
//src/main/java/com/example/ingredients:Macaroni.java
//src/main/java/com/example/ingredients:Tomato.java
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
//src/main/java/com/example/restaurant:Cafe.java
//src/main/java/com/example/restaurant:Chef.java
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
在大多数情况下,请使用查询函数 deps()
查看特定目标的各个输出依赖项。
可视化依赖关系图(可选)
本部分介绍了如何直观呈现特定查询的依赖项路径。Graphviz 有助于将路径视为有向无环图图片,而不是扁平列表。您可以使用各种 --output
命令行选项更改 Bazel 查询图的显示方式。如需了解选项,请参阅输出格式。
首先,运行所需的查询,然后添加标志 --noimplicit_deps
以移除过多的工具依赖项。然后,使用输出标志跟随查询,并将图表存储到名为 graph.in
的文件中,以创建图表的文本表示法。
如需搜索目标 :runner
的所有依赖项并将输出格式化为图表,请执行以下操作:
bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph.in
这会创建一个名为 graph.in
的文件,该文件是 build 图的文本表示形式。Graphviz 使用 dot
(一种将文本处理为可视化图表的工具)创建 PNG:
dot -Tpng < graph.in > graph.png
如果您打开 graph.png
,应该会看到如下内容。为了让本指南中的基本路径详情更清晰,我们对下图进行了简化。
当您想查看本指南中不同查询函数的输出时,这会很有用。
查找反向依赖项
相反,如果您有一个目标,想要分析哪些其他目标使用了它,则可以使用查询来检查哪些目标依赖于某个规则。这称为“反向依赖项”。在陌生的代码库中修改文件时,使用 rdeps()
会很有用,可以避免您无意中破坏依赖于该文件的其他文件。
例如,您想对成分 cheese
进行一些修改。为避免给 Cafe Bazel 造成问题,您需要检查哪些菜肴依赖于 cheese
。
如需查看哪些目标依赖于特定目标/软件包,您可以使用 rdeps(universe_scope, target)
。rdeps()
查询函数至少接受两个参数:一个 universe_scope
(相关目录)和一个 target
。Bazel 会在提供的 universe_scope
中搜索目标的反向依赖项。rdeps()
运算符接受一个可选的第三个参数:一个整数字面量,用于指定搜索深度的上限。
如需在整个项目“//…”的范围内查找目标 cheese
的反向依赖项,请运行以下命令:
bazel query "rdeps(universe_scope, target)"
ex) bazel query "rdeps(//... , //src/main/java/com/example/ingredients:cheese)"
//:runner
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
查询返回结果表明,pizza 和 macAndCheese 都依赖于 cheese。真是太意外了!
根据代码查找目标
两位客户走进了 Bazel 咖啡馆:Amir 和 Jenny。除了姓名之外,我们对其一无所知。幸运的是,他们在“客户”BUILD
文件中为其订单添加了标记。如何访问此代码?
开发者可以使用不同的标识符为 Bazel 目标添加标记,通常出于测试目的。例如,测试中的标记可以注释测试在调试和发布流程中的作用,尤其是对于缺少任何运行时注解功能的 C++ 和 Python 测试。使用标记和大小元素可根据代码库的签入政策灵活地组合测试套件。
在此示例中,标记为 pizza
或 macAndCheese
之一,用于表示菜单项。此命令会查询在特定软件包中具有与您的标识符匹配的标记的目标。
bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'
此查询会返回“customers”软件包中标记为“pizza”的所有目标。
自行测试
使用以下查询了解 Jenny 想订购什么。
答案
通心粉和奶酪
添加新依赖项
Cafe Bazel 扩大了菜单,客户现在可以点酸奶昔了!这款特定的冰沙由 Strawberry
和 Banana
这两种成分组成。
首先,添加果昔所依赖的成分:Strawberry.java
和 Banana.java
。添加空的 Java 类。
src/main/java/com/example/ingredients/Strawberry.java
package com.example.ingredients;
public class Strawberry {
}
src/main/java/com/example/ingredients/Banana.java
package com.example.ingredients;
public class Banana {
}
接下来,将 Smoothie.java
添加到适当的目录:dishes
。
src/main/java/com/example/dishes/Smoothie.java
package com.example.dishes;
public class Smoothie {
public static final String DISH_NAME = "Smoothie";
public static final String DESCRIPTION = "Yummy and Refreshing";
}
最后,将这些文件作为规则添加到相应的 BUILD
文件中。为每个新成分创建一个新的 Java 库,包括其名称、公开可见性和新创建的“src”文件。您最终应该得到以下更新后的 BUILD
文件:
src/main/java/com/example/ingredients/BUILD
java_library(
name = "cheese",
visibility = ["//visibility:public"],
srcs = ["Cheese.java"],
)
java_library(
name = "dough",
visibility = ["//visibility:public"],
srcs = ["Dough.java"],
)
java_library(
name = "macaroni",
visibility = ["//visibility:public"],
srcs = ["Macaroni.java"],
)
java_library(
name = "tomato",
visibility = ["//visibility:public"],
srcs = ["Tomato.java"],
)
java_library(
name = "strawberry",
visibility = ["//visibility:public"],
srcs = ["Strawberry.java"],
)
java_library(
name = "banana",
visibility = ["//visibility:public"],
srcs = ["Banana.java"],
)
在菜肴的 BUILD
文件中,您需要为 Smoothie
添加一条新规则。这样一来,系统就会将为 Smoothie
创建的 Java 文件作为“src”文件添加到 build 文件中,并添加您为这款冰沙的每种成分创建的新规则。
src/main/java/com/example/dishes/BUILD
java_library(
name = "macAndCheese",
visibility = ["//visibility:public"],
srcs = ["MacAndCheese.java"],
deps = [
"//src/main/java/com/example/ingredients:cheese",
"//src/main/java/com/example/ingredients:macaroni",
],
)
java_library(
name = "pizza",
visibility = ["//visibility:public"],
srcs = ["Pizza.java"],
deps = [
"//src/main/java/com/example/ingredients:cheese",
"//src/main/java/com/example/ingredients:dough",
"//src/main/java/com/example/ingredients:tomato",
],
)
java_library(
name = "smoothie",
visibility = ["//visibility:public"],
srcs = ["Smoothie.java"],
deps = [
"//src/main/java/com/example/ingredients:strawberry",
"//src/main/java/com/example/ingredients:banana",
],
)
最后,您需要将 Smoothie 作为依赖项添加到 Chef 的 BUILD
文件中。
src/main/java/com/example/restaurant/BUILD
java\_library(
name = "chef",
visibility = ["//visibility:public"],
srcs = [
"Chef.java",
],
deps = [
"//src/main/java/com/example/dishes:macAndCheese",
"//src/main/java/com/example/dishes:pizza",
"//src/main/java/com/example/dishes:smoothie",
],
)
java\_library(
name = "cafe",
visibility = ["//visibility:public"],
srcs = [
"Cafe.java",
],
deps = [
":chef",
],
)
再次构建 cafe
,确认没有错误。如果构建成功,恭喜!您为“Cafe”添加了一个新依赖项。如果没有,请检查拼写错误和软件包命名。如需详细了解如何编写 BUILD
文件,请参阅 BUILD 样式指南。
现在,可视化添加了 Smoothie
的新依赖项图,以便与之前的图进行比较。为清楚起见,请将图表输入命名为 graph2.in
和 graph2.png
。
bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph2.in
dot -Tpng < graph2.in > graph2.png
查看 graph2.png
,您会发现 Smoothie
与其他菜肴没有共享的依赖项,而只是 Chef
依赖的另一个目标。
somepath() 和 allpaths()
如果您想查询某个软件包为何依赖于另一个软件包,该怎么办?显示这两者之间的依赖项路径即可找到答案。
有两个函数可以帮助您查找依赖项路径:somepath()
和 allpaths()
。给定起始目标 S 和终点 E,使用 somepath(S,E)
查找 S 和 E 之间的路径。
通过查看“Chef”和“Cheese”目标之间的关系,探索这两种函数之间的区别。从一个目标到另一个目标有多种可能的路径:
- Chef → MacAndCheese → Cheese
- Chef → Pizza → Cheese
somepath()
会从这两个选项中为您提供一条路径,而“allpaths()”会输出所有可能的路径。
以 Cafe Bazel 为例,运行以下命令:
bazel query "somepath(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/ingredients:cheese
输出结果遵循第一个路径:Cafe → Chef → MacAndCheese → Cheese。如果您改为使用 allpaths()
,则会得到:
bazel query "allpaths(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
allpaths()
的输出内容是扁平化的依赖项列表,因此难以阅读。使用 Graphviz 可视化此图表,以便更清晰地了解这些关系。
自行测试
Cafe Bazel 的一位客户给出了该餐厅的第一条评价!很抱歉,该评价缺少一些详细信息,例如评价者的身份和所提及的菜肴。幸运的是,您可以使用 Bazel 获取这些信息。reviews
软件包包含一个用于输出神秘客户评价的程序。使用以下命令构建并运行它:
bazel build //src/main/java/com/example/reviews:review
bazel-bin/src/main/java/com/example/reviews/review
仅根据 Bazel 查询,尝试找出评价的作者以及他们所描述的菜肴。
提示
查看代码和依赖项,了解实用信息。
答案
此评价描述的是披萨,Amir 是评价者。如果您使用 bazel query --noimplicit\_deps 'deps(//src/main/java/com/example/reviews:review)'
查看此规则的依赖项,该命令的结果会显示 Amir 是审核者!
接下来,由于您知道审核者是 Amir,因此可以使用查询函数查找 Amir 在 `BUILD` 文件中使用了哪些标记,以了解其中包含哪些菜肴。
命令 bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'
的输出结果表明,Amir 是唯一一位订购了披萨的客户,也是评价者,这为我们提供了答案。
总结
恭喜!现在,您已经运行了几个基本查询,可以尝试在自己的项目中运行这些查询。如需详细了解查询语言语法,请参阅“查询”参考页面。想要执行更高级的查询?查询指南中详细列出了本指南未涵盖的更多用例。