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

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Quy tắc

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 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 LANG_proto_library (ví dụ: java_proto_library) sẽ 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ụ cần sử dụng bằng cách dù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 bạn 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 ta đính kèm. Trình biên dịch này được truyền dưới dạng cờ hiệu dòng lệnh đến Blaze. Một số tính năng yêu cầu phải gọi trình biên dịch proto trên chính quy tắc proto_library. Việc thực thi trình biên dịch mà LANG_proto_library sử dụng sẽ có lợi vì trình biên dịch này giống với trình biên dịch mà proto_library sử dụng.

Ví dụ

Một ví dụ đơn giản sẽ là: 

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 dành riêng cho mục tiêu này.
blacklisted_protos

Danh sách nhãn; giá trị mặc định là []

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 được dùng cho các tệp .proto đã được liên kết vào 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 truyền đến trình biên dịch proto để tạo mã. Chỉ đưa các phần dành riêng cho trình tạo mã/trình bổ sung này vào (ví dụ: không đưa các tham số -I vào)
  • $(OUT) dành riêng cho LANG_proto_library. Các quy tắc dự kiến sẽ xác định cách 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 từ khoá gợi nhớ trên thao tác 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, theo đườ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; giá trị mặc định là None

Nếu được cung cấp, sẽ được cung cấp cho thao tác gọi trình biên dịch proto và sẽ được truyề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 truyền đến trình biên dịch proto để sử dụng trình bổ sung. Giá trị phải chứa một %s duy nhất được thay thế bằng tệp thực thi trình bổ sung. --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 thao tác protoc.
proto_compiler

Nhãn; giá trị mặc định là None

Tệp thực thi trình biên dịch proto. 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; giá trị mặc định là None

Một thư viện dành riêng cho ngôn ngữ mà mã được tạo được biên dịch. Hành vi chính xác là dành riêng cho LANG_proto_library. Ví dụ: Java phải biên dịch dựa trên 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. Vui lòng sử dụng https://github.com/bazelbuild/rules_proto.

Sử dụng proto_library để xác định các thư viện vùng đệm giao thức có thể được sử dụng từ nhiều ngôn ngữ. A 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, một proto_library sẽ tạo một tệp có tên foo-descriptor-set.proto.bin, đây là tập hợp mô tả cho các thông báo của quy tắc srcs. Tệp này là một FileDescriptorSet được tuần tự hoá, được 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 được quy tắc proto_library trực tiếp đề cập; tập hợp các tập hợp mô tả bắc cầu có sẵn thông qua nhà cung cấp [ProtoInfo].transitive_descriptor_sets Starlark. Xem tài liệu trong ProtoInfo.java.

Đề xuất cách tổ chức mã:

  • Một quy tắc proto_library cho mỗi tệp .proto.
  • Tệp có tên foo.proto sẽ nằm trong một quy tắc có tên foo_proto, nằm trong cùng một gói.
  • Một [language]_proto_library gói proto_library có tên foo_proto phải đượ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 dành riêng cho mục tiêu này.
deps

Danh sách nhãn; giá trị mặc định là []

Danh sách các quy tắc proto_library khác mà mục tiêu phụ thuộc vào. Một proto_library chỉ có thể phụ thuộc vào các mục tiêu proto_library khác. Mục tiêu này không thể phụ thuộc vào các thư viện dành riêng cho ngôn ngữ.
srcs

Danh sách nhãn; giá trị 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à danh sách không trống. Một trường hợp sử dụng mà srcs có thể trống là một alias-library. Đây là quy tắc proto_library có một hoặc nhiều proto_library khác trong deps. Bạn có thể sử 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; giá trị mặc định là None

Danh sách cho phép không bắt buộc ngăn thư viện proto được xuất lại hoặc sử dụng trong lang_proto_library không nằm trong một trong các gói được liệt kê.
exports

Danh sách nhãn; giá trị mặc định là []

Danh sách các mục tiêu proto_library có thể được tham chiếu thông qua "import public" trong nguồn proto.
import_prefix

Chuỗi; giá trị mặc định là ""

Tiền tố cần 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 là giá trị của thuộc tính này được thêm vào đườ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 tiền tố này được thêm vào.

strip_import_prefix

Chuỗi; giá trị mặc định là ""

Tiền tố cần xoá 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 chúng với tiền tố này bị cắt.

Nếu đó là đườ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 đó là đường dẫn tuyệt đối, thì đường dẫn đó sẽ được hiểu là đường dẫn tương đối của kho lưu trữ.

Tiền tố trong thuộc tính import_prefix được thêm sau khi tiền tố này bị xoá.