Правила
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) должно вызывать прото-компилятор. Некоторые правила LANG_proto_library позволяют указать используемую цепочку инструментов с помощью командной строки; обратитесь к их документации.
Обычно вы не должны писать такие правила, если вы не хотите настроить свой Java-компилятор.
Компилятора нет. Прото-компилятор берётся из правила proto_library, которое мы прикрепляем. Он передаётся в качестве флага командной строки Blaze. Несколько функций требуют вызова прото-компилятора на правиле proto_library. Полезно гарантировать, что компилятор, который использует 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 |
srcs правила blacklisted_protos не будет сгенерирован никакой код. Это используется для файлов .proto, которые уже подключены к проточным запускам, таким как any.proto. |
command_line |
|
mnemonic |
|
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, который является набором описателей для сообщений, указанных в srcs правила. Файл представляет собой сериализованный FileDescriptorSet, который описан в https://developers.google.com/protocol-buffers/docs/techniques#self-description.
Он содержит только информацию о файлах .proto непосредственно упомянутых в правиле proto_library; набор транзитивных описателей доступен через [ProtoInfo].transitive_descriptor_sets Starlark-провайдер. См. документацию в ProtoInfo.java.
Рекомендуемая структура кода:
- Одно правило
proto_libraryна каждый файл.proto. - Файл с именем
foo.protoбудет в правиле с именемfoo_proto, расположенном в той же папке. - Правило
[language]_proto_library, которое оборачивает правилоproto_libraryс именемfoo_proto, должно называтьсяfoo_[language]_proto, и быть в той же папке.
Аргументы
| Атрибуты | |
|---|---|
name |
Уникальное имя для этой цели. |
deps |
proto_library, от которых зависит цель. Правило proto_library может зависеть только от других целей proto_library. Оно не может зависеть от языковых библиотек. |
srcs |
.proto и .protodevel, которые обрабатываются для создания цели. Обычно это не пустой список. Один из вариантов использования, где srcs может быть пустым, это библиотека-псевдоним. Это правило proto_library, содержащее одно или несколько других правил proto_library в deps. Этот шаблон можно использовать, например, для экспорта публичного API под постоянным именем. |
exports |
|
import_prefix |
При установке файлы .proto в атрибуте Префикс в атрибуте |
strip_import_prefix |
При установке файлы .proto в атрибуте Если это относительный путь (не начинающийся со слеша), он рассматривается как путь, относительный к пакетам. Если это абсолютный путь, он понимается как путь, относительный к репозиторию. Префикс в атрибуте |