Tổng quan về các phần phụ thuộc bên ngoài

Báo cáo vấn đề Xem nguồn Nightly .

Bazel hỗ trợ các phần phụ thuộc bên ngoài, các tệp nguồn (cả văn bản và tệp nhị phân) dùng trong bản dựng mà không phải từ không gian làm việc của bạn. Ví dụ: đó có thể là một bộ quy tắc được lưu trữ trong một kho lưu trữ GitHub, một cấu phần phần mềm Maven hoặc một thư mục trên máy cục bộ bên ngoài không gian làm việc hiện tại của bạn.

Kể từ Bazel 6.0, có 2 cách để quản lý các phần phụ thuộc bên ngoài với Bazel: hệ thống WORKSPACE truyền thống, tập trung vào kho lưu trữ và hệ thống MODULE.bazel tập trung vào mô-đun (có tên mã là Bzlmod và được bật bằng cờ --enable_bzlmod). Hai hệ thống này có thể được sử dụng, nhưng Bzlmod sẽ thay thế hệ thống WORKSPACE trong các bản phát hành Bazel0 trong tương lai. xem hướng dẫn di chuyển Bzmod cùng nhau.

Tài liệu này giải thích các khái niệm về quản lý phần phụ thuộc bên ngoài trong Bazel, trước khi đi sâu hơn một chút về hai hệ thống này theo thứ tự.

Khái niệm

Kho lưu trữ

Cây thư mục có một tệp đánh dấu ranh giới ở gốc, chứa các tệp nguồn có thể dùng trong một bản dựng Bazel. Thường được rút ngắn thành kho lưu trữ.

Tệp đánh dấu ranh giới của kho lưu trữ có thể là MODULE.bazel (báo hiệu rằng kho lưu trữ này đại diện cho mô-đun Bazel), REPO.bazel (xem bên dưới) hoặc trong ngữ cảnh cũ, WORKSPACE hoặc WORKSPACE.bazel. Mọi tệp đánh dấu ranh giới repo sẽ biểu thị ranh giới của một kho lưu trữ; nhiều tệp như vậy có thể cùng tồn tại trong một thư mục.

Kho lưu trữ chính

Kho lưu trữ nơi lệnh Bazel hiện tại đang được chạy.

Gốc của kho lưu trữ chính còn được gọi là thư mục gốc của không gian làm việc.

Workspace

Môi trường dùng chung của tất cả các lệnh Bazel sẽ chạy trong cùng một kho lưu trữ chính. Tệp này bao gồm kho lưu trữ chính và tập hợp tất cả các kho lưu trữ bên ngoài đã xác định.

Xin lưu ý rằng trước đây, các khái niệm "kho lưu trữ" và "không gian làm việc" đã được kết hợp với nhau. Thuật ngữ "không gian làm việc" thường được dùng để chỉ kho lưu trữ chính. Đôi khi, thuật ngữ này còn được dùng để chỉ "kho lưu trữ" chính.

Tên kho lưu trữ chuẩn hoá

Tên chuẩn hoá của kho lưu trữ có thể định địa chỉ. Trong bối cảnh một không gian làm việc, mỗi kho lưu trữ có một tên chính tắc duy nhất. Bạn có thể nhắm mục tiêu bên trong một kho lưu trữ có tên chuẩn là canonical_name bằng nhãn @@canonical_name//package:target (lưu ý @ kép).

Kho lưu trữ chính luôn sử dụng chuỗi trống làm tên chuẩn.

Tên kho lưu trữ biểu kiến

Tên của một kho lưu trữ có thể xác định được trong ngữ cảnh của một kho lưu trữ nhất định khác. Đây có thể được coi là "biệt hiệu" của một kho lưu trữ: Kho lưu trữ có tên chuẩn michael có thể có tên rõ ràng là mike trong ngữ cảnh của kho lưu trữ alice, nhưng có thể có tên rõ ràng là mickey trong ngữ cảnh của kho lưu trữ bob. Trong trường hợp này, mục tiêu bên trong michael có thể được xác định bằng nhãn @mike//package:target trong ngữ cảnh alice (lưu ý rằng @ duy nhất).

Ngược lại, đây có thể được hiểu là một mối liên kết kho lưu trữ: mỗi kho lưu trữ duy trì một mối liên kết từ "tên kho lưu trữ rõ ràng" đến "tên kho lưu trữ chính tắc".

Quy tắc kho lưu trữ

Một giản đồ cho các định nghĩa về kho lưu trữ cho Bazel biết cách cụ thể hoá một kho lưu trữ. Ví dụ: có thể là "tải tệp lưu trữ zip từ một URL nhất định xuống rồi giải nén tệp đó", hoặc "tìm nạp một cấu phần phần mềm Maven nhất định và cung cấp cấu phần phần mềm đó dưới dạng mục tiêu java_import" hoặc đơn giản là "đường liên kết tượng trưng đến một thư mục cục bộ". Mỗi kho lưu trữ được xác định bằng cách gọi một quy tắc kho lưu trữ với số lượng đối số thích hợp.

Xem phần Quy tắc kho lưu trữ để biết thêm thông tin về cách viết các quy tắc kho lưu trữ của riêng bạn.

Cho đến nay, các quy tắc repo phổ biến nhất là http_archive (tải tệp lưu trữ xuống từ một URL và trích xuất tệp đó), và local_repository liên kết tượng trưng với một thư mục cục bộ đã là kho lưu trữ Bazel.

Tìm nạp kho lưu trữ

Hành động tạo một kho lưu trữ có sẵn trên ổ đĩa cục bộ bằng cách chạy quy tắc kho lưu trữ liên kết. Các kho lưu trữ được xác định trong một không gian làm việc không có sẵn trên ổ đĩa cục bộ trước khi được tìm nạp.

Thông thường, Bazel chỉ tìm nạp một kho lưu trữ khi cần thứ gì đó từ kho lưu trữ đó và kho lưu trữ đó chưa được tìm nạp. Nếu đã tìm nạp kho lưu trữ trước đó, thì Bazel chỉ tìm nạp lại nếu định nghĩa của kho lưu trữ đó thay đổi.

Bạn có thể dùng lệnh fetch để bắt đầu tìm nạp trước kho lưu trữ, mục tiêu hoặc tất cả kho lưu trữ cần thiết để thực hiện bất kỳ bản dựng nào. Tính năng này cho phép các bản dựng ngoại tuyến bằng cách sử dụng tuỳ chọn --nofetch.

Tuỳ chọn --fetch dùng để quản lý quyền truy cập mạng. Giá trị mặc định của giá trị này là true. Tuy nhiên, khi bạn đặt thành false (--nofetch), lệnh này sẽ sử dụng bất kỳ phiên bản nào được lưu vào bộ nhớ đệm của phần phụ thuộc được lưu vào bộ nhớ đệm và nếu không có phiên bản nào, lệnh này sẽ dẫn đến lỗi.

Xem tuỳ chọn tìm nạp để biết thêm thông tin về cách kiểm soát quá trình tìm nạp.

Bố cục thư mục

Sau khi tìm nạp, bạn có thể tìm thấy kho lưu trữ này trong thư mục con external thuộc cơ sở đầu ra, bên dưới tên chuẩn của nó.

Bạn có thể chạy lệnh sau để xem nội dung của kho lưu trữ với tên phiên bản chuẩn canonical_name:

ls $(bazel info output_base)/external/ canonical_name

Tệp REPO.bazel

Tệp REPO.bazel dùng để đánh dấu ranh giới trên cùng của cây thư mục cấu thành nên một kho lưu trữ. Tệp này không cần chứa bất kỳ nội dung nào để phân phát dưới dạng tệp ranh giới kho lưu trữ; tuy nhiên, bạn cũng có thể sử dụng tệp này để chỉ định một số thuộc tính phổ biến cho tất cả các mục tiêu bản dựng bên trong kho lưu trữ đó.

Cú pháp của tệp REPO.bazel tương tự như tệp BUILD, ngoại trừ việc không hỗ trợ câu lệnh load nào và chỉ có một hàm duy nhất là repo(). repo() nhận các đối số giống như hàm package() trong tệp BUILD; trong khi package() chỉ định các thuộc tính chung cho tất cả mục tiêu bản dựng bên trong gói, thì repo() tương tự thực hiện như vậy cho tất cả mục tiêu bản dựng bên trong kho lưu trữ.

Ví dụ: bạn có thể chỉ định một giấy phép chung cho tất cả mục tiêu trong kho lưu trữ bằng cách có tệp REPO.bazel sau:

repo(
    default_package_metadata = ["//:my_license"],
)

Quản lý các phần phụ thuộc bên ngoài bằng Bzlmod

Bzlmod (hệ thống con mới của phần phụ thuộc bên ngoài) không trực tiếp hoạt động với các định nghĩa kho lưu trữ. Thay vào đó, mô-đun này tạo một biểu đồ phần phụ thuộc từ các mô-đun, chạy phần mở rộng ở đầu biểu đồ và xác định các kho lưu trữ tương ứng.

Mô-đun Bazel là một dự án Bazel có thể có nhiều phiên bản, trong đó mỗi phiên bản phát hành siêu dữ liệu về các mô-đun khác mà nó phụ thuộc. Một mô-đun phải có tệp MODULE.bazel ở gốc kho lưu trữ, bên cạnh tệp WORKSPACE. Tệp này là tệp kê khai của mô-đun, khai báo tên, phiên bản, danh sách phần phụ thuộc và các thông tin khác. Sau đây là một ví dụ cơ bản:

module(name = "my-module", version = "1.0")

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

Một mô-đun chỉ được liệt kê các phần phụ thuộc trực tiếp mà Bzlmod tra cứu trong Sổ đăng ký Bazel – theo mặc định là Sổ đăng ký Bazel Central. Sổ đăng ký cung cấp các tệp MODULE.bazel của các phần phụ thuộc, cho phép Bazel khám phá toàn bộ biểu đồ phần phụ thuộc bắc cầu trước khi thực hiện phân giải phiên bản.

Sau khi phân giải phiên bản, trong đó một phiên bản được chọn cho mỗi mô-đun, Bazel sẽ tham khảo lại sổ đăng ký để tìm hiểu cách xác định kho lưu trữ cho từng mô-đun (trong hầu hết các trường hợp, sử dụng http_archive).

Các mô-đun cũng có thể chỉ định các phần dữ liệu tuỳ chỉnh được gọi là thẻ, được tiện ích mô-đun sử dụng sau khi phân giải mô-đun để xác định các kho lưu trữ bổ sung. Các tiện ích này có khả năng tương tự như quy tắc kho lưu trữ, cho phép chúng thực hiện các thao tác như I/O đối với tệp và gửi yêu cầu mạng. Ngoài ra, chúng cho phép Bazel tương tác với các hệ thống quản lý gói khác, trong khi vẫn tôn trọng biểu đồ phần phụ thuộc được tạo từ các mô-đun Bazel.

Xác định kho lưu trữ bằng WORKSPACE

Trước đây, bạn có thể quản lý các phần phụ thuộc bên ngoài bằng cách xác định các kho lưu trữ trong tệp WORKSPACE (hoặc WORKSPACE.bazel). Tệp này có cú pháp tương tự như tệp BUILD, sử dụng quy tắc repo thay vì quy tắc bản dựng.

Đoạn mã sau đây là một ví dụ về cách sử dụng quy tắc kho lưu trữ http_archive trong tệp WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "foo",
    urls = ["https://example.com/foo.zip"],
    sha256 = "c9526390a7cd420fdcec2988b4f3626fe9c5b51e2959f685e8f4d170d1a9bd96",
)

Đoạn mã xác định một repo có tên chuẩn là foo. Theo mặc định, trong hệ thống WORKSPACE, tên chuẩn hoá của một kho lưu trữ cũng là tên hiển thị của nó cho tất cả các kho lưu trữ khác.

Xem danh sách đầy đủ các hàm có trong tệp WORKSPACE.

Những thiếu sót của hệ thống WORKSPACE

Trong những năm kể từ khi hệ thống WORKSPACE ra mắt, người dùng đã báo cáo nhiều vấn đề, bao gồm:

  • Bazel không đánh giá tệp WORKSPACE của bất kỳ phần phụ thuộc nào. Vì vậy, ngoài các phần phụ thuộc trực tiếp, bạn phải xác định tất cả các phần phụ thuộc bắc cầu trong tệp WORKSPACE của kho lưu trữ chính.
  • Để giải quyết vấn đề này, các dự án đã áp dụng mẫu "deps.bzl", trong đó, các dự án xác định một macro xác định nhiều kho lưu trữ và yêu cầu người dùng gọi macro này trong tệp WORKSPACE.
    • Cách này có những vấn đề riêng: macro không thể load các tệp .bzl khác, vì vậy, các dự án này phải xác định các phần phụ thuộc bắc cầu của chúng trong macro "deps" này hoặc giải quyết vấn đề bằng cách yêu cầu người dùng gọi nhiều macro "deps" lớp.
    • Bazel đánh giá tệp WORKSPACE theo tuần tự. Ngoài ra, các phần phụ thuộc được chỉ định bằng http_archive với URL mà không có bất kỳ thông tin phiên bản nào. Điều này có nghĩa là không có cách nào đáng tin cậy để thực hiện việc phân giải phiên bản trong trường hợp phần phụ thuộc kim cương (A phụ thuộc vào B và C; cả B và C phụ thuộc vào các phiên bản khác nhau của D).

Do những thiếu sót của WORKSPACE, Bzlmod sẽ thay thế hệ thống WORKSPACE cũ trong các bản phát hành Bazel sau này. Vui lòng đọc hướng dẫn di chuyển sang Bzlmod để biết cách di chuyển sang Bzlmod.