规则
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-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 |
名称;必需 此目标的唯一名称。 |
blacklisted_protos
|
标签列表;默认值为 blacklisted_protos 的 srcs 属性中的文件生成任何代码。
此选项适用于已链接到 proto 运行时(例如 any.proto )的 .proto 文件。
|
command_line
|
字符串;必需 此值将传递给 proto-compiler 以生成代码。仅包含特定于此代码生成器/插件的部分(例如,不包含 -I 参数)
|
mnemonic
|
字符串;默认值为 |
output_files
|
字符串;默认值为 command_line 中的 $(OUT) 的格式,可以是单个文件的路径,也可以是多个文件的输出目录。可能的值为:“单个”“多个”。
|
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
子句中。
在命令行上编译时,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 |
名称;必需 此目标的唯一名称。 |
deps
|
标签列表;默认值为 proto_library 规则的列表。
proto_library 只能依赖于其他 proto_library 目标。
它可能不依赖于特定语言的库。
|
srcs
|
标签列表;默认值为 .proto 和 .protodevel 文件的列表。这通常是一个非空列表。srcs 可以为空的一个用例是别名库。这是一个 proto_library 规则,其中包含 deps 中的一个或多个其他 proto_library。例如,此模式可用于以永久性名称导出公共 API。
|
allow_exports
|
标签;默认值为 |
exports
|
标签列表;默认值为 |
import_prefix
|
字符串;默认值为 设置后,此规则的 系统会先移除 |
strip_import_prefix
|
字符串;默认值为 设置后,此规则的 如果它是相对路径(不以斜线开头),则被视为相对于软件包的路径。如果是绝对路径,则会被视为相对于代码库的路径。
|