协议缓冲区规则

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 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, extension_declarations, features, import_prefix, licenses, option_deps, package_metadata, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

使用 proto_library 定义协议缓冲区的库，这些库 可用于多种语言。proto_library 可能会列在受支持规则（例如 java_proto_library）的 deps 子句中。

在命令行中编译时，a proto_library 会创建一个文件 名为 foo-descriptor-set.proto.bin，该文件是规则源消息的描述符集。该文件是序列化的 FileDescriptorSet，如 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 的规则中， 该规则位于同一软件包中。
  • 封装名为 foo_proto 的 proto_library 的 [language]_proto_library 应称为 foo_[language]_proto， 并位于同一软件包中。

实参

属性
name

名称；必需

此目标的唯一名称。
deps

标签列表；默认值为 []

目标所依赖的其他 proto_library 规则的列表。 proto_library 只能依赖于其他 proto_library 目标。它不能依赖于特定于语言的库。
srcs

标签列表；默认值为 []

用于创建目标的 .proto 和 .protodevel 文件列表，这些文件经过 处理。这通常是一个非空列表。`srcs` 可以为空的一个用例是别名库。srcs这是一个 `proto_library` 规则，在 deps 中包含一个或多个其他 proto_library。 此模式可用于在永久名称下导出公共 API 等。
allow_exports

标签；默认值为 None

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

标签列表；默认值为 []

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

标签列表；默认值为 []

包含扩展声明的文件列表。此属性仅允许 与 MessageSet 一起使用。
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` 规则封装 `proto_library` 规则 `foo_proto` 时，应将 `py_proto_library` 规则命名为 `foo_py_pb2`。 `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 编译器取自我们附加到的 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

标签列表；默认值为 []

已弃用。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"

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

标签；默认值为 None

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

字符串；默认值为 ""

如果提供，此值将传递给 proto 编译器以使用插件。 该值必须包含一个 %s，该 %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