规则
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)
已弃用。请改为 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 运行时的 .proto 文件,如 any.proto 。
|
command_line
|
|
mnemonic
|
|
output_files
|
command_line 中 $(OUT) 的格式:通过单个文件的路径,或者通过输出目录(如果有多个文件)。
可能的值为:“single”“multiple”。
|
plugin
|
--plugin=protoc-gen-PLUGIN=
|
plugin_format_flag
|
--plugin=protoc-gen-PLUGIN=
|
progress_message
|
|
proto_compiler
|
|
runtime
|
|
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 |
此目标的唯一名称。 |
deps
|
proto_library 规则的列表。proto_library 只能依赖于其他 proto_library 目标。
它可能不依赖于特定语言的库。
|
srcs
|
.proto 和 .protodevel 文件的列表。这通常是非空列表。srcs 可以为空的一个用例是 alias-library。这是一个 proto_library 规则,在 deps 中包含一个或多个其他 proto_library。
例如,此模式可用于导出某个永久名称下的公共 API。
|
exports
|
|
import_prefix
|
设置后,此规则的 在添加此前缀之前,系统会移除 |
strip_import_prefix
|
设置后,此规则的 如果它是相对路径(不以斜杠开头),则被视为相对软件包路径。如果是绝对路径,则被视为代码库相对路径。
|