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

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Bazel hỗ trợ phần phụ thuộc bên ngoài, tệp nguồn (cả văn bản và nhị phân) được dùng trong bản dựng không thuộc không gian làm việc của bạn. Ví dụ: các tệp này có thể là một bộ quy tắc được lưu trữ trong 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.

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 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 kho lưu trữ) 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 mà bạn đang thực hiện. 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 sẽ tra cứu tất cả các mô-đun phần phụ thuộc bắc cầu trong một sổ đăng ký Bazel – theo mặc định là Sổ đăng ký Trung tâm Bazel. Sổ đăng ký cung cấp các tệp MODULE.bazel của phần phụ thuộc, cho phép Bazel phát hiện 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 từng mô-đun phần phụ thuộc. Hầu hết thời gian, đây chỉ là các tệp lưu trữ được tải xuống từ Internet và trích xuất.

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ó 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 những việc khác, các tiện ích 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 thủ biểu đồ phần phụ thuộc được xây dựng 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), các kho lưu trữ đại diện cho các mô-đun phần phụ thuộc bắc cầu và các kho lưu trữ do 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 (kho lưu trữ 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 chúng được nhãn tham chiếu (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

  • Phân giải phiên bản xác định: Bazel áp dụng thuật toán phân giải phiên bản MVS xác định, giảm thiểu xung đột và giải quyết các vấn đề về phần phụ thuộc hình kim cương.
  • Đơn giản hoá việc quản lý phần phụ thuộc: MODULE.bazel chỉ 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.
  • Khả năng 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

Tính năng nâng cao

  • Tiện ích mô-đun: Các use_repo_rule và tính năng 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.
  • bazel mod Lệnh: Lệnh con này cung cấp các cách mạnh mẽ để 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 để tạo điều kiện cho các bản dựng ngoại tuyến.
  • Tệp khoá: Tệp khoá 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ông tin chi tiết hơn 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 vào 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 chi tiết, hãy xem bài viết Mô-đun Bazel.

Kho lưu trữ

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

Tệp đá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. Bất kỳ tệp đánh dấu ranh giới kho lưu trữ nào cũng 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ữ mà lệnh Bazel hiện tại đang chạy.

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.

Không gian làm việc

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. Môi trường 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 trong lịch sử, các khái niệm về "kho lưu trữ" và "không gian làm việc" đã bị trộ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 dùng làm từ đồng nghĩa của "kho lưu trữ".

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

Tên mà một kho lưu trữ luôn có thể đị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ể định địa chỉ mục tiêu bên trong kho lưu trữ có tên chuẩn là canonical_name bằng nhãn @@canonical_name//package:target (lưu ý dấu @ kép).

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ữ biểu kiến

Tên mà một kho lưu trữ có thể đị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 michael có thể có tên biểu kiến mike trong ngữ cảnh của kho lưu trữ alice, nhưng có thể có tên biểu kiến mickey trong ngữ cảnh của kho lưu trữ bob. Trong trường hợp này, bạn có thể định địa chỉ mục tiêu bên trong michael bằng nhãn @mike//package:target trong ngữ cảnh của alice (lưu ý dấu @ đơn).

Ngược lại, bạn có thể hiểu đây là ánh xạ kho lưu trữ: mỗi kho lưu trữ duy trì một ánh xạ từ "tên kho lưu trữ biểu kiến" đến "tên kho lưu trữ chuẩn".

Quy tắc kho lưu trữ

Một lược đồ cho các định nghĩa kho lưu trữ cho biết Bazel cách hiện thực hoá một kho lưu trữ. Ví dụ: lược đồ này có thể là "tải một tệp lưu trữ zip xuống từ một URL nhất định và trích xuất 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à "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 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.

Các quy tắc kho lưu trữ phổ biến nhất cho đến nay là http_archive (tải một 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 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 cung cấp một kho lưu trữ trên ổ đĩa cục bộ bằng cách chạy quy tắc kho lưu trữ được 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 một thứ gì đó 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 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ả cá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 tuỳ chọn này là true. Tuy nhiên, khi được đặt thành false (--nofetch), lệnh 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 và nếu không có phiên bản nào tồn tại, lệnh 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 quá trình 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ữ 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 là 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 thành 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ể 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. 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 phổ biến cho tất cả các mục tiêu bản dựng bên trong gói, thì repo() cũng thực hiện tương tự cho tất cả cá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ũ hơn (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 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 kho lưu trữ 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ã này xác định một kho lưu trữ có tên chuẩn là foo. Trong hệ thống WORKSPACE, theo mặc định, tên chuẩn của một kho lưu trữ cũng là tên biểu kiến 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 WORKSPACE tệp.

Thiếu sót 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 điểm khó khă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, tất cả các phần phụ thuộc bắc cầu phải được xác định trong tệp WORKSPACE củ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 đã áp dụng mẫu "deps.bzl", trong đó các dự án xác định một macro, macro này lần lượ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ó 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 trong macro "deps" 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 "deps" theo 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 đáng tin cậy nào để thực hiện phân giải phiên bản trong trường hợp phần phụ thuộc hình kim cương (A phụ thuộc vào B và C; B và C đều 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, 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ũ từ Bazel 6 đến 9. Đọc hướng dẫn di chuyển Bzlmod để biết cách di chuyển sang Bzlmod.