Bắt đầu truy vấn nhanh

Hướng dẫn này trình bày cách làm việc với Bazel để theo dõi các phần phụ thuộc trong mã bằng dự án Bazel được tạo sẵn.

Để biết thông tin chi tiết về ngôn ngữ và cờ --output, vui lòng xem hướng dẫn tài liệu tham khảo về truy vấn Bazel và tài liệu tham khảo về cquery của Bazel. Yêu cầu trợ giúp trong IDE bằng cách nhập bazel help query hoặc bazel help cquery vào dòng lệnh.

Mục tiêu

Hướng dẫn này sẽ trình bày một tập hợp các truy vấn cơ bản mà bạn có thể dùng để tìm hiểu thêm về các phần phụ thuộc tệp của dự án. Đây là ứng dụng dành cho những nhà phát triển mới sử dụng Bazel, đã có kiến thức cơ bản về cách hoạt động của tệp Bazel và BUILD.

Điều kiện tiên quyết

Bắt đầu bằng cách cài đặt Bazel, nếu bạn chưa cài đặt. Hướng dẫn này sử dụng Git để kiểm soát nguồn, vì vậy, để có kết quả tốt nhất, hãy cài đặt Git.

Để trực quan hoá biểu đồ phần phụ thuộc, bạn có thể sử dụng công cụ có tên Graphviz mà bạn có thể tải xuống để theo dõi.

Lấy dự án mẫu

Tiếp theo, hãy truy xuất ứng dụng mẫu từ Kho lưu trữ mẫu của Bazel bằng cách chạy lệnh sau trong công cụ dòng lệnh mà bạn chọn:

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

Dự án mẫu cho hướng dẫn này nằm trong thư mục examples/query-quickstart.

Bắt đầu

Cụm từ tìm kiếm về Bazel là gì?

Truy vấn giúp bạn tìm hiểu về cơ sở mã Bazel bằng cách phân tích mối quan hệ giữa các tệp BUILD và kiểm tra kết quả để biết thông tin hữu ích. Hướng dẫn này giúp bạn xem trước một số hàm truy vấn cơ bản, nhưng để biết thêm các lựa chọn khác, hãy xem hướng dẫn về truy vấn. Truy vấn giúp bạn tìm hiểu về các phần phụ thuộc trong các dự án có quy mô lớn mà không cần di chuyển qua các tệp BUILD theo cách thủ công.

Để chạy truy vấn, hãy mở dòng lệnh của bạn rồi nhập:

bazel query 'query_function'

Trường hợp

Hãy tưởng tượng một tình huống đào sâu vào mối quan hệ giữa Cafe Bazel và đầu bếp tương ứng. Quán cà phê này chuyên bán pizza, Mac và phô mai. Hãy xem cấu trúc của dự án ở bên dưới:

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

Trong suốt hướng dẫn này, trừ phi có hướng dẫn khác, hãy cố gắng không tìm trong các tệp BUILD để tìm thông tin bạn cần mà chỉ sử dụng hàm truy vấn.

Một dự án bao gồm các gói khác nhau tạo nên một Quán cà phê. Các lớp này được phân tách thành: restaurant, ingredients, dishes, customers và reviews. Quy tắc trong những gói này xác định các thành phần khác nhau của Cafe bằng các thẻ và phần phụ thuộc khác nhau.

Chạy bản dựng

Dự án này chứa một phương thức chính bên trong Runner.java mà bạn có thể thực thi để in ra trình đơn của Cafe. Tạo dự án bằng Bazel với lệnh bazel build và sử dụng : để báo hiệu rằng mục tiêu có tên là runner. Hãy xem tên mục tiêu để tìm hiểu cách tham chiếu đến các mục tiêu.

Để tạo dự án này, hãy dán lệnh sau vào một thiết bị đầu cuối:

bazel build :runner

Kết quả của bạn sẽ có dạng như sau nếu quá trình tạo bản dựng thành công.

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

Sau khi ứng dụng được tạo thành công, hãy chạy ứng dụng bằng cách dán lệnh sau:

bazel-bin/runner

--------------------- MENU -------------------------

Pizza - Cheesy Delicious Goodness
Macaroni & Cheese - Kid-approved Dinner

----------------------------------------------------

Thao tác này sẽ cung cấp cho bạn một danh sách các món trong thực đơn cùng với một đoạn mô tả ngắn.

Khám phá mục tiêu

Dự án này liệt kê các nguyên liệu và món ăn theo từng gói. Để sử dụng truy vấn nhằm xem các quy tắc của một gói, hãy chạy lệnh bazel query package/…

Trong trường hợp này, bạn có thể dùng công cụ này để xem thành phần và món ăn ở Quán cà phê này bằng cách chạy:

bazel query //src/main/java/com/example/dishes/...

bazel query //src/main/java/com/example/ingredients/...

Nếu bạn truy vấn các mục tiêu của gói nguyên liệu, kết quả sẽ có dạng như sau:

//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

Tìm phần phụ thuộc

Người chạy của bạn dựa vào mục tiêu nào để chạy?

Giả sử bạn muốn tìm hiểu sâu hơn về cấu trúc của dự án mà không cần thao tác trên hệ thống tệp (đối với các dự án lớn có thể không hỗ trợ được). Cafe Bazel sử dụng quy tắc nào?

Nếu như trong ví dụ này, mục tiêu cho trình chạy của bạn là runner, hãy khám phá các phần phụ thuộc cơ bản của mục tiêu bằng cách chạy lệnh:

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

Trong hầu hết các trường hợp, hãy sử dụng hàm truy vấn deps() để xem các phần phụ thuộc đầu ra riêng lẻ của một mục tiêu cụ thể.

Trực quan hoá biểu đồ phần phụ thuộc (không bắt buộc)

Phần này mô tả cách bạn có thể trực quan hoá đường dẫn phần phụ thuộc cho một truy vấn cụ thể. Graphviz giúp xem đường dẫn dưới dạng hình ảnh đồ thị chu trình có hướng trái ngược với danh sách làm phẳng. Bạn có thể thay đổi giao diện biểu đồ truy vấn Bazel bằng cách sử dụng nhiều tuỳ chọn dòng lệnh --output. Hãy xem phần Định dạng trang kết quả để biết các tuỳ chọn.

Bắt đầu bằng cách chạy truy vấn mà bạn muốn và thêm cờ --noimplicit_deps để xoá các phần phụ thuộc công cụ quá mức. Sau đó, hãy theo dõi truy vấn có cờ đầu ra và lưu trữ biểu đồ vào tệp có tên graph.in để tạo bản trình bày văn bản của biểu đồ.

Cách tìm kiếm tất cả phần phụ thuộc của :runner mục tiêu và định dạng kết quả dưới dạng biểu đồ:

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph.in

Thao tác này sẽ tạo một tệp có tên là graph.in. Tệp này đại diện bằng văn bản của biểu đồ bản dựng. Graphviz sử dụng dot – một công cụ xử lý văn bản thành hình ảnh trực quan để tạo tệp png:

dot -Tpng < graph.in > graph.png

Nếu mở graph.png, bạn sẽ thấy nội dung như sau. Biểu đồ bên dưới đã được đơn giản hóa để làm cho thông tin chi tiết về lộ trình thiết yếu rõ ràng hơn trong hướng dẫn này.

Điều này hữu ích khi bạn muốn xem kết quả của các hàm truy vấn khác nhau trong suốt hướng dẫn này.

Tìm phần phụ thuộc đảo ngược

Nếu thay vào đó bạn có mục tiêu và bạn muốn phân tích xem các mục tiêu nào khác sử dụng mục tiêu đó, bạn có thể sử dụng truy vấn để kiểm tra xem mục tiêu nào phụ thuộc vào một quy tắc nhất định. Đây được gọi là "phần phụ thuộc ngược". Việc sử dụng rdeps() có thể hữu ích khi chỉnh sửa một tệp trong cơ sở mã mà bạn không quen thuộc, đồng thời có thể giúp bạn không vô tình làm hỏng các tệp khác phụ thuộc vào tệp đó.

Ví dụ: bạn muốn chỉnh sửa một chút về nguyên liệu cheese. Để tránh gây ra vấn đề cho Cafe Bazel, bạn cần kiểm tra xem những món ăn nào phụ thuộc vào cheese.

Để xem các mục tiêu nào phụ thuộc vào một mục tiêu/gói cụ thể, bạn có thể sử dụng rdeps(universe_scope, target). Hàm truy vấn rdeps() nhận ít nhất 2 đối số: universe_scope — thư mục có liên quan — và target. Bazel tìm kiếm các phần phụ thuộc đảo ngược của mục tiêu trong universe_scope cho sẵn. Toán tử rdeps() chấp nhận một đối số thứ ba không bắt buộc: một giá trị cố định dạng số nguyên xác định giới hạn trên về mức độ tìm kiếm.

Để tìm các phần phụ thuộc đảo ngược của cheese mục tiêu trong phạm vi của toàn bộ dự án '//...', hãy chạy lệnh:

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

Kết quả trả về cho truy vấn cho thấy rằng cả pizza và macAndCheese đều phụ thuộc vào phô mai. Thật bất ngờ!

Tìm mục tiêu dựa trên thẻ

Hai khách hàng bước vào Bazel Cafe: Amir và Jenny. Không có gì về họ, ngoại trừ tên của họ. Rất may là các đơn đặt hàng của họ đã được gắn thẻ trong tệp BUILD "khách hàng". Làm cách nào để truy cập vào thẻ này?

Các nhà phát triển có thể gắn thẻ các mục tiêu Bazel bằng nhiều giá trị nhận dạng, thường là cho mục đích thử nghiệm. Ví dụ: các thẻ trên kiểm thử có thể chú thích vai trò của kiểm thử trong quy trình gỡ lỗi và phát hành, đặc biệt là đối với kiểm thử C++ và Python, vốn thiếu bất kỳ khả năng chú thích thời gian chạy nào. Việc sử dụng thẻ và các phần tử kích thước giúp bạn linh hoạt tập hợp các bộ kiểm thử dựa trên chính sách đăng ký của cơ sở mã.

Trong ví dụ này, thẻ là một trong số pizza hoặc macAndCheese để đại diện cho các mục trong trình đơn. Lệnh này truy vấn các mục tiêu có thẻ khớp với giá trị nhận dạng của bạn trong một gói nhất định.

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

Truy vấn này trả về tất cả các mục tiêu trong gói hàng 'khách hàng' có thẻ "pizza".

Tự kiểm tra

Hãy dùng cụm từ tìm kiếm này để biết Jenny muốn đặt món gì.

Thêm phần phụ thuộc mới

Cafe Bazel đã mở rộng thực đơn — khách hàng nay có thể đặt Sinh tố! Loại sinh tố cụ thể này bao gồm các thành phần Strawberry và Banana.

Trước tiên, hãy thêm các nguyên liệu mà sinh tố phụ thuộc vào: Strawberry.java và Banana.java. Thêm các lớp Java trống.

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 {

}

Tiếp theo, hãy thêm Smoothie.java vào thư mục thích hợp: 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";
}

Cuối cùng, hãy thêm các tệp này làm quy tắc trong các tệp BUILD thích hợp. Tạo một thư viện Java mới cho từng thành phần mới, bao gồm tên, chế độ hiển thị công khai và tệp "src" mới tạo. Bạn sẽ kết thúc bằng tệp BUILD đã cập nhật này:

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

Trong tệp BUILD cho món ăn, bạn cần thêm quy tắc mới cho Smoothie. Thao tác này bao gồm tệp Java được tạo cho Smoothie dưới dạng tệp "src" và các quy tắc mới bạn đã áp dụng cho từng nguyên liệu của sinh tố.

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

Cuối cùng, bạn nên đưa sinh tố vào dưới dạng phần phụ thuộc trong tệp BUILD của Chef.

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

Tạo lại cafe để xác nhận rằng không có lỗi. Nếu thiết bị được tạo thành công, thì xin chúc mừng! Bạn đã thêm phần phụ thuộc mới cho "Cafe". Nếu không, hãy chú ý đến lỗi chính tả và cách đặt tên gói. Để biết thêm thông tin về cách viết tệp BUILD, hãy xem Hướng dẫn về kiểu XÂY DỰNG.

Bây giờ, hãy trực quan hoá biểu đồ phần phụ thuộc mới bằng việc thêm Smoothie để so sánh với biểu đồ trước đó. Để rõ ràng, hãy đặt tên cho dữ liệu đầu vào của biểu đồ là graph2.in và graph2.png.

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph2.in

dot -Tpng < graph2.in > graph2.png

Nhìn vào graph2.png, bạn có thể thấy Smoothie không có phần phụ thuộc chung với các món ăn khác mà chỉ là một mục tiêu khác mà Chef dựa vào.

somepath() và allpaths()

Nếu bạn muốn truy vấn vì sao một gói lại phụ thuộc vào một gói khác thì sao? Việc hiển thị một đường dẫn phần phụ thuộc giữa hai quá trình sẽ cung cấp câu trả lời.

Hai hàm có thể giúp bạn tìm thấy đường dẫn phần phụ thuộc: somepath() và allpaths(). Cho trước mục tiêu bắt đầu S và điểm cuối E, hãy tìm đường đi từ S và E bằng cách sử dụng somepath(S,E).

Khám phá sự khác biệt giữa hai chức năng này bằng cách xem xét mối quan hệ giữa các mục tiêu "Chef" và "Cheese". Có nhiều đường dẫn để chuyển từ mục tiêu này sang mục tiêu khác:

• Chef → MacAndCheese → Phô mai
• Đầu bếp → Pizza → Phô mai

somepath() cung cấp cho bạn một đường dẫn duy nhất trong số hai tuỳ chọn, trong khi "allpaths()" xuất ra mọi đường dẫn có thể có.

Dùng Cafe Bazel làm ví dụ, chạy lệnh sau:

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

Kết quả xuất ra đi theo đường dẫn đầu tiên là Cafe → Chef → MacAndCheese → Phô mai. Thay vào đó, nếu sử dụng allpaths(), bạn sẽ nhận được:

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

Kết quả đầu ra của allpaths() khó đọc hơn một chút vì đây là danh sách đã làm phẳng các phần phụ thuộc. Việc trực quan hoá biểu đồ này bằng Graphviz sẽ giúp mối quan hệ này trở nên rõ ràng hơn.

Tự kiểm tra

Một trong những khách hàng của Cafe Bazel đã đưa ra bài đánh giá đầu tiên về nhà hàng này! Rất tiếc, bài đánh giá này thiếu một số thông tin như danh tính của người đánh giá và món ăn trong bài đánh giá đó. Thật may là bạn có thể truy cập được thông tin này thông qua Bazel. Gói reviews chứa một chương trình in bài đánh giá của một khách hàng bí ẩn. Tạo và chạy bằng:

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

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

Nếu bạn chỉ tìm kiếm các câu hỏi liên quan đến Bazel, hãy cố gắng tìm hiểu xem ai là người viết bài đánh giá và họ đang mô tả món ăn nào.

Kết thúc

Xin chúc mừng! Bạn hiện đã chạy một số truy vấn cơ bản mà bạn có thể thử trong các dự án riêng. Để tìm hiểu thêm về cú pháp ngôn ngữ truy vấn, hãy tham khảo Trang tham khảo truy vấn. Bạn muốn truy vấn nâng cao khác? Hướng dẫn truy vấn trình bày danh sách chi tiết về nhiều trường hợp sử dụng hơn so với nội dung được đề cập trong hướng dẫn này.