查询快速入门

<ph type="x-smartling-placeholder"></ph> 报告问题 查看来源 敬上 每晚 · 7.3。 · 7.2 条 · 7.1。 · 7.0。 · 6.5

本教程介绍了如何借助 Bazel,使用预制的 Bazel 项目跟踪代码中的依赖项。

如需详细了解语言和 --output 标志,请参阅 Bazel 查询参考文档Bazel 查询参考文档手册。通过在命令行中输入 bazel help querybazel 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
└── WORKSPACE

在整个教程中,除非另有指示,否则请尽量不要在 BUILD 文件中查找所需信息,而应仅使用查询函数。

项目由不同的软件包组成,这些软件包构成了 Cafe。它们分为:restaurantingredientsdishescustomersreviews。这些软件包中的规则通过各种标记和依赖项定义了 Cafe 的不同组件。

运行构建

此项目包含 Runner.java 内的一个主方法,您可以执行该方法 输出了咖啡店的菜单。通过以下命令,使用 Bazel 构建项目 bazel build,并使用 : 指示目标名称为 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

查询返回结果显示披萨和 macAndCheese 都依赖于奶酪。真是令人惊喜!

根据标记查找目标

两位客户走进 Bazel Cafe:Amir 和 Jenny。除了他们的名字之外,没有人所知。幸运的是,他们的订单在“客户”标签中BUILD 文件。如何访问此代码?

开发者可以使用不同的标识符标记 Bazel 目标,通常用于测试目的。例如,测试上的标记可以标注测试在调试和发布流程中的作用,尤其是对于 C++ 和 Python 测试,它们缺少任何运行时注解功能。使用标记和大小元素可让您根据代码库的签入政策灵活地组合测试套件。

在此示例中,标记是 pizzamacAndCheese 中的一个,用于表示菜单项。此命令在特定软件包中查询具有与您的标识符匹配的标记的目标。

bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'

此查询会返回“customers”且带有“pizza”标签的软件包

自我测试

使用以下查询了解小珍想要点什么。

答案

芝士通心粉

添加新的依赖项

Cafe Bazel 新增了菜单,顾客现在可以订购冰沙了!这种奶昔由以下食材组成:StrawberryBanana

首先,添加冰沙依赖的原料:Strawberry.javaBanana.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”文件,以及您为冰沙的每种原料设置的新规则。

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",
    ],
)

最后,您需要将冰沙作为依赖项添加到 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.ingraph2.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 之间的路径。

通过查看“厨师”之间的关系,了解这两项函数之间的区别和“奶酪”目标。从一个目标进入另一个目标的路径可能有所不同:

  • 厨师 → MacAndCheese → 奶酪
  • 厨师 → 披萨 → 奶酪

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 查询,试着找出评价的作者,以及评价的菜品。

提示

检查代码和依赖项以获取实用信息。

答案

此评价描述的是披萨,小艾是评价者。看看此规则使用了哪些依赖项 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 是唯一订购了披萨的客户,并且是给出答案的评价者。

总结

恭喜!现在,您已经运行了几个基本查询,您可以在自己的项目中尝试运行这些查询。如需详细了解查询语言语法,请参阅查询参考页面。想要更多高级查询?查询指南详细列举了本指南中未涵盖的用例,