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.

Quy tắc của Workspace

Các quy tắc của không gian làm việc được dùng để lấy các phần phụ thuộc bên ngoài, thường là mã nguồn nằm bên ngoài kho lưu trữ chính.

Lưu ý: bên cạnh các quy tắc không gian làm việc gốc, Bazel còn nhúng nhiều Quy tắc không gian làm việc của Starlark, đặc biệt là những quy tắc giao dịch với kho lưu trữ git hoặc các bản lưu trữ được lưu trữ trên web.

liên kết

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

Cảnh báo: bạn không nên sử dụng bind(). Hãy xem phần "Cân nhắc xoá liên kết" để thảo luận về các vấn đề và giải pháp thay thế. Cụ thể, hãy cân nhắc việc sử dụng repo_mapping các thuộc tính của kho lưu trữ.

Cảnh báo: Không thể sử dụng select() trong bind(). Xem Câu hỏi thường gặp về Thuộc tính có thể định cấu hình để chi tiết.

Cấp cho một mục tiêu một bí danh trong gói //external.

Gói //external không phải là một gói "bình thường": không có thư mục bên ngoài, nên bạn có thể coi đây là một "gói ảo" chứa tất cả các mục tiêu đã liên kết.

Ví dụ

Để đặt bí danh cho một mục tiêu, hãy bind mục tiêu đó trong tệp WORKSPACE. Ví dụ: giả sử có một mục tiêu java_library được gọi là //third_party/javacc-v2. Bạn có thể đặt bí danh cho biến này bằng cách thêm nội dung sau vào tệp WORKSPACE:

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

Các mục tiêu hiện có thể phụ thuộc vào //external:javacc-latest thay vì //third_party/javacc-v2. Nếu javacc-v3 được phát hành, thì quy tắc bind có thể là được cập nhật và tất cả các tệp BUILD phụ thuộc vào //external:javacc-latest hiện sẽ phụ thuộc vào javacc-v3 mà không cần chỉnh sửa.

Bạn cũng có thể sử dụng tính năng liên kết để cung cấp các mục tiêu trong kho lưu trữ bên ngoài cho không gian làm việc của mình. Ví dụ: nếu có một kho lưu trữ từ xa có tên là @my-ssl được nhập trong Tệp WORKSPACE và tệp này có mục tiêu cc_library là //src:openssl-lib, bạn có thể tạo bí danh cho mục tiêu này bằng bind:

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

Sau đó, trong tệp BUILD trong không gian làm việc, bạn có thể sử dụng mục tiêu liên kết như sau:

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

Trong sign_in.cc và sign_in.h, bạn có thể tham chiếu đến các tệp tiêu đề do //external:openssl hiển thị bằng cách sử dụng đường dẫn tương ứng với thư mục gốc của kho lưu trữ. Ví dụ: nếu định nghĩa quy tắc cho @my-ssl//src:openssl-lib có dạng như sau:

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

Sau đó, phần bao gồm của sign_in.cc có thể có dạng như sau:

#include "sign_in.h"
#include "src/openssl.h"

Đối số

Thuộc tính

name

Name; required

Tên duy nhất cho mục tiêu này.

actual

Label; optional

Mục tiêu được đặt bí danh.

Mục tiêu này phải tồn tại, nhưng có thể là bất kỳ loại quy tắc nào (bao gồm cả liên kết).

Nếu thuộc tính này bị bỏ qua, các quy tắc tham chiếu đến mục tiêu này trong //external sẽ không thấy cạnh phần phụ thuộc này. Lưu ý rằng việc này khác với việc bỏ qua hoàn toàn quy tắc bind: đó là lỗi nếu phần phụ thuộc //external không có quy tắc bind liên kết.

local_repository

local_repository(name, path, repo_mapping)

Cho phép liên kết các mục tiêu từ một thư mục cục bộ. Điều này có nghĩa là kho lưu trữ hiện tại có thể sử dụng các mục tiêu được xác định trong thư mục khác này. Hãy xem phần liên kết để biết thêm thông tin chi tiết.

Ví dụ

Giả sử kho lưu trữ hiện tại là một ứng dụng trò chuyện, được lưu trữ tại thư mục ~/chat-app. Ứng dụng này muốn sử dụng một thư viện SSL được xác định trong một kho lưu trữ khác: ~/ssl. Thư viện SSL có một mục tiêu //src:openssl-lib.

Người dùng có thể thêm phần phụ thuộc vào mục tiêu này bằng cách thêm các dòng sau vào ~/chat-app/WORKSPACE:

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

Các mục tiêu sẽ chỉ định @my-ssl//src:openssl-lib làm phần phụ thuộc để phụ thuộc vào điều này thư viện của bạn.

Đối số

Thuộc tính

name

Name; required

Tên duy nhất cho mục tiêu này.

path

String; required

Đường dẫn đến thư mục của kho lưu trữ cục bộ.

Đây phải là đường dẫn đến thư mục chứa WORKSPACE. Đường dẫn có thể tuyệt đối hoặc tương đối so với kho lưu trữ chính WORKSPACE.

repo_mapping

Dictionary: String -> String; optional

Một từ điển từ tên kho lưu trữ cục bộ thành tên kho lưu trữ toàn cục. Điều này cho phép kiểm soát việc phân giải phần phụ thuộc của không gian làm việc cho các phần phụ thuộc của kho lưu trữ này.

Ví dụ: mục nhập "@foo": "@bar" khai báo rằng, bất cứ lúc nào điều này kho lưu trữ phụ thuộc vào "@foo" (chẳng hạn như phần phụ thuộc trên "@foo//some:target"), thì tệp này sẽ giải quyết phần phụ thuộc đó trong "@bar" ("@bar//some:target") được khai báo toàn cầu.

new_local_repository

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

Cho phép chuyển đổi một thư mục cục bộ thành kho lưu trữ Bazel. Điều này có nghĩa là giá trị kho lưu trữ có thể xác định và sử dụng các mục tiêu từ bất kỳ vị trí nào trên hệ thống tệp.

Quy tắc này tạo một kho lưu trữ Bazel bằng cách tạo một tệp WORKSPACE và thư mục con chứa liên kết tượng trưng đến tệp BUILD và đường dẫn đã cho. Tệp bản dựng sẽ tạo các mục tiêu tương ứng với path. Đối với các thư mục đã chứa tệp WORKSPACE và tệp BUILD, giá trị Bạn có thể sử dụng quy tắc local_repository.

Ví dụ

Giả sử kho lưu trữ hiện tại là một ứng dụng trò chuyện, đã bị can thiệp vào hệ thống tại thư mục ~/chat-app. Nó muốn sử dụng thư viện SSL được xác định trong một thư mục khác: ~/ssl.

Người dùng có thể thêm phần phụ thuộc bằng cách tạo tệp BUILD cho thư viện SSL (~/chat-app/BUILD.my-ssl) có chứa:

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

Sau đó, họ có thể thêm các dòng sau vào ~/chat-app/WORKSPACE:

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

Thao tác này sẽ tạo một kho lưu trữ @my-ssl liên kết các liên kết đến /home/user/ssl. Các mục tiêu có thể phụ thuộc vào thư viện này bằng cách thêm @my-ssl//:openssl vào phần phụ thuộc của mục tiêu.

Bạn cũng có thể dùng new_local_repository để đưa vào các tệp đơn lẻ, chứ không chỉ . Ví dụ: giả sử bạn có một tệp jar tại /home/username/Downloads/piano.jar. Bạn chỉ cần thêm tệp đó vào bản dựng bằng cách thêm nội dung sau vào tệp WORKSPACE:

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

Và tạo tệp BUILD.piano sau đây:

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

Sau đó, các mục tiêu có thể phụ thuộc vào @piano//:play-music để sử dụng piano.jar.

Đối số

Thuộc tính
`name`	`Name; required` Tên duy nhất cho mục tiêu này.
`build_file`	`String; optional` Tệp dùng làm tệp BUILD cho thư mục này. Bạn phải chỉ định build_file hoặc build_file_content. Thuộc tính này là một nhãn liên quan đến không gian làm việc chính. Tệp không cần phải có tên là BUILD, nhưng cũng có thể. (Một cái gì đó như BUILD.new-repo-name có thể hoạt động tốt đối với phân biệt với tệp BUILD thực tế của kho lưu trữ.)
`build_file_content`	`String; optional` Nội dung của tệp BUILD cho kho lưu trữ này. Bạn phải chỉ định build_file hoặc build_file_content.
`path`	`String; required` Một đường dẫn trên hệ thống tệp cục bộ. Giá trị này có thể là tuyệt đối hoặc tương đối so với tệp WORKSPACE của kho lưu trữ chính.
`repo_mapping`	`Dictionary: String -> String; optional` Từ điển từ tên kho lưu trữ cục bộ đến tên kho lưu trữ toàn cục. Điều này cho phép kiểm soát giải pháp phần phụ thuộc Workspace cho các phần phụ thuộc của kho lưu trữ này. Ví dụ: mục `"@foo": "@bar"` khai báo rằng, bất cứ khi nào kho lưu trữ này phụ thuộc vào `"@foo"` (chẳng hạn như phần phụ thuộc trên `"@foo//some:target"`), kho lưu trữ này sẽ thực sự phân giải phần phụ thuộc đó trong `"@bar"` được khai báo trên toàn cục (`"@bar//some:target"`).
`workspace_file`	`String; optional` Tệp dùng làm tệp WORKSPACE cho kho lưu trữ này. Bạn chỉ có thể chỉ định workspace_file hoặc workspace_file_content, nhưng không thể chỉ định cả hai. Thuộc tính này là một nhãn tương ứng với không gian làm việc chính. Bạn không cần đặt tên tệp là WORKSPACE, nhưng có thể đặt tên như vậy. (Một dịch vụ như WORKSPACE.new-repo-name có thể hoạt động hiệu quả đối với phân biệt với các tệp WORKSPACE thực tế của kho lưu trữ.)
`workspace_file_content`	`String; optional` Nội dung của tệp WORKSPACE cho kho lưu trữ này. Bạn có thể chỉ định workspace_file hoặc workspace_file_content, nhưng không được chỉ định cả hai.