协议缓冲区规则

每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.7

规则

cc_proto_library

查看规则来源 
cc_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library 从 .proto 文件生成 C++ 代码。

deps 必须指向 proto_library 规则。

示例：


cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

参数

属性
name

名称；必需

相应目标的唯一名称。
deps

标签列表；默认值为 []

要为其生成 C++ 代码的 proto_library 规则的列表。

java_lite_proto_library

查看规则来源 
java_lite_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library 从 .proto 文件生成 Java 代码。

deps 必须指向 proto_library 规则。

示例：


java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

参数

属性
name

名称；必需

相应目标的唯一名称。
deps

标签列表；默认值为 []

用于生成 Java 代码的 proto_library 规则列表。

java_proto_library

查看规则来源 
java_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, licenses, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library 从 .proto 文件生成 Java 代码。

deps 必须指向 proto_library 规则。

示例：


java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

参数

属性
name

名称；必需

相应目标的唯一名称。
deps

标签列表；默认值为 []

用于生成 Java 代码的 proto_library 规则列表。

proto_library

查看规则来源 
proto_library(name, deps, srcs, data, allow_exports, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, exports, features, import_prefix, licenses, option_deps, package_metadata, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

使用 proto_library 定义可从多种语言使用的 Protocol Buffers 库。proto_library 可以列在受支持规则的 deps 子句中，例如 java_proto_library。

在命令行中编译时，proto_library 会创建一个名为 foo-descriptor-set.proto.bin 的文件，该文件是规则源的消息的描述符集。该文件是序列化的 FileDescriptorSet，如需了解详情，请参阅 https://developers.google.com/protocol-buffers/docs/techniques#self-description。

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

建议的代码组织方式：

  • 每个 .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 为空的一种使用情形是别名库。这是一个 proto_library 规则，在 deps 中包含一个或多个其他 proto_library。此模式可用于导出具有持久名称的公共 API，例如。
allow_exports

标签；默认值为 None

一个可选的许可名单，用于防止 proto 库在 lang_proto_library 中重新导出或使用，除非该 lang_proto_library 位于列出的软件包中。
exports

标签列表；默认值为 []

可通过 proto 源代码中的“import public”引用的 proto_library 目标列表。 如果您使用“import public”，但未在 exports 属性中列出相应的库，则会出错。 请注意，您需要在 deps 和 exports 中同时列出该库，因为并非所有 lang_proto_library 实现都已更改。
import_prefix

字符串；默认值为 ""

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

设置后，此规则的 srcs 属性中的 .proto 源文件可通过以下方式访问：将此属性的值附加到其相对于代码库的路径前面。

系统会先移除 strip_import_prefix 属性中的前缀，然后再添加此属性。

option_deps

标签列表；默认值为 []

目标仅在选项方面依赖的其他 proto_library 规则的列表。 proto_library 只能依赖于其他 proto_library 目标。它可能不依赖于特定语言的库。
strip_import_prefix

字符串；默认值为 "/"

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

设置后，此规则的 srcs 属性中的 .proto 源文件可在其路径中访问，但会截断此前缀。

如果它是相对路径（不以斜杠开头），则会被视为软件包相对路径。如果它是绝对路径，则会被理解为相对于代码库的路径。

import_prefix 属性中的前缀是在此剥离的前缀之后添加的。

py_proto_library

查看规则来源 
py_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
 使用 `py_proto_library` 从 `.proto` 文件生成 Python 库。 惯例是将 `py_proto_library` 规则命名为 `foo_py_pb2`，前提是该规则封装了 `proto_library` 规则 `foo_proto`。 `deps` 必须指向 `proto_library` 规则。 示例： ```starlark py_library( name = "lib", deps = [":foo_py_pb2"], ) py_proto_library( name = "foo_py_pb2", deps = [":foo_proto"], ) proto_library( name = "foo_proto", srcs = ["foo.proto"], ) ```

参数

属性
name

名称；必需

相应目标的唯一名称。
deps

标签列表；默认值为 []

要为其生成 Python 库的 `proto_library` 规则的列表。 通常，这只是一个目标：感兴趣的 proto 库。 可以是提供 `ProtoInfo` 的任何目标。

proto_lang_toolchain

查看规则来源 
proto_lang_toolchain(name, allowlist_different_package, aspect_hints, blacklisted_protos, command_line, compatible_with, denylisted_protos, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, 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 编译器。 某些 LANG_proto_library 规则允许使用命令行标志指定要使用的工具链；请参阅其文档。

通常情况下，您不应编写此类规则，除非您想调整 Java 编译器。

没有编译器。proto-compiler 取自我们附加到的 proto_library 规则。它作为命令行标志传递给 Blaze。有几项功能要求在 proto_library 规则本身上调用 proto-compiler。强制执行 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

标签列表；默认值为 []

已弃用。denylisted_protos 的别名。将在未来版本中移除。
command_line

字符串；必需

此值将传递给 proto 编译器以生成代码。仅包含特定于此代码生成器/插件的部分（例如，不包含 -I 参数）
  • $(OUT) 是特定于 LANG_proto_library 的。规则应定义它们如何解读此变量。例如，对于 Java，$(OUT) 将替换为要创建的 src-jar 文件名。
denylisted_protos

标签列表；默认值为 []

系统不会为 denylisted_protos 的 srcs 属性中的文件生成任何代码。 这适用于已链接到 proto 运行时（例如 any.proto）的 .proto 文件。
mnemonic

字符串；默认值为 "GenProto"

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

字符串；默认值为 "legacy"

控制 command_line 中 $(OUT) 的格式，可以是单个文件的路径，也可以是多个文件的情况下的输出目录。 可能的值包括：“single”“multiple”。
plugin

标签；默认值为 None

如果提供，则会提供给调用 proto-compiler 的操作，并传递给 proto-compiler： --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

字符串；默认值为 ""

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

字符串；默认值为 "Generating proto_library %{label}"

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

标签；默认值为 None
runtime

标签；默认值为 None

生成代码所编译到的特定于语言的库。 具体行为因 LANG_proto_library 而异。例如，Java 应针对运行时进行编译。
toolchain_type

标签；默认值为 None

proto_toolchain

查看规则来源 
proto_toolchain(name, aspect_hints, command_line, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

参数

属性
name

名称；必需

相应目标的唯一名称。
command_line

字符串；默认值为 "--descriptor_set_out=%s"
mnemonic

字符串；默认值为 "GenProtoDescriptorSet"
output_files

字符串；默认值为 "single"
progress_message

字符串；默认值为 "Generating Descriptor Set proto_library %{label}"
proto_compiler

标签；默认值为 None