Spec-Zone.ru › Bazel 6.0

Правила Protocol Buffer

Правила

  • proto_lang_toolchain
  • proto_library

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) должно вызывать proto-компилятор. Некоторые правила LANG_proto_library позволяют указать, какую использовать цепочку инструментов, используя параметры командной строки; см. их документацию.

Обычно вам не нужно создавать такие правила, если вы не хотите настроить свой компилятор Java.

Компилятора нет. Proto-компилятор берётся из правила proto_library, которое мы прикрепляем. Он передаётся как параметр командной строки в Blaze. Несколько функций требуют вызова proto-компилятора для правила 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

Name; required

Уникальное имя для этой цели.

blacklisted_protos

List of labels; optional

Код не будет сгенерирован для файлов в атрибуте srcs правила blacklisted_protos. Это используется для файлов .proto, которые уже связаны с прото-временами выполнения, такими как any.proto.
command_line

String; required

Это значение будет передано proto-компилятору для генерации кода. Включайте только части, специфичные для этого генератора кода/плагина (например, не включайте параметры -I).
  • $(OUT) специфичен для LANG_proto_library. Ожидается, что правила определят, как они интерпретируют эту переменную. Например, для Java $(OUT) будет заменено именем файла src-jar для создания.
mnemonic

String; optional; default is "GenProto"

Это значение будет установлено как мнемоника для действия protoc.
plugin

Label; optional

Если указано, оно будет доступно для действия, вызывающего proto-компилятор, и будет передано proto-компилятору: --plugin=protoc-gen-PLUGIN=.
plugin_format_flag

String; optional

Если указано, это значение будет передано proto-компилятору для использования плагина. Значение должно содержать один %s, который заменяется исполняемым файлом плагина. --plugin=protoc-gen-PLUGIN=.
progress_message

String; optional; default is "Generating proto_library %{label}"

Это значение будет установлено как сообщение о прогрессе для действия protoc.
proto_compiler

Label; optional

Исполняемый файл proto-компилятора. Если указано, эта цель будет использоваться как proto-компилятор для генерации кода.
runtime

Label; optional

Языковая библиотека, с которой компилируется сгенерированный код. Точное поведение специфично для LANG_proto_library. Например, для Java код должен компилироваться с библиотекой времени выполнения.

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; коллекция транзитивных наборов описателей доступна через поставщик Starlark [ProtoInfo].transitive_descriptor_sets. Смотрите документацию в ProtoInfo.java.

Рекомендуемая организация кода:

  • Одно правило proto_library на один файл .proto.
  • Файл с именем foo.proto будет в правиле с именем foo_proto, который находится в том же пакете.
  • Правило [language]_proto_library обертывающее proto_library с именем foo_proto должно называться foo_[language]_proto, и находиться в том же пакете.

Аргументы

Атрибуты
name

Name; required

Уникальное имя для этой цели.

deps

List of labels; optional

Список других правил proto_library от которых зависит цель. Правило proto_library может зависеть только от других целей proto_library. Оно не может зависеть от языковых библиотек.
srcs

List of labels; optional

Список файлов .proto и .protodevel которые обрабатываются для создания цели. Обычно список не пустой. Один случай, когда srcs может быть пустым — это alias-библиотека. Это правило proto_library имеющее одно или более других proto_library в deps. Этот шаблон можно использовать для экспорта публичного API под постоянным именем.
exports

List of labels; optional

Список целей proto_library, к которым можно обратиться через "import public" в прото-источнике.
import_prefix

String; optional

Префикс для добавления к путям файлов .proto в этом правиле.

При установке, файлы .proto-источников в атрибуте srcs этого правила доступны с префиксом, добавленным к их репозиторию-относительному пути.

Префикс в атрибуте strip_import_prefix удаляется до добавления этого префикса.

strip_import_prefix

String; optional

Префикс для удаления из путей файлов .proto в этом правиле.

При установке, .proto-файлы-источники в атрибуте srcs этого правила доступны по их пути с удалённым префиксом.

Если это относительный путь (не начинающийся с косой черты), он рассматривается как пакет-относительный. Если это абсолютный, он понимается как репозиторий-относительный путь.

Префикс в атрибуте import_prefix добавляется после удаления этого префикса.

За исключением случаев, указанных в противном случае, содержимое этой страницы лицензируется по лицензии Creative Commons Attribution 4.0, а примеры кода лицензируются по лицензии Apache 2.0. Подробности см. в Политике сайта Google для разработчиков. Java — зарегистрированный товарный знак Oracle и/или его аффилированных лиц.

Последнее обновление 2022-12-19 UTC.

Licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.
https://bazel.build/versions/6.0.0/reference/be/protocol-buffer

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API