查詢快速入門導覽課程

本教學課程將說明如何使用預先製作的 Bazel 專案，搭配 Bazel 追蹤程式碼中的依附元件。

如需語言和 --output 標記的詳細資訊，請參閱 Bazel 查詢參考資料和 Bazel cquery 參考資料手冊。在指令列中輸入 bazel help query 或 bazel help cquery，即可在 IDE 中取得說明。

目標

本指南將逐步說明一組基本查詢，您可以利用這些查詢進一步瞭解專案的檔案依附元件。本指南適用於新手 Bazel 開發人員，他們對 Bazel 和 BUILD 檔案的運作方式有基本瞭解。

必要條件

首先，請安裝 Bazel (如果尚未安裝)。本教學課程使用 Git 進行原始碼控管，因此建議您一併安裝 Git，以便取得最佳結果。

如要以視覺化方式呈現依附關係圖表，我們會使用 Graphviz 工具，您可以下載這項工具，以便瞭解後續步驟。

取得範例專案

接下來，請在您選擇的指令列工具中執行下列指令，從 Bazel 的範例存放區中擷取範例應用程式：

git clone https://github.com/bazelbuild/examples.git

本教學課程的範例專案位於 examples/query-quickstart 目錄中。

開始使用

什麼是 Bazel 查詢？

查詢可協助您瞭解 Bazel 程式碼庫，方法是分析 BUILD 檔案之間的關係，並檢查產生的輸出內容是否含有實用資訊。本指南會預覽一些基本查詢函式，如需更多選項，請參閱查詢指南。查詢可協助您瞭解大規模專案中的依附元件，無須手動瀏覽 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 的不同元件，並附上各種標記和依附元件。

執行建構作業

這個專案在 Runner.java 中含有主要方法，您可以執行該方法來列印 Cafe 的選單。使用 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 的檔案，這是建構圖表的文字表示法。Graphviz 使用 dot 來建立 PNG 檔案，dot 是一種將文字轉換為視覺化圖像的工具：

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 都需要起司。真是驚喜！

根據代碼尋找目標

兩位顧客走進 Bazel Cafe：Amir 和 Jenny。除了名字之外，我們對他們一無所知。幸運的是，他們的訂單已標記在「customers」BUILD 檔案中。如何存取這個代碼？

開發人員可以使用不同的 ID 標記 Bazel 目標，通常是為了測試。舉例來說，測試標記可在偵錯和發布程序中標註測試的角色，特別適用於缺乏任何執行階段標註功能的 C++ 和 Python 測試。使用標記和大小元素，可根據程式碼集的簽入政策，靈活組合測試套件。

在本例中，標記為 pizza 或 macAndCheese 之一，用來代表選單項目。這個指令會查詢特定套件中標記與 ID 相符的目標。

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」檔案)，以及您為果昔的每個成分建立的新規則。

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 將這張圖表視覺化，就能更清楚瞭解兩者之間的關係。

自行測試

咖啡廳 Bazel 的一位顧客給了餐廳第一則評論！很抱歉，這則評論缺少一些詳細資料，例如評論者的身分和所指的餐點。幸好，您可以透過 Bazel 存取這項資訊。reviews 套件包含一個程式，可列印神秘顧客的評論。使用以下方式建構及執行應用程式：

bazel build //src/main/java/com/example/reviews:review

bazel-bin/src/main/java/com/example/reviews/review

請根據 Bazel 查詢結果，找出評論者是誰，以及他們在評論中提到哪道菜色。

設定程序即將完成

恭喜！您現在已執行幾個基本查詢，可以嘗試在自己的專案中使用。如要進一步瞭解查詢語言語法，請參閱查詢參考資料頁面。想編寫更進階的查詢嗎？查詢指南會列出詳細的用途清單，涵蓋本指南未提及的更多用途。