协议缓冲区规则

报告问题 查看源代码 每夜 build · 7.4 .

规则

• proto_lang_toolchain
• 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)

如果使用 Bazel，请从 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	名称（必需） 此目标的唯一名称。
blacklisted_protos	标签列表；默认值为 [] 系统不会为 blacklisted_protos 的 srcs 属性中的文件生成任何代码。 此选项适用于已链接到 proto 运行时（例如 any.proto）的 .proto 文件。
command_line	字符串；必需 此值将传递给 proto-compiler 以生成代码。仅包含特定于此代码生成器/插件的部分（例如，不包含 -I 参数） $(OUT) 因 LANG_proto_library 而异。这些规则将定义其解释此变量的方式。例如，对于 Java，$(OUT) 将替换为要创建的 src-jar 文件名。
mnemonic	字符串；默认值为 "GenProto" 此值将设置为 protoc 操作的助记符。
output_files	字符串；默认值为 "legacy" 控制 command_line 中 $(OUT) 的格式设置：单个文件的路径，或者是输出目录（如果是多个文件）。可能的值包括：“单个”和“多个”。
plugin	标签；默认值为 None 如果提供，将可用于调用 proto 编译器的操作，并将被传递给 proto 编译器：--plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag	字符串；默认值为 "" 如果提供，则此值将传递给 proto-compiler 以使用插件。该值必须包含一个由插件可执行文件替换的 %s。 --plugin=protoc-gen-PLUGIN=<executable>.
progress_message	字符串；默认值为 "Generating proto_library %{label}" 此值将设置为 protoc 操作的进度消息。
proto_compiler	标签；默认值为 None protoc 编译器可执行文件。 如果提供，此目标将用作 proto 编译器以生成代码。
runtime	标签；默认值为 None 生成的代码要针对哪个语言专用库进行编译。 确切行为因 LANG_proto_library 而异。 例如，Java 应针对运行时进行编译。

proto_library

查看规则源代码

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)

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

使用 proto_library 定义可从多种语言使用的消息传递协议缓冲区库。proto_library 可能会列在受支持规则的 deps 子句中，例如 java_proto_library。

使用命令行编译时，proto_library 会创建一个名为 foo-descriptor-set.proto.bin 的文件，这是为规则 srcs 的消息设置的描述符。该文件是一个序列化 FileDescriptorSet，详见 https://developers.google.com/protocol-buffers/docs/techniques#self-description。

它仅包含 proto_library 规则直接提及的 .proto 文件的相关信息；传递描述符集的集合可通过 [ProtoInfo].transitive_descriptor_sets Starlark 提供程序获取。请参阅 ProtoInfo.java 中的文档。

推荐的代码组织方式：

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

参数

属性
name	名称（必需） 此目标的唯一名称。
deps	标签列表；默认值为 [] 目标所依赖的其他 proto_library 规则的列表。proto_library 可能仅依赖于其他 proto_library 目标。 它可能不依赖于特定于语言的库。
srcs	标签列表；默认值为 [] 用于创建目标而要处理的 .proto 和 .protodevel 文件的列表。这通常是一个非空列表。srcs 可以为空的一个用例是 alias-library。这是一个 proto_library 规则，其中包含 deps 中的一个或多个其他 proto_library。例如，此模式可用于以永久性名称导出公共 API。
allow_exports	标签；默认值为 None 可选的许可名单，用于禁止在 lang_proto_library 中未包含在任何所列软件包中的 proto 库重新导出或使用。
exports	标签列表；默认值为 [] 可在 proto 源代码中通过“import public”引用的 proto_library 目标的列表。
import_prefix	字符串；默认值为 "" 要添加到此规则中的 .proto 文件的路径的前缀。 设置后，此规则的 srcs 属性中的 .proto 源文件可通过将此属性的值附加到其相对于代码库的路径来访问。 系统会先移除 strip_import_prefix 属性中的前缀，然后再添加此前缀。
strip_import_prefix	字符串；默认值为 "" 要从此规则中的 .proto 文件的路径中删除的前缀。 设置后，此规则的 srcs 属性中的 .proto 源文件可通过去掉此前缀的路径访问。 如果它是相对路径（不以斜线开头），则会被视为相对于软件包的路径。如果它是绝对路径，则会被理解为代码库相对路径。 import_prefix 属性中的前缀会在移除此前缀后添加。