Trang này mô tả cách mở rộng ngôn ngữ BUILD bằng macro và quy tắc.
Đuôi Bazel là các tệp có đuôi là .bzl
. Sử dụng câu lệnh tải để nhập một ký hiệu từ một tiện ích.
Trước khi tìm hiểu các khái niệm nâng cao hơn, trước tiên:
Đọc về ngôn ngữ Starlark, được dùng trong cả tệp
BUILD
và.bzl
.Tìm hiểu cách bạn có thể chia sẻ biến giữa 2 tệp
BUILD
.
Macro và quy tắc
Macro là một hàm tạo thực thể cho các quy tắc. Sẽ rất hữu ích khi
Tệp BUILD
đang trở nên quá lặp lại hoặc quá phức tạp, vì cho phép bạn sử dụng lại
mã nào đó. Hàm này được đánh giá ngay khi tệp BUILD
được đọc. Sau
trong việc đánh giá tệp BUILD
, Bazel có ít thông tin về macro:
nếu macro của bạn tạo genrule
, Bazel sẽ hoạt động như thể bạn đã viết
genrule
. Do đó, bazel query
sẽ chỉ liệt kê genrule
đã tạo.
Quy tắc mạnh hơn macro. Công cụ này có thể truy cập vào các phần nội bộ của Bazel và có toàn quyền kiểm soát những gì đang diễn ra. Ví dụ: quy tắc này có thể chuyển thông tin đến các quy tắc khác.
Nếu bạn muốn sử dụng lại logic đơn giản, hãy bắt đầu bằng một macro. Nếu một macro trở nên phức tạp, bạn nên đặt macro đó làm quy tắc. Hỗ trợ cho một ngôn ngữ mới thường được thực hiện bằng một quy tắc. Quy tắc dành cho người dùng nâng cao và hầu hết người dùng sẽ không bao giờ phải viết quy tắc; họ sẽ chỉ tải và gọi các quy tắc hiện có.
Mô hình đánh giá
Một bản dựng bao gồm 3 giai đoạn.
Giai đoạn tải. Trước tiên, hãy tải và đánh giá tất cả các tiện ích cũng như tất cả
BUILD
các tệp cần thiết cho bản dựng. Việc thực thi tệpBUILD
chỉ đơn giản là tạo bản sao các quy tắc (mỗi khi một quy tắc được gọi, quy tắc đó sẽ được thêm vào biểu đồ). Đây là nơi đánh giá macro.Giai đoạn phân tích. Mã của các quy tắc được thực thi (
implementation
của các quy tắc) hàm) và các hành động được tạo thực thể. Một hành động mô tả cách tạo một tập hợp đầu ra từ một tập hợp đầu vào, chẳng hạn như "chạy gcc trên hello.c và nhận hello.o". Bạn phải liệt kê rõ ràng những tệp sẽ được tạo trước khi thực thi các lệnh thực tế. Nói cách khác, giai đoạn phân tích sẽ lấy biểu đồ do giai đoạn tải tạo ra và tạo biểu đồ hành động.Giai đoạn thực thi. Các thao tác sẽ được thực thi khi có ít nhất một trong các kết quả của các thao tác đó được là bắt buộc. Nếu thiếu tệp hoặc nếu một lệnh không tạo được đầu ra, thì bản dựng sẽ không thành công. Các chương trình kiểm thử cũng được chạy trong giai đoạn này.
Bazel sử dụng tính năng song song để đọc, phân tích cú pháp và đánh giá các tệp .bzl
và tệp BUILD
. Mỗi bản dựng chỉ đọc một tệp nhiều nhất một lần và kết quả của quá trình đánh giá sẽ được lưu vào bộ nhớ đệm và sử dụng lại. Một tệp chỉ được đánh giá sau khi tất cả phần phụ thuộc (câu lệnh load()
) của tệp đó đã được phân giải. Theo thiết kế, việc tải tệp .bzl
không hiển thị
hiệu ứng phụ, nó chỉ xác định các giá trị và hàm.
Bazel cố gắng khéo léo: sử dụng bản phân tích phần phụ thuộc để biết tệp nào phải cần tải, quy tắc nào phải được phân tích và hành động nào phải được thực thi. Ví dụ: nếu một quy tắc tạo ra các hành động mà bạn không cần cho bản dựng hiện tại, thì các hành động đó sẽ không được thực thi.
Tạo phần mở rộng
Tạo macro đầu tiên của bạn để sử dụng lại mã nào đó. Sau đó, hãy tìm hiểu thêm về macro và sử dụng macro để tạo "động từ tuỳ chỉnh".
Làm theo hướng dẫn về quy tắc để làm quen với các quy tắc. Tiếp theo, bạn có thể đọc thêm về các khái niệm về quy tắc.
Hai đường liên kết dưới đây sẽ rất hữu ích khi bạn tự viết phần mở rộng. Giữ cho các thiết bị đó ở trong tầm tay:
Vươn xa hơn
Ngoài macro và quy tắc, bạn có thể muốn viết phương diện và quy tắc kho lưu trữ.
Sử dụng Buildifier một cách nhất quán để định dạng và tìm lỗi mã nguồn cho mã của bạn.
Tuân theo hướng dẫn về kiểu
.bzl
.Kiểm thử mã của bạn.
Tạo tài liệu để giúp người dùng.
Tối ưu hoá hiệu suất của mã.
Triển khai các tiện ích của bạn cho người khác.