规则
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, 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
,详见
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 可以为空的一个用例是 alias-library。这是在 deps 中具有一个或多个其他 proto_library 的 proto_library 规则。例如,此模式可用于以永久名称导出公共 API。 |
allow_exports
|
标签;默认值为 |
exports
|
标签列表;默认值为 |
import_prefix
|
字符串;默认值为 设置后,此规则的 在添加此前缀之前,系统会先移除 |
strip_import_prefix
|
字符串;默认值为 设置后,此规则的 如果是相对路径(不以斜杠开头),系统会将其视为相对软件包。如果它是绝对路径,则会被理解为代码库相对路径。
|
proto_lang_toolchain
查看规则来源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
|
标签;默认值为 |
blacklisted_protos
|
标签列表;默认值为 blacklisted_protos 的 srcs 属性中的文件生成任何代码。这用于已链接到 proto 运行时的 .proto 文件,例如 any.proto 。 |
command_line
|
字符串;必需 该值将传递给 proto-compiler 以生成代码。请仅添加此代码生成器/插件专用的部分(例如,不要添加 -I 参数)
|
mnemonic
|
字符串;默认值为 |
output_files
|
字符串;默认值为 command_line 中 $(OUT) 的格式设置,可以是单个文件的路径,也可以是输出目录(如果是多个文件)。可能的值包括“single”和“multiple”。
|
plugin
|
标签;默认值为 --plugin=protoc-gen-PLUGIN=<executable>.
|
plugin_format_flag
|
字符串;默认值为 --plugin=protoc-gen-PLUGIN=<executable>.
|
progress_message
|
字符串;默认值为 |
protoc_minimal_do_not_use
|
标签;默认值为 |
runtime
|
标签;默认值为 |
toolchain_type
|
标签;默认值为 |