协议缓冲区规则

报告问题 查看源代码 敬上 每晚 · 7.3。 · 7.2。 · 7.1。 · 7.0。 · 6.5

规则

proto_library

<ph type="x-smartling-placeholder"></ph> 查看规则来源
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, toolchains, visibility)

如果使用 Bazel,请从 加载规则 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 提供方。 请参阅 proto_info.bzl 中的文档。

推荐的代码组织方式:

  • 每个 .proto 文件创建一条 proto_library 规则。
  • 名为 foo.proto 的文件位于名为 foo_proto 的规则中, 该软件包位于同一个软件包中
  • 用于封装 proto_library[language]_proto_library 名为 foo_proto 的 activity 应命名为 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

阻止重新导出或使用 proto 库的可选许可名单 lang_proto_library。
exports

标签列表;默认值为 []

可通过“import public”引用的 proto_library 目标列表在 proto 源。 使用“import public”时会出错但并未列出相应的库 。 请注意,您已在依赖项和导出中都列出了库,因为并非所有 lang_proto_library 实现已更改。
import_prefix

String;默认值为 ""

要添加到此规则中 .proto 文件的路径的前缀。

设置后,此规则的 srcs 属性中的 .proto 源文件将如下所示: “访问位置”是此属性的值加在代码库相对路径前面。

先移除 strip_import_prefix 属性中的前缀, 前缀。

strip_import_prefix

String;默认值为 "/"

要从此规则中的 .proto 文件路径中删除的前缀。

设置后,此规则的 srcs 属性中的 .proto 源文件将如下所示: 可在其路径下访问,且此前缀会被截断。

如果是相对路径(不以正斜线开头),则被视为相对路径 一个。如果它是绝对路径,则会被理解为代码库相对路径。

import_prefix 属性中的前缀会添加到此前缀后面 删除。

proto_lang_toolchain

<ph type="x-smartling-placeholder"></ph> 查看规则来源
proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, 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

姓名;必需

此目标的唯一名称。

allowlist_different_package

标签;默认值为 None

blacklisted_protos

标签列表;默认值为 []

系统将不会为 srcs 属性中的文件生成代码, blacklisted_protos。 这用于已经链接到 proto 运行时的 .proto 文件,例如 any.proto
command_line

String;必需

该值将传递给 proto-compiler 以生成代码。仅包含 特定于此代码生成器/插件的信息(例如,不要包含 -I 参数) <ph type="x-smartling-placeholder">
    </ph>
  • $(OUT) 特定于 LANG_proto_library。这些规则 如何解读此变量。例如,对于 Java,$(OUT) 将替换为 要创建的 src-jar 文件名。
mnemonic

String;默认值为 "GenProto"

此值将设置为 protoc 操作的助记符。
output_files

String;默认值为 "legacy"

通过以下任一方式来控制 command_line$(OUT) 的格式 单个文件的路径;如果有多个文件,则为输出目录。 可能的值为“single”和“multiple”。
plugin

标签;默认值为 None

如果提供,将可供调用 proto-compiler 的操作使用,并且将 传递给 proto-compiler: --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

String;默认值为 ""

如果提供,则此值将传递给 proto-compiler 以使用插件。 该值必须包含一个用插件可执行文件替换的 %s。 --plugin=protoc-gen-PLUGIN=<executable>.
progress_message

String;默认值为 "Generating proto_library %{label}"

此值将设置为 protoc 操作的进度消息。
protoc_minimal_do_not_use

标签;默认值为 None

runtime

标签;默认值为 None

编译生成的代码时所依据的针对特定语言的库。 确切行为因 LANG_proto_library 而异。 例如 Java,应针对运行时进行编译。
toolchain_type

标签;默认值为 None