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) được sử dụng trong bản dựng 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 kho lưu trữ GitHub, cấu phần phần mềm Maven hoặc thư mục trên máy cục bộ của bạn bên ngoài không gian làm việc hiện tại.
Tài liệu này cung cấp thông tin tổng quan về hệ thống trước khi xem xét một số khái niệm chi tiết hơn.
Tổng quan về hệ thống
Hệ thống phần phụ thuộc bên ngoài của Bazel hoạt động dựa trên các mô-đun Bazel, mỗi mô-đun là một dự án Bazel có phiên bản và kho lưu trữ (hoặc repo), là các cây thư mục chứa tệp nguồn.
Bazel bắt đầu từ mô-đun gốc – tức là dự án bạn đang làm việc.
Giống như tất cả các mô-đun, mô-đun này cần có tệp MODULE.bazel ở thư mục gốc, khai báo siêu dữ liệu cơ bản và các phần phụ thuộc trực tiếp. Sau đây là một ví dụ cơ bản:
module(name = "my-module", version = "1.0")
bazel_dep(name = "rules_cc", version = "0.1.1")
bazel_dep(name = "platforms", version = "0.0.11")
Từ đó, Bazel tra cứu tất cả các mô-đun phần phụ thuộc bắc cầu trong một Cơ sở đăng ký Bazel – theo mặc định là Cơ sở đăng ký trung tâm Bazel. Cấu phần đăng ký cung cấp các tệp MODULE.bazel của 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 mỗi mô-đun – tức là cách tìm nạp nguồn cho mỗi mô-đun phần phụ thuộc. Trong hầu hết các trường hợp, đây chỉ là các tệp lưu trữ được tải xuống từ Internet và được trích xuất.
Mô-đun cũng có thể chỉ định các phần dữ liệu tuỳ chỉnh được gọi là thẻ. Các phần dữ liệu này đượ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ó thể thực hiện các thao tác như I/O tệp và gửi yêu cầu mạng. Ngoài ra, các mô-đun này cho phép Bazel tương tác với các hệ thống quản lý gói khác, đồng thời tuân theo biểu đồ phần phụ thuộc được tạo từ các mô-đun Bazel.
Ba loại kho lưu trữ – kho lưu trữ chính (là cây nguồn mà bạn đang làm việc), kho lưu trữ đại diện cho các mô-đun phần phụ thuộc bắc cầu và kho lưu trữ do các tiện ích mô-đun tạo – cùng nhau tạo thành không gian làm việc.
Các kho lưu trữ bên ngoài (không phải kho lưu trữ chính) được tìm nạp theo yêu cầu, chẳng hạn như khi các kho lưu trữ này được tham chiếu bằng nhãn (như @repo//pkg:target) trong tệp BUILD.
Lợi ích
Hệ thống phần phụ thuộc bên ngoài của Bazel mang lại nhiều lợi ích.
Tự động phân giải phần phụ thuộc
- Giải quyết phiên bản có tính xác định: Bazel sử dụng thuật toán giải quyết phiên bản MVS có tính xác định, giảm thiểu xung đột và giải quyết các vấn đề về phần phụ thuộc kim cương.
- Đơn giản hoá việc quản lý phần phụ thuộc:
MODULE.bazelchỉ khai báo các phần phụ thuộc trực tiếp, trong khi các phần phụ thuộc bắc cầu được tự động phân giải, cung cấp thông tin tổng quan rõ ràng hơn về các phần phụ thuộc của dự án. - Chế độ hiển thị phần phụ thuộc nghiêm ngặt: Chỉ các phần phụ thuộc trực tiếp mới hiển thị, đảm bảo tính chính xác và khả năng dự đoán.
Tích hợp hệ sinh thái
- Cơ quan đăng ký trung tâm Bazel: Một kho lưu trữ tập trung để khám phá và quản lý các phần phụ thuộc phổ biến dưới dạng mô-đun Bazel.
- Sử dụng các dự án không phải Bazel: Khi một dự án không phải Bazel (thường là thư viện C++) được điều chỉnh cho phù hợp với Bazel và được cung cấp trong BCR, dự án đó sẽ đơn giản hoá việc tích hợp cho toàn bộ cộng đồng, đồng thời loại bỏ các nỗ lực trùng lặp và xung đột của các tệp BUILD tuỳ chỉnh.
- Tích hợp hợp nhất với Trình quản lý gói dành riêng cho ngôn ngữ: Các bộ quy tắc giúp đơn giản hoá việc tích hợp với trình quản lý gói bên ngoài cho các phần phụ thuộc không phải Bazel, bao gồm:
- rules_jvm_external cho Maven,
- rules_python cho PyPi,
- bazel-gazelle cho Mô-đun Go,
- rules_rust cho Cargo.
Tính năng nâng cao
- Tiện ích mô-đun: Các tính năng
use_repo_rulevà tiện ích mô-đun cho phép sử dụng linh hoạt các quy tắc kho lưu trữ tuỳ chỉnh và logic phân giải để giới thiệu mọi phần phụ thuộc không phải Bazel. - Lệnh
bazel mod: Lệnh con cung cấp các cách hiệu quả để kiểm tra các phần phụ thuộc bên ngoài. Bạn biết chính xác cách xác định phần phụ thuộc bên ngoài và nguồn gốc của phần phụ thuộc đó. - Chế độ nhà cung cấp: Tìm nạp trước các phần phụ thuộc bên ngoài chính xác mà bạn cần để hỗ trợ các bản dựng ngoại tuyến.
- Lockfile: Tệp khoá giúp cải thiện khả năng tái tạo bản dựng và tăng tốc độ phân giải phần phụ thuộc.
- (Sắp ra mắt) Chứng thực nguồn gốc BCR: Tăng cường bảo mật chuỗi cung ứng bằng cách đảm bảo nguồn gốc đã xác minh của các phần phụ thuộc.
Khái niệm
Phần này cung cấp thêm thông tin chi tiết về các khái niệm liên quan đến phần phụ thuộc bên ngoài.
Mô-đun
Một dự án Bazel có thể có nhiều phiên bản, mỗi phiên bản có thể có các phần phụ thuộc trên các mô-đun khác.
Trong không gian làm việc Bazel cục bộ, một mô-đun được biểu thị bằng một kho lưu trữ.
Để biết thêm thông tin, hãy xem phần Mô-đun Bazel.
Kho lưu trữ
Cây thư mục có tệp điểm đánh dấu ranh giới ở thư mục gốc, chứa các tệp nguồn có thể dùng trong bản dựng Bazel. Thường được rút gọn thành repo.
Tệp điểm đánh dấu ranh giới kho lưu trữ có thể là MODULE.bazel (cho biết kho lưu trữ này đại diện cho một 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 điểm đánh dấu ranh giới kho lưu trữ sẽ biểu thị ranh giới của 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ữ đang chạy lệnh Bazel hiện tại.
Phần gốc của kho lưu trữ chính còn được gọi là gốc không gian làm việc.
Workspace
Môi trường được chia sẻ bởi tất cả các lệnh Bazel chạy trong cùng một kho lưu trữ chính. Thư mục 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" đã bị lẫn lộn; thuật ngữ "không gian làm việc" thường được dùng để chỉ kho lưu trữ chính và đôi khi thậm chí còn được dùng làm từ đồng nghĩa của "kho lưu trữ".
Tên kho lưu trữ chuẩn
Tên chuẩn hoá mà một kho lưu trữ có thể được định địa chỉ. Trong ngữ cảnh của một
không gian làm việc, mỗi kho lưu trữ có một tên chuẩn duy nhất. Bạn có thể sử dụng nhãn @@canonical_name//package:target (lưu ý dấu @ đôi) để truy cập vào một mục tiêu bên trong kho lưu trữ có tên chính tắc là canonical_name.
Kho lưu trữ chính luôn có chuỗi trống làm tên chuẩn.
Tên kho lưu trữ hiển thị
Tên của một kho lưu trữ có thể được định địa chỉ trong ngữ cảnh của một kho lưu trữ khác.
Bạn có thể coi đây là "biệt hiệu" của kho lưu trữ: Kho lưu trữ có tên chuẩn hoá michael có thể có tên hiển thị là mike trong ngữ cảnh của kho lưu trữ alice, nhưng có thể có tên hiển thị là mickey trong ngữ cảnh của kho lưu trữ bob. Trong trường hợp này, một mục tiêu bên trong michael có thể được gắn nhãn bằng @mike//package:target trong ngữ cảnh của alice (lưu ý @ đơn).
Ngược lại, bạn có thể hiểu đây là một lớp ánh xạ kho lưu trữ: mỗi kho lưu trữ duy trì một lớp ánh xạ từ "tên kho lưu trữ hiển thị" đến "tên kho lưu trữ chuẩn".
Quy tắc kho lưu trữ
Giản đồ cho các định nghĩa kho lưu trữ cho Bazel biết cách hiện thực hoá một kho lưu trữ. Ví dụ: có thể là "tải một tệp lưu trữ zip xuống từ một URL nhất định và 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 chỉ đơn giản là "đường liên kết tượng trưng 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.
Hãy xem phần Quy tắc kho lưu trữ để biết thêm thông tin về cách viết quy tắc kho lưu trữ của riêng bạn.
Cho đến nay, các quy tắc kho lưu trữ phổ biến nhất là http_archive, giúp tải một tệp lưu trữ xuống từ một URL và giải nén tệp lưu trữ đó, cũng như local_repository, giúp liên kết tượng trưng một thư mục cục bộ đã là kho lưu trữ Bazel.
Tìm nạp kho lưu trữ
Thao tác cung cấp kho lưu trữ 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 không gian làm việc sẽ không có 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 một nội dung nào đó từ kho lưu trữ và kho lưu trữ đó chưa được tìm nạp. Nếu kho lưu trữ đã được tìm nạp trước đó, Bazel sẽ chỉ tìm nạp lại kho lưu trữ đó 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 cho một 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 tạo bản dựng ngoại tuyến bằ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 thuộc tính này là true.
Tuy nhiên, khi được đặt thành false (--nofetch), lệnh này sẽ sử dụng mọi phiên bản 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.
Hãy xem các tuỳ chọn tìm nạp để biết thêm thông tin về cách kiểm soát tính năng tìm nạp.
Bố cục thư mục
Sau khi được tìm nạp, bạn có thể tìm thấy kho lưu trữ này trong thư mục con external trong
cơ sở đầu ra, theo tên chuẩn của kho lưu trữ.
Bạn có thể chạy lệnh sau để xem nội dung của kho lưu trữ có tên chuẩn canonical_name:
ls $(bazel info output_base)/external/ canonical_name Tệp REPO.bazel
Tệp REPO.bazel được dùng để đánh dấu ranh giới trên cùng của cây thư mục tạo 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 để đóng vai trò là 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ả 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. Hàm 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() cũng làm tương tự 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ả cá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"],
)
Hệ thống WORKSPACE cũ
Trong các phiên bản Bazel cũ (trước phiên bản 9.0), các phần phụ thuộc bên ngoài được giới thiệu bằng cách xác định kho lưu trữ trong tệp WORKSPACE (hoặc WORKSPACE.bazel). Tệp này có cú pháp tương tự như các tệp BUILD, sử dụng các quy tắc kho lưu trữ thay vì các quy tắc bản dựng.
Đoạn mã sau đây là 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ã này xác định một kho lưu trữ có tên chính tắc là foo. Trong hệ thống WORKSPACE, theo mặc định, tên chính tắc của một kho lưu trữ cũng là tên hiển thị của kho lưu trữ đó đối với 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.
Điểm yếu của hệ thống WORKSPACE
Trong những năm sau khi hệ thống WORKSPACE được giới thiệu, người dùng đã báo cáo nhiều vấn đề, bao gồm:
- Bazel không đánh giá các tệp
WORKSPACEcủa bất kỳ phần phụ thuộc nào, vì vậy, tất cả các phần phụ thuộc bắc cầu phải được xác định trong tệpWORKSPACEcủa kho lưu trữ chính, ngoài các phần phụ thuộc trực tiếp. - Để giải quyết vấn đề này, các dự án đã sử dụng mẫu "deps.bzl", trong đó xác định một macro, từ đó 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.- Điều này cũng có những vấn đề riêng: các macro không thể
loadcác tệp.bzlkhá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 trong macro "phần phụ thuộc" này hoặc giải quyết vấn đề này bằng cách yêu cầu người dùng gọi nhiều macro "phần phụ thuộc" theo lớp. - Bazel đánh giá tệp
WORKSPACEtheo tuần tự. Ngoài ra, các phần phụ thuộc được chỉ định bằnghttp_archivevớ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 các phần phụ thuộc kim cương (Aphụ thuộc vàoBvàC;BvàCđều phụ thuộc vào các phiên bản khác nhau củaD).
- Điều này cũng có những vấn đề riêng: các macro không thể
Do những hạn chế của WORKSPACE, hệ thống mới dựa trên mô-đun (có tên mã là "Bzlmod") đã dần thay thế hệ thống WORKSPACE cũ giữa Bazel 6 và 9. Đọc hướng dẫn di chuyển Bzlmod về cách di chuyển sang Bzlmod.