协议缓冲区规则

规则

• <ph type="x-smartling-placeholder"></ph> proto_lang_toolchain
• <ph type="x-smartling-placeholder"></ph> proto_library

proto_lang_toolchain

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)

已弃用。请 https://github.com/bazelbuild/rules_proto。

指定 LANG_proto_library 规则（例如，java_proto_library）应调用 proto-compiler。 某些 LANG_proto_library 规则允许使用命令行标志指定要使用的工具链； 参阅相关文档。

通常，除非您希望 微调 Java 编译器。

没有编译器。proto-compiler 取自我们附加到的 proto_library 规则。时间是 作为命令行标志传递给 Blaze。 几项功能要求对 proto_library 规则本身调用 proto 编译器。 建议强制让 LANG_proto_library 使用的编译器与当前编译器相同 proto_library 支持。

示例

下面是一个简单的示例：

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

参数

属性
name	Name; required 此目标的唯一名称。
blacklisted_protos	List of labels; optional 系统将不会为 srcs 属性中的文件生成代码， blacklisted_protos。 这用于已经链接到 proto 运行时的 .proto 文件，例如 any.proto。
command_line	String; required 该值将传递给 proto-compiler 以生成代码。仅包含 特定于此代码生成器/插件的信息（例如，不要包含 -I 参数） <ph type="x-smartling-placeholder"> </ph> $(OUT) 特定于 LANG_proto_library。这些规则 如何解读此变量。例如，对于 Java，$(OUT) 将替换为 要创建的 src-jar 文件名。
mnemonic	String; optional; default is "GenProto" 此值将设置为 protoc 操作的助记符。
output_files	String; optional; default is "legacy" 通过以下任一方式来控制 command_line 中 $(OUT) 的格式 单个文件的路径；如果有多个文件，则为输出目录。 可能的值为“single”和“multiple”。
plugin	Label; optional 如果提供，将可供调用 proto-compiler 的操作使用，并且将 传递给 proto-compiler： --plugin=protoc-gen-PLUGIN=.
plugin_format_flag	String; optional 如果提供，则此值将传递给 proto-compiler 以使用插件。该值必须 包含一个件可执行文件替换的 %s。 --plugin=protoc-gen-PLUGIN=.
progress_message	String; optional; default is "Generating proto_library %{label}" 此值将设置为 protoc 操作的进度消息。
proto_compiler	Label; optional proto 编译器可执行文件。 如果提供，此目标将用作 proto 编译器以生成代码。
runtime	Label; optional 编译生成的代码时所依据的针对特定语言的库。 确切行为因 LANG_proto_library 而异。 例如 Java，应针对运行时进行编译。

proto_library

proto_library(name, deps, srcs, data, 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)

已弃用。请使用 https://github.com/bazelbuild/rules_proto。

使用 proto_library 定义协议缓冲区库 可能有多种语言版本。系统可能会列出proto_library 在受支持规则的 deps 子句中，例如 java_proto_library。

在命令行中进行编译时，proto_library 会创建一个名为 foo-descriptor-set.proto.bin：这是为 发送规则“srcs”的消息该文件是一个序列化 FileDescriptorSet， 具体说明 <ph type="x-smartling-placeholder"></ph> https://developers.google.com/protocol-buffers/docs/techniques#self-description.

它仅包含由.proto proto_library 规则；传递描述符集合的集合可通过 [ProtoInfo].transitive_descriptor_sets Starlark 提供程序。 请参阅 ProtoInfo.java 中的文档。

推荐的代码组织方式：

• 每个 .proto 文件创建一条 proto_library 规则。
• 名为 foo.proto 的文件位于名为 foo_proto 的规则中，该规则 位于同一软件包中。
• 一个 [language]_proto_library，用于封装proto_library 应调用 foo_proto foo_[language]_proto，并位于同一软件包中。

参数

属性
name	Name; required 此目标的唯一名称。
deps	List of labels; optional 目标所依赖的其他 proto_library 规则的列表。 proto_library 可能仅依赖于 proto_library 项目标。 它可能不依赖于特定于语言的库。
srcs	List of labels; optional .proto 和 .protodevel 文件的列表 以创建目标。这通常是非空列表。一个应用场景 其中，srcs 可以为空是一个 alias-library。这是一个 proto_library 规则在 deps 中具有一个或多个其他 proto_library。 此模式可用于使用永久性名称导出公共 API。
exports	List of labels; optional 可通过“import public”引用的 proto_library 目标列表proto 中 来源。
import_prefix	String; optional 要添加到此规则中 .proto 文件的路径的前缀。 设置后，此规则的 srcs 属性中的 .proto 源文件将如下所示： “访问位置”是此属性的值加在代码库相对路径前面。 先移除 strip_import_prefix 属性中的前缀， 前缀。
strip_import_prefix	String; optional 要从此规则中的 .proto 文件路径中删除的前缀。 设置后，此规则的 srcs 属性中的 .proto 源文件将如下所示： 可在其路径下访问，且此前缀会被截断。 如果是相对路径（不以正斜线开头），则被视为相对路径 一个。如果它是绝对路径，则会被理解为代码库相对路径。 import_prefix 属性中的前缀会添加到此前缀后面 删除。