查询快速入门

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

如需详细了解语言和 --output 标志，请参阅 Bazel 查询参考和 Bazel cquery 参考手册。在 IDE 中通过在命令行中输入 bazel help query 或 bazel help cquery 获取帮助。

目标

本指南介绍了一系列基本查询，您可以使用这些查询来详细了解项目的文件依赖项。本白皮书的目标受众是掌握 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'

场景

想象一下这样一位场景：深入研究 Bafe 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 文件中查找所需信息，而应仅使用查询函数。

项目包含构成咖啡馆的不同软件包。它们分为：restaurant、ingredients、dishes、customers 和 reviews。这些软件包中的规则使用各种标记和依赖项定义咖啡馆的不同组件。

运行构建

此项目包含一个位于 Runner.java 内的主方法，您可以执行该方法来输出 Cafe 的菜单。使用 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 的文件，该文件是构建图的文本表示。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 咖啡馆：Amir 和 Jenny。除了他们的姓名之外，什么都不知道。幸运的是，他们在“客户”的 BUILD 文件中标记了订单。如何访问此代码？

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

在此示例中，标记是 pizza 或 macAndCheese 中的一个，表示菜单项。此命令会查询具有在特定软件包中的标识符匹配的目标。

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

此查询会返回“客户”软件包中所有带有“披萨”标签的定位条件。

自行测试

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

添加新的依赖项

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 创建为“src”文件的 Java 文件，以及您为果昔的每个要素制定的新规则。

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 文件，请参阅构建样式指南。

现在，通过添加 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”目标之间的关系，了解这两个函数之间的区别。您可以通过不同的方式从一个定位条件访问另一个定位条件：

• 大厨 → 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

输出结果遵循第一条路径 → 厨师 → MacAndCheese → 奶酪。如果您改为使用 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 的查询内容，试着看看是谁撰写了评价，以及评价中描述的是哪道菜。

总结

恭喜！您现在已经运行了几个基本查询，您可以在自己的项目中试用这些查询。如需详细了解查询语言语法，请参阅查询参考页面。想要更多高级查询？查询指南展示了一个比此指南涵盖的用例更多的使用场景列表。