Chương trình đăng ký tham gia sự kiện BazelCon 2024 đã bắt đầu!

Trang này được dịch bởi Cloud Translation API.

Làm việc với các phần phụ thuộc bên ngoài

Báo cáo vấn đề Xem nguồn Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel có thể phụ thuộc vào các mục tiêu của các dự án khác. Các phần phụ thuộc từ các dự án khác này được gọi là phần phụ thuộc bên ngoài.

Tệp WORKSPACE (hoặc tệp WORKSPACE.bazel) trong thư mục không gian làm việc sẽ cho Bazel biết cách lấy nguồn của các dự án khác. Các dự án khác này có thể chứa một hoặc nhiều tệp BUILD với các mục tiêu riêng. Các tệp BUILD trong dự án chính có thể phụ thuộc vào các mục tiêu bên ngoài này bằng cách sử dụng tên của các mục tiêu đó trong tệp WORKSPACE.

Ví dụ: giả sử có hai dự án trên một hệ thống:

/
  home/
    user/
      project1/
        WORKSPACE
        BUILD
        srcs/
          ...
      project2/
        WORKSPACE
        BUILD
        my-libs/

Nếu project1 muốn phụ thuộc vào một mục tiêu, :foo, được xác định trong /home/user/project2/BUILD, thì bạn có thể chỉ định rằng có thể tìm thấy kho lưu trữ có tên project2 tại /home/user/project2. Sau đó, các mục tiêu trong /home/user/project1/BUILD có thể phụ thuộc vào @project2//:foo.

Tệp WORKSPACE cho phép người dùng phụ thuộc vào các mục tiêu từ các phần khác của hệ thống tệp hoặc được tải xuống từ Internet. Tệp này sử dụng cùng một cú pháp như tệp BUILD, nhưng cho phép một bộ quy tắc khác được gọi là quy tắc kho lưu trữ (đôi khi còn gọi là quy tắc không gian làm việc). Bazel đi kèm với một số quy tắc tích hợp sẵn cho kho lưu trữ và một bộ quy tắc tích hợp sẵn cho kho lưu trữ Starlark. Người dùng cũng có thể viết quy tắc kho lưu trữ tuỳ chỉnh để có hành vi phức tạp hơn.

Các loại phần phụ thuộc bên ngoài được hỗ trợ

Bạn có thể sử dụng một số loại phần phụ thuộc bên ngoài cơ bản sau:

Phần phụ thuộc trên các dự án Bazel khác
Phần phụ thuộc trên các dự án không phải Bazel
Phần phụ thuộc trên các gói bên ngoài

Tuỳ thuộc vào các dự án Bazel khác

Nếu muốn sử dụng các mục tiêu từ dự án Bazel thứ hai, bạn có thể sử dụng local_repository, git_repository hoặc http_archive để liên kết tượng trưng mục tiêu đó từ hệ thống tệp cục bộ, tham chiếu kho lưu trữ git hoặc tải mục tiêu đó xuống (tương ứng).

Ví dụ: giả sử bạn đang làm việc trên một dự án, my-project/, và bạn muốn phụ thuộc vào các mục tiêu từ dự án của đồng nghiệp, coworkers-project/. Cả hai dự án đều sử dụng Bazel, vì vậy, bạn có thể thêm dự án của đồng nghiệp làm phần phụ thuộc bên ngoài, sau đó sử dụng mọi mục tiêu mà đồng nghiệp đã xác định từ các tệp BUILD của riêng bạn. Bạn sẽ thêm nội dung sau vào my_project/WORKSPACE:

local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
)

Nếu đồng nghiệp của bạn có mục tiêu //foo:bar, thì dự án của bạn có thể tham chiếu đến mục tiêu đó là @coworkers_project//foo:bar. Tên dự án bên ngoài phải là tên không gian làm việc hợp lệ.

Tuỳ thuộc vào các dự án không phải Bazel

Các quy tắc có tiền tố new_, chẳng hạn như new_local_repository, cho phép bạn tạo mục tiêu từ các dự án không sử dụng Bazel.

Ví dụ: giả sử bạn đang làm việc trên một dự án, my-project/, và bạn muốn phụ thuộc vào dự án của đồng nghiệp, coworkers-project/. Dự án của đồng nghiệp sử dụng make để tạo bản dựng, nhưng bạn muốn phụ thuộc vào một trong các tệp .so mà dự án đó tạo ra. Để thực hiện việc này, hãy thêm nội dung sau vào my_project/WORKSPACE:

new_local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
    build_file = "coworker.BUILD",
)

build_file chỉ định một tệp BUILD để phủ lên dự án hiện có, ví dụ:

cc_library(
    name = "some-lib",
    srcs = glob(["**"]),
    visibility = ["//visibility:public"],
)

Sau đó, bạn có thể phụ thuộc vào @coworkers_project//:some-lib từ các tệp BUILD của dự án.

Tuỳ thuộc vào các gói bên ngoài

Cấu phần phần mềm và kho lưu trữ Maven

Sử dụng bộ quy tắc rules_jvm_external để tải các cấu phần phần mềm xuống từ kho lưu trữ Maven và cung cấp các cấu phần phần mềm đó dưới dạng phần phụ thuộc Java.

Tìm nạp phần phụ thuộc

Theo mặc định, các phần phụ thuộc bên ngoài được tìm nạp khi cần trong bazel build. Nếu bạn muốn tải trước các phần phụ thuộc cần thiết cho một nhóm mục tiêu cụ thể, hãy sử dụng bazel fetch. Để tìm nạp tất cả phần phụ thuộc bên ngoài một cách vô điều kiện, hãy sử dụng bazel sync. Vì các kho lưu trữ được tìm nạp được lưu trữ trong cơ sở đầu ra, nên quá trình tìm nạp sẽ diễn ra trên mỗi không gian làm việc.

Phần phụ thuộc bóng

Bất cứ khi nào có thể, bạn nên có một chính sách phiên bản duy nhất trong dự án. Điều này là bắt buộc đối với các phần phụ thuộc mà bạn biên dịch và kết thúc trong tệp nhị phân cuối cùng. Tuy nhiên, đối với các trường hợp không đúng như vậy, bạn có thể che các phần phụ thuộc. Hãy xem xét trường hợp sau:

myproject/WORKSPACE

workspace(name = "myproject")

local_repository(
    name = "A",
    path = "../A",
)
local_repository(
    name = "B",
    path = "../B",
)

A/WORKSPACE

workspace(name = "A")

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

B/WORKSPACE

workspace(name = "B")

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

Cả hai phần phụ thuộc A và B đều phụ thuộc vào testrunner, nhưng chúng phụ thuộc vào các phiên bản khác nhau của testrunner. Không có lý do gì khiến các trình chạy kiểm thử này không thể cùng tồn tại trong myproject, tuy nhiên, chúng sẽ xung đột với nhau vì có cùng tên. Để khai báo cả hai phần phụ thuộc, hãy cập nhật myproject/WORKSPACE:

workspace(name = "myproject")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner-v1",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "..."
)
http_archive(
    name = "testrunner-v2",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)
local_repository(
    name = "A",
    path = "../A",
    repo_mapping = {"@testrunner" : "@testrunner-v1"}
)
local_repository(
    name = "B",
    path = "../B",
    repo_mapping = {"@testrunner" : "@testrunner-v2"}
)

Bạn cũng có thể sử dụng cơ chế này để kết hợp các kim cương. Ví dụ: nếu A và B có cùng một phần phụ thuộc nhưng gọi phần phụ thuộc đó bằng các tên khác nhau, thì các phần phụ thuộc đó có thể được kết hợp trong myproject/WORKSPACE.

Ghi đè kho lưu trữ từ dòng lệnh

Để ghi đè kho lưu trữ đã khai báo bằng kho lưu trữ cục bộ từ dòng lệnh, hãy sử dụng cờ --override_repository. Việc sử dụng cờ này sẽ thay đổi nội dung của các kho lưu trữ bên ngoài mà không thay đổi mã nguồn của bạn.

Ví dụ: để ghi đè @foo vào thư mục cục bộ /path/to/local/foo, hãy truyền cờ --override_repository=foo=/path/to/local/foo.

Sau đây là một số trường hợp sử dụng:

Các vấn đề về gỡ lỗi. Ví dụ: bạn có thể ghi đè kho lưu trữ http_archive vào một thư mục cục bộ để dễ dàng thực hiện các thay đổi.
Nhà cung cấp. Nếu bạn đang ở trong môi trường không thể thực hiện lệnh gọi mạng, hãy ghi đè các quy tắc kho lưu trữ dựa trên mạng để trỏ đến các thư mục cục bộ.

Sử dụng proxy

Bazel sẽ nhận địa chỉ proxy từ các biến môi trường HTTPS_PROXY và HTTP_PROXY và sử dụng các địa chỉ này để tải tệp HTTP/HTTPS xuống (nếu được chỉ định).

Hỗ trợ IPv6

Trên các máy chỉ có IPv6, Bazel sẽ có thể tải các phần phụ thuộc xuống mà không cần thay đổi gì. Tuy nhiên, trên các máy IPv4/IPv6 có ngăn xếp kép, Bazel tuân theo quy ước giống như Java: nếu IPv4 được bật, thì IPv4 được ưu tiên. Trong một số trường hợp, chẳng hạn như khi mạng IPv4 không thể phân giải/truy cập vào địa chỉ bên ngoài, điều này có thể gây ra các ngoại lệ Network unreachable và lỗi bản dựng. Trong những trường hợp này, bạn có thể ghi đè hành vi của Bazel để ưu tiên IPv6 bằng cách sử dụng thuộc tính hệ thống java.net.preferIPv6Addresses=true. Cụ thể:

Sử dụng --host_jvm_args=-Djava.net.preferIPv6Addresses=true tuỳ chọn khởi động, ví dụ: bằng cách thêm dòng sau vào tệp .bazelrc:

startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true
Nếu bạn đang chạy các mục tiêu bản dựng Java cũng cần kết nối với Internet (đôi khi các kiểm thử tích hợp cần điều đó), hãy sử dụng cờ công cụ --jvmopt=-Djava.net.preferIPv6Addresses=true, ví dụ: bằng cách thêm dòng sau vào tệp .bazelrc:

build --jvmopt=-Djava.net.preferIPv6Addresses
Nếu bạn đang sử dụng rules_jvm_external, chẳng hạn như để phân giải phiên bản phần phụ thuộc, hãy thêm -Djava.net.preferIPv6Addresses=true vào biến môi trường COURSIER_OPTS để cung cấp các tuỳ chọn JVM cho Coursier

Phần phụ thuộc bắc cầu

Bazel chỉ đọc các phần phụ thuộc được liệt kê trong tệp WORKSPACE. Nếu dự án (A) của bạn phụ thuộc vào một dự án khác (B) liệt kê phần phụ thuộc trên một dự án thứ ba (C) trong tệp WORKSPACE, thì bạn sẽ phải thêm cả B và C vào tệp WORKSPACE của dự án. Yêu cầu này có thể làm tăng kích thước tệp WORKSPACE, nhưng hạn chế khả năng một thư viện bao gồm C ở phiên bản 1.0 và một thư viện khác bao gồm C ở phiên bản 2.0.

Lưu các phần phụ thuộc bên ngoài vào bộ nhớ đệm

Theo mặc định, Bazel sẽ chỉ tải lại các phần phụ thuộc bên ngoài nếu định nghĩa của các phần phụ thuộc đó thay đổi. Bazel cũng tính đến các thay đổi đối với tệp được tham chiếu trong định nghĩa (chẳng hạn như các tệp bản vá hoặc BUILD).

Để buộc tải xuống lại, hãy sử dụng bazel sync.

Bố cục

Tất cả phần phụ thuộc bên ngoài đều được tải xuống một thư mục trong thư mục con external trong cơ sở đầu ra. Trong trường hợp kho lưu trữ cục bộ, một đường liên kết tượng trưng sẽ được tạo tại đó thay vì tạo một thư mục mới. Bạn có thể xem thư mục external bằng cách chạy:

ls $(bazel info output_base)/external

Xin lưu ý rằng việc chạy bazel clean sẽ không thực sự xoá thư mục bên ngoài. Để xoá tất cả cấu phần phần mềm bên ngoài, hãy sử dụng bazel clean --expunge.

Bản dựng ngoại tuyến

Đôi khi, bạn nên hoặc cần chạy bản dựng ở chế độ ngoại tuyến. Đối với các trường hợp sử dụng đơn giản, chẳng hạn như khi đi máy bay, bạn có thể chỉ cần prefetching các kho lưu trữ cần thiết bằng bazel fetch hoặc bazel sync; hơn nữa, khi sử dụng tuỳ chọn --nofetch, bạn có thể tắt tính năng tìm nạp các kho lưu trữ khác trong quá trình tạo bản dựng.

Đối với các bản dựng ngoại tuyến thực sự, trong đó một thực thể khác với bazel sẽ cung cấp các tệp cần thiết, bazel hỗ trợ tuỳ chọn --distdir. Bất cứ khi nào một quy tắc kho lưu trữ yêu cầu bazel tìm nạp tệp thông qua ctx.download hoặc ctx.download_and_extract và cung cấp tổng băm của tệp cần thiết, trước tiên, bazel sẽ xem xét các thư mục do tuỳ chọn đó chỉ định cho một tệp khớp với tên cơ sở của URL đầu tiên được cung cấp và sử dụng bản sao cục bộ đó nếu hàm băm khớp.

Bản thân Bazel sử dụng kỹ thuật này để khởi động từ xa từ cấu phần phần mềm phân phối. Công cụ này thực hiện việc này bằng cách thu thập tất cả các phần phụ thuộc bên ngoài cần thiết trong một distdir_tar nội bộ.

Tuy nhiên, bazel cho phép thực thi các lệnh tuỳ ý trong quy tắc kho lưu trữ mà không biết liệu các lệnh đó có gọi đến mạng hay không. Do đó, bazel không có lựa chọn nào để buộc các bản dựng hoàn toàn ngoại tuyến. Vì vậy, để kiểm thử xem một bản dựng có hoạt động chính xác khi không có mạng hay không, bạn cần chặn mạng bên ngoài, như bazel thực hiện trong kiểm thử khởi động.

Các phương pháp hay nhất

Quy tắc kho lưu trữ

Quy tắc kho lưu trữ thường chịu trách nhiệm về:

Phát hiện các chế độ cài đặt hệ thống và ghi các chế độ cài đặt đó vào tệp.
Tìm tài nguyên ở nơi khác trên hệ thống.
Tải tài nguyên xuống từ URL.
Tạo hoặc liên kết tượng trưng các tệp BUILD vào thư mục kho lưu trữ bên ngoài.

Tránh sử dụng repository_ctx.execute khi có thể. Ví dụ: khi sử dụng một thư viện C++ không phải Bazel có bản dựng sử dụng Make, bạn nên sử dụng repository_ctx.download() rồi viết tệp BUILD để tạo bản dựng đó thay vì chạy ctx.execute(["make"]).

Ưu tiên http_archive hơn git_repository và new_git_repository. Lý do là:

Các quy tắc của kho lưu trữ Git phụ thuộc vào git(1) của hệ thống, trong khi trình tải xuống HTTP được tích hợp vào Bazel và không có phần phụ thuộc hệ thống.
http_archive hỗ trợ danh sách urls dưới dạng bản sao và git_repository chỉ hỗ trợ một remote.
http_archive hoạt động với bộ nhớ đệm kho lưu trữ, nhưng không hoạt động với git_repository. Hãy xem #5116 để biết thêm thông tin.

Không sử dụng bind(). Hãy xem phần "Cân nhắc việc xoá liên kết" để thảo luận về các vấn đề và giải pháp thay thế.