规则
proto_lang_toolchain
查看规则源代码proto_lang_toolchain(name, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, mnemonic, output_files, plugin, plugin_format_flag, progress_message, proto_compiler, restricted_to, runtime, tags, target_compatible_with, testonly, 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 |
名称;必需 此目标的唯一名称。 |
blacklisted_protos
|
系统不会为 blacklisted_protos 的 srcs 属性中的文件生成任何代码。这适用于已链接到 proto 运行时(例如
any.proto.
)的 .proto 文件。 |
command_line
|
字符串;必需 此值将传递给 proto 编译器以生成代码。仅包含特定于此代码生成器/插件的部分(例如,不包含 -I 参数)
|
mnemonic
|
字符串;默认值为 |
output_files
|
字符串;默认值为 $(OUT) 在 command_line 中的格式,可以是单个文件的路径,也可以是多个文件时的输出目录。可能的值包括:“single”“multiple”。
|
plugin
|
标签;默认值为 --plugin=protoc-gen-PLUGIN=<executable>. |
plugin_format_flag
|
字符串;默认值为 --plugin=protoc-gen-PLUGIN=<executable>.
|
progress_message
|
字符串;默认值为 |
proto_compiler
|
标签;默认值为 |
runtime
|
标签;默认值为 |
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, visibility)
已弃用。请改用 https://github.com/bazelbuild/rules_proto。
使用 proto_library 定义协议缓冲区的库
这些库可以从多种语言中使用。proto_library 可能会列在受支持规则(例如 java_proto_library)的 deps 子句中。
在命令行中编译时,a proto_library 会创建一个名为
foo-descriptor-set.proto.bin 的文件,该文件是 for the
messages the rule srcs 的描述符集。该文件是序列化的 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 |
名称;必需 此目标的唯一名称。 |
deps
|
目标所依赖的其他 proto_library 规则的列表。
proto_library 只能依赖于其他
proto_library 目标。
它可能不依赖于特定于语言的库。
|
srcs
|
用于创建目标而处理的 .proto 和 .protodevel 文件列表。这通常是一个非空列表。`srcs` 可以为空的一个用例是别名库。这是一个
proto_library 规则,在 deps 中包含一个或多个其他 proto_library。
此模式可用于在永久名称下导出公共 API 等。 |
allow_exports
|
标签;默认值为 |
exports
|
可通过 proto 源代码中的“import public”引用的 proto_library 目标的列表。 |
import_prefix
|
字符串;默认值为 设置后,此规则的 系统会在添加此
属性之前移除 |
strip_import_prefix
|
字符串;默认值为 设置后,此规则的 如果是相对路径(不以斜杠开头),则将其视为软件包相对路径 。如果是绝对路径,则将其理解为仓库相对路径。 系统会在剥离此前缀后添加 |