Nhãn

Nhãn là giá trị nhận dạng cho một mục tiêu. Một nhãn điển hình ở dạng chính tắc đầy đủ sẽ có dạng như sau:

@@myrepo//my/app/main:app_binary

Phần đầu tiên của nhãn là tên kho lưu trữ, @@myrepo. Cú pháp @ kép cho biết đây là tên kho lưu trữ chính tắc, duy nhất trong không gian làm việc. Nhãn có tên kho lưu trữ chính tắc xác định rõ ràng một mục tiêu bất kể ngữ cảnh mà chúng xuất hiện.

Thông thường, tên kho lưu trữ chính tắc là một chuỗi khó hiểu có dạng như @@rules_java++toolchains+local_jdk. Điều thường thấy hơn nhiều là nhãn có tên kho lưu trữ hiển thị, có dạng như sau:

@myrepo//my/app/main:app_binary

Điểm khác biệt duy nhất là tên kho lưu trữ được thêm tiền tố bằng một @ thay vì hai. Điều này đề cập đến một kho lưu trữ có tên hiển thị là myrepo, có thể khác nhau tuỳ thuộc vào ngữ cảnh mà nhãn này xuất hiện.

Trong trường hợp điển hình là nhãn tham chiếu đến cùng một kho lưu trữ mà nhãn đó được sử dụng, thì phần tên kho lưu trữ có thể bị bỏ qua. Vì vậy, bên trong @@myrepo, nhãn đầu tiên thường được viết là

//my/app/main:app_binary

Phần thứ hai của nhãn là tên gói không đủ điều kiện my/app/main, đường dẫn đến gói tương ứng với thư mục gốc của kho lưu trữ. Cùng với nhau, tên kho lưu trữ và tên gói không đủ điều kiện tạo thành tên gói đủ điều kiện @@myrepo//my/app/main. Khi nhãn tham chiếu đến cùng một gói mà nhãn đó được sử dụng, thì tên gói (và dấu hai chấm, nếu có) có thể bị bỏ qua. Vì vậy, bên trong @@myrepo//my/app/main, nhãn này có thể được viết theo một trong những cách sau:

app_binary
:app_binary

Theo quy ước, dấu hai chấm bị bỏ qua đối với tệp, nhưng vẫn giữ lại đối với quy tắc, nhưng không có ý nghĩa gì khác.

Phần của nhãn sau dấu hai chấm, app_binary là tên mục tiêu không đủ điều kiện. Khi khớp với thành phần cuối cùng của đường dẫn gói, thì thành phần đó và dấu hai chấm có thể bị bỏ qua. Vì vậy, hai nhãn này tương đương nhau:

//my/app/lib
//my/app/lib:lib

Tên của mục tiêu tệp trong thư mục con của gói là đường dẫn của tệp tương ứng với thư mục gốc của gói (thư mục chứa tệp BUILD). Vì vậy, tệp này nằm trong thư mục con my/app/main/testdata của kho lưu trữ:

//my/app/main:testdata/input.txt

Các chuỗi như //my/app và @@some_repo//my/app có hai ý nghĩa tuỳ thuộc vào ngữ cảnh mà chúng được sử dụng: khi Bazel mong đợi một nhãn, chúng có nghĩa là //my/app:app và @@some_repo//my/app:app tương ứng. Tuy nhiên, khi Bazel mong đợi một gói (ví dụ: trong thông số kỹ thuật package_group), chúng sẽ tham chiếu đến gói chứa nhãn đó.

Lỗi thường gặp trong tệp BUILD là sử dụng //my/app để tham chiếu đến một gói hoặc đến tất cả mục tiêu trong một gói – điều này không xảy ra. Hãy nhớ rằng, nó tương đương với //my/app:app, vì vậy, nó đặt tên cho mục tiêu app trong gói my/app của kho lưu trữ hiện tại.

Tuy nhiên, bạn nên sử dụng //my/app để tham chiếu đến một gói trong thông số kỹ thuật của package_group hoặc trong tệp .bzl, vì nó cho biết rõ ràng rằng tên gói là tuyệt đối và nằm trong thư mục cấp cao nhất của không gian làm việc.

Không thể sử dụng nhãn tương đối để tham chiếu đến các mục tiêu trong các gói khác; trong trường hợp này, bạn phải luôn chỉ định giá trị nhận dạng kho lưu trữ và tên gói. Ví dụ: nếu cây nguồn chứa cả gói my/app và gói my/app/testdata (mỗi thư mục trong số này có tệp BUILD riêng), thì gói sau chứa một tệp có tên là testdepot.zip. Dưới đây là 2 cách (một cách sai, một cách đúng) để tham chiếu đến tệp này trong //my/app:BUILD:

Sai — testdata là một gói khác, vì vậy, bạn không thể sử dụng đường dẫn tương đối

testdata/testdepot.zip

Đúng – tham chiếu đến testdata bằng đường dẫn đầy đủ

//my/app/testdata:testdepot.zip

Các nhãn bắt đầu bằng @@// là các tham chiếu đến kho lưu trữ chính, vẫn hoạt động ngay cả từ các kho lưu trữ bên ngoài. Do đó, @@//a/b/c khác với //a/b/c khi được tham chiếu từ một kho lưu trữ bên ngoài. Nhãn trước tham chiếu trở lại kho lưu trữ chính, trong khi nhãn sau tìm kiếm //a/b/c trong chính kho lưu trữ bên ngoài. Điều này đặc biệt quan trọng khi viết các quy tắc trong kho lưu trữ chính tham chiếu đến các mục tiêu trong kho lưu trữ chính và sẽ được sử dụng từ các kho lưu trữ bên ngoài.

Để biết thông tin về các cách tham chiếu đến mục tiêu, hãy xem mẫu mục tiêu.

Thông số kỹ thuật từ vựng của nhãn

Cú pháp nhãn không khuyến khích sử dụng siêu ký tự có ý nghĩa đặc biệt đối với trình bao. Điều này giúp tránh các vấn đề về việc trích dẫn vô tình và giúp bạn dễ dàng hơn xây dựng các công cụ và tập lệnh thao tác với nhãn, chẳng hạn như Ngôn ngữ truy vấn Bazel.

Thông tin chi tiết chính xác về tên mục tiêu được phép nằm bên dưới.

Tên mục tiêu – package-name:target-name

target-name là tên của mục tiêu trong gói. Tên của một quy tắc là giá trị của thuộc tính name trong khai báo của quy tắc đó trong tệp BUILD; tên của một tệp là tên đường dẫn của tệp tương ứng với thư mục chứa tệp BUILD.

Tên mục tiêu phải được tạo hoàn toàn từ các ký tự được lấy từ tập hợp a–z, A–Z, 0–9, và các ký hiệu dấu câu !%-@^_"#$&'()*-+,;<=>?[]{|}~/..

Tên tệp phải là tên đường dẫn tương đối ở dạng thông thường, nghĩa là không được bắt đầu hoặc kết thúc bằng dấu gạch chéo (ví dụ: /foo và foo/ bị cấm) cũng như không được chứa nhiều dấu gạch chéo liên tiếp làm dấu phân tách đường dẫn (ví dụ: foo//bar). Tương tự, các tham chiếu cấp trên (..) và tham chiếu thư mục hiện tại (./) bị cấm.

Sai — Không sử dụng .. để tham chiếu đến các tệp trong các gói khác

Đúng — Sử dụng //package-name:filename

Mặc dù thường dùng / trong tên của mục tiêu tệp, nhưng hãy tránh sử dụng / trong tên của quy tắc. Đặc biệt là khi sử dụng dạng viết tắt của nhãn, điều này có thể khiến người đọc nhầm lẫn. Nhãn //foo/bar/wiz luôn là dạng viết tắt của //foo/bar/wiz:wiz, ngay cả khi không có gói foo/bar/wiz như vậy; nhãn này không bao giờ tham chiếu đến //foo:bar/wiz, ngay cả khi mục tiêu đó tồn tại.

Tuy nhiên, có một số trường hợp việc sử dụng dấu gạch chéo là thuận tiện, hoặc đôi khi thậm chí là cần thiết. Ví dụ: tên của một số quy tắc phải khớp với tệp nguồn chính của chúng, có thể nằm trong thư mục con của gói.

Tên gói – //package-name:target-name

Tên của một gói là tên của thư mục chứa tệp BUILD, tương ứng với thư mục cấp cao nhất của kho lưu trữ chứa gói đó. Ví dụ: my/app.

Ở cấp độ kỹ thuật, Bazel thực thi những điều sau:

• Các ký tự được phép trong tên gói là chữ cái viết thường a đến z, chữ cái viết hoa A đến Z, chữ số 0 đến 9, các ký tự ! \"#$%&'()*+,-.;<=>?@[]^_`{|} (có một ký tự dấu cách ở đó!) và tất nhiên là dấu gạch chéo / (vì đây là dấu phân tách thư mục).
• Tên gói không được bắt đầu hoặc kết thúc bằng ký tự dấu gạch chéo /.
• Tên gói không được chứa chuỗi con //. Điều này sẽ không có ý nghĩa – đường dẫn thư mục tương ứng sẽ là gì?
• Tên gói không được chứa chuỗi con /./ hoặc /../ hoặc /.../, v.v. Việc thực thi này được thực hiện để tránh nhầm lẫn khi dịch giữa tên gói logic và tên thư mục thực, dựa trên ý nghĩa ngữ nghĩa của ký tự dấu chấm trong chuỗi đường dẫn.

Ở cấp độ thực tế:

• Đối với một ngôn ngữ có cấu trúc thư mục quan trọng đối với hệ thống mô-đun (ví dụ: Java), điều quan trọng là phải chọn tên thư mục là giá trị nhận dạng hợp lệ trong ngôn ngữ đó. Ví dụ: không bắt đầu bằng chữ số đứng đầu và tránh các ký tự đặc biệt, đặc biệt là dấu gạch dưới và dấu gạch ngang.
• Mặc dù Bazel hỗ trợ các mục tiêu trong gói gốc của không gian làm việc (ví dụ: //:foo), nhưng tốt nhất là nên để trống gói đó để tất cả các gói có ý nghĩa đều có tên mô tả.

Quy tắc

Một quy tắc chỉ định mối quan hệ giữa đầu vào và đầu ra, cũng như các bước để tạo đầu ra. Quy tắc có thể thuộc một trong nhiều loại khác nhau (đôi khi được gọi là lớp quy tắc), tạo ra các tệp thực thi và thư viện đã biên dịch, tệp thực thi kiểm thử và các đầu ra được hỗ trợ khác như mô tả trong Bách khoa toàn thư về bản dựng.

Tệp BUILD khai báo mục tiêu bằng cách gọi quy tắc.

Trong ví dụ bên dưới, chúng ta thấy khai báo của mục tiêu my_app bằng quy tắc cc_binary.

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    deps = [
        "//absl/base",
        "//absl/strings",
    ],
)

Mỗi lời gọi quy tắc đều có một thuộc tính name (phải là tên mục tiêu hợp lệ), khai báo một mục tiêu trong gói của tệp BUILD.

Mỗi quy tắc có một tập hợp thuộc tính; các thuộc tính áp dụng cho một quy tắc nhất định, cũng như ý nghĩa và ngữ nghĩa của từng thuộc tính là một hàm của loại quy tắc; hãy xem Bách khoa toàn thư về bản dựng để biết danh sách các quy tắc và thuộc tính tương ứng. Mỗi thuộc tính có một tên và một loại. Một số loại phổ biến mà thuộc tính có thể có là số nguyên, nhãn, danh sách nhãn, chuỗi, danh sách chuỗi, nhãn đầu ra, danh sách nhãn đầu ra. Không phải tất cả các thuộc tính đều cần được chỉ định trong mọi quy tắc. Do đó, các thuộc tính tạo thành một từ điển từ khoá (tên) đến các giá trị được nhập và không bắt buộc.

Thuộc tính srcs có trong nhiều quy tắc có loại "danh sách nhãn"; giá trị của thuộc tính này (nếu có) là danh sách nhãn, mỗi nhãn là tên của một mục tiêu là đầu vào cho quy tắc này.

Trong một số trường hợp, tên của loại quy tắc có phần tuỳ ý và thú vị hơn là tên của các tệp do quy tắc tạo ra, và điều này đúng với genrules. Để biết thêm thông tin, hãy xem Quy tắc chung: genrule.

Trong các trường hợp khác, tên này có ý nghĩa quan trọng: ví dụ: đối với các quy tắc *_binary và *_test, tên quy tắc sẽ xác định tên của tệp thực thi do bản dựng tạo ra.

Biểu đồ có hướng không có chu kỳ trên các mục tiêu này được gọi là biểu đồ mục tiêu hoặc biểu đồ phần phụ thuộc bản dựng và là miền mà công cụ Truy vấn Bazel hoạt động.