Quy tắc vùng đệm giao thức

Báo cáo vấn đề Xem nguồn

Quy tắc

• proto_lang_toolchain
• proto_library

proto_lang_toolchain

Xem nguồn quy tắc

proto_lang_toolchain(name, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, mnemonic, output_files, plugin, plugin_format_flag, progress_message, proto_compiler, restricted_to, runtime, tags, target_compatible_with, testonly, visibility)

Nếu bạn sử dụng Bazel, vui lòng tải quy tắc từ https://github.com/bazelbuild/rules_proto.

Chỉ định cách quy tắc language_proto_library (ví dụ: java_proto_library) nên gọi trình biên dịch proto. Một số quy tắc lang_proto_library cho phép chỉ định chuỗi công cụ nào cần sử dụng bằng cờ hiệu dòng lệnh; hãy tham khảo tài liệu của các quy tắc đó.

Thông thường, bạn không nên viết các loại quy tắc đó trừ phi muốn điều chỉnh trình biên dịch Java.

Không có trình biên dịch. Trình biên dịch proto được lấy từ quy tắc proto_library mà chúng tôi đính kèm. Nó được truyền dưới dạng cờ dòng lệnh đến Blaze. Một số tính năng yêu cầu trình biên dịch proto phải được gọi trên chính quy tắc proto_library. Bạn nên thực thi trình biên dịch mà lang_proto_library sử dụng giống như trình biên dịch proto_library.

Ví dụ

Một ví dụ đơn giản:

proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
blacklisted_protos	Danh sách nhãn; mặc định là [] Sẽ không có mã nào được tạo cho các tệp trong thuộc tính srcs của blacklisted_protos. Thuộc tính này dùng cho các tệp .proto đã được liên kết với môi trường thời gian chạy proto, chẳng hạn như any.proto.
command_line	Chuỗi; bắt buộc Giá trị này sẽ được chuyển đến trình biên dịch proto để tạo mã. Chỉ bao gồm các phần dành riêng cho trình tạo mã/trình bổ trợ mã này (ví dụ: không bao gồm tham số -I) $(OUT) là dành riêng cho lang_proto_library. Các quy tắc này sẽ xác định cách chúng diễn giải biến này. Ví dụ: Đối với Java, $(OUT) sẽ được thay thế bằng tên tệp src-jar để tạo.
mnemonic	Chuỗi; giá trị mặc định là "GenProto" Giá trị này sẽ được đặt làm giá trị ghi nhớ hành động protoc.
output_files	Chuỗi; giá trị mặc định là "legacy" Kiểm soát cách định dạng $(OUT) trong command_line, bằng đường dẫn đến một tệp hoặc thư mục đầu ra trong trường hợp có nhiều tệp. Các giá trị có thể là: "single", "multiple".
plugin	Nhãn; mặc định là None Nếu được cung cấp, lệnh này sẽ được cung cấp cho hành động gọi trình biên dịch proto và sẽ được chuyển đến trình biên dịch proto: --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag	Chuỗi; giá trị mặc định là "" Nếu được cung cấp, giá trị này sẽ được chuyển đến trình biên dịch proto để sử dụng trình bổ trợ. Giá trị này phải chứa một %s duy nhất được thay thế bằng trình bổ trợ có thể thực thi. --plugin=protoc-gen-PLUGIN=<executable>.
progress_message	Chuỗi; giá trị mặc định là "Generating proto_library %{label}" Giá trị này sẽ được đặt làm thông báo tiến trình trên hành động protoc.
proto_compiler	Nhãn; mặc định là None Trình biên dịch proto có thể thực thi. Nếu được cung cấp, mục tiêu này sẽ được dùng làm trình biên dịch proto để tạo mã.
runtime	Nhãn; mặc định là None Một thư viện dành riêng cho ngôn ngữ mà mã đã tạo được biên dịch dựa trên đó. Hành vi chính xác là dành riêng cho language_proto_library. Ví dụ: Java nên biên dịch theo thời gian chạy.

proto_library

Xem nguồn quy tắc

proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, visibility)

Không dùng nữa. Thay vào đó, vui lòng sử dụng https://github.com/bazelbuild/rules_proto.

Dùng proto_library để xác định các thư viện vùng đệm giao thức có thể dùng bằng nhiều ngôn ngữ. proto_library có thể được liệt kê trong mệnh đề deps của các quy tắc được hỗ trợ, chẳng hạn như java_proto_library.

Khi được biên dịch trên dòng lệnh, proto_library sẽ tạo một tệp có tên foo-descriptor-set.proto.bin. Tệp này là phần mô tả được đặt cho các thông báo mà quy tắc src. Tệp này là một FileDescriptorSet được chuyển đổi tuần tự theo mô tả trong https://developers.google.com/protocol-buffers/docs/techniques#self-description.

Tệp này chỉ chứa thông tin về các tệp .proto mà quy tắc proto_library trực tiếp đề cập; tập hợp các bộ mô tả bắc cầu hiện có sẵn thông qua nhà cung cấp Starlark [ProtoInfo].transitive_descriptor_sets. Xem tài liệu trong ProtoInfo.java.

Cách sắp xếp mã nên dùng:

• Một quy tắc proto_library cho mỗi tệp .proto.
• Tệp có tên foo.proto sẽ nằm trong quy tắc có tên foo_proto, nằm trong cùng gói.
• Một [language]_proto_library gói proto_library có tên là foo_proto sẽ được gọi là foo_[language]_proto và nằm trong cùng một gói.

Đối số

Thuộc tính
name	Tên; bắt buộc Tên duy nhất cho mục tiêu này.
deps	Danh sách nhãn; mặc định là [] Danh sách các quy tắc proto_library khác mà mục tiêu phụ thuộc. proto_library chỉ có thể phụ thuộc vào các mục tiêu proto_library khác. Tính năng này có thể không phụ thuộc vào các thư viện dành riêng cho ngôn ngữ.
srcs	Danh sách nhãn; mặc định là [] Danh sách các tệp .proto và .protodevel được xử lý để tạo mục tiêu. Đây thường là một danh sách không trống. Một trường hợp sử dụng mà srcs có thể trống là alias-library. Đây là một quy tắc proto_library có một hoặc nhiều proto_library trong deps. Bạn có thể dùng mẫu này để xuất một API công khai dưới một tên cố định.
allow_exports	Nhãn; mặc định là None Một danh sách cho phép (không bắt buộc) ngăn việc xuất lại hoặc sử dụng thư viện proto không thuộc một trong các gói được liệt kê trong lang_proto_library.
exports	Danh sách nhãn; mặc định là [] Danh sách các mục tiêu proto_library có thể được tham chiếu thông qua tuỳ chọn "nhập công khai" trong nguồn proto.
import_prefix	Chuỗi; giá trị mặc định là "" Tiền tố để thêm vào đường dẫn của các tệp .proto trong quy tắc này. Khi được đặt, các tệp nguồn .proto trong thuộc tính srcs của quy tắc này có thể truy cập được tại giá trị của thuộc tính này được thêm vào trước đường dẫn tương đối của kho lưu trữ. Tiền tố trong thuộc tính strip_import_prefix sẽ bị xoá trước khi thêm tiền tố này.
strip_import_prefix	Chuỗi; giá trị mặc định là "" Tiền tố để tách khỏi đường dẫn của các tệp .proto trong quy tắc này. Khi được đặt, các tệp nguồn .proto trong thuộc tính srcs của quy tắc này có thể truy cập được tại đường dẫn của các tệp đó và tiền tố này bị cắt. Nếu đó là một đường dẫn tương đối (không bắt đầu bằng dấu gạch chéo), thì đường dẫn đó sẽ được coi là đường dẫn tương đối của gói. Nếu giá trị là một giá trị tuyệt đối, thì giá trị này được hiểu là một đường dẫn tương đối của kho lưu trữ. Tiền tố trong thuộc tính import_prefix sẽ được thêm sau khi xoá tiền tố.