协议缓冲区规则

规则

• 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, 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 编译器。 部分 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	Name; required 此目标的唯一名称。
blacklisted_protos	List of labels; optional 系统不会为 blacklisted_protos 的 srcs 属性中的文件生成代码。 这适用于已链接到 proto 运行时的 .proto 文件，如 any.proto。
command_line	String; required 该值将传递给 proto 编译器，以生成代码。只包含此代码生成器/插件特有的部分（例如，不要包含 -I 参数） $(OUT) 因 LANG_proto_library 而异。这些规则应定义如何解读此变量。例如，在 Java 中，$(OUT) 将被替换为要创建的 src-jar 文件名。
mnemonic	String; optional; default is "GenProto" 此值将设置为 protoc 操作的助记符。
plugin	Label; optional 如果提供，将可供调用 proto 编译器的操作使用，并将传递给 proto 编译器： --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 的文件，该文件是为规则来源的消息设置的描述符。该文件是序列化 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	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 可通过 proto 源代码中的“import public”引用的 proto_library 目标列表。
import_prefix	String; optional 要添加到此规则中的 .proto 文件的路径的前缀。 设置后，此规则的 srcs 属性中的 .proto 源文件将位于该属性的值前置于其代码库相对路径的值。 在添加此前缀之前，系统会移除 strip_import_prefix 属性中的前缀。
strip_import_prefix	String; optional 要从此规则中的 .proto 文件的路径中删除的前缀。 设置后，此规则的 srcs 属性中的 .proto 源文件可通过其路径访问，但此前缀会被截断。 如果它是相对路径（不以斜杠开头），则被视为相对软件包路径。如果是绝对路径，则被视为代码库相对路径。 import_prefix 属性中的前缀是在去除此前缀之后添加的。