Spec-Zone.ru › Bazel 6.3

Правила протобуфера

Правила

  • 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, 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) должно вызывать прото-компилятор. Некоторые правила 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

Name; required

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

blacklisted_protos

List of labels; optional

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

String; required

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

String; optional; default is "GenProto"

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

String; optional; default is "legacy"

Управляет тем, как $(OUT) в command_line форматируется, либо по пути к одному файлу, либо к каталогу вывода в случае нескольких файлов. Возможные значения: "single", "multiple".
plugin

Label; optional

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

String; optional

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

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

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

Label; optional

Исполняемый файл прото-компилятора. При необходимости эта цель будет использоваться в качестве прото-компилятора для генерации кода.
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 может быть пустым - это алиас-библиотека. Это правило proto_library, имеющее одно или несколько других правил proto_library в deps. Этот шаблон можно использовать, например, для экспорта публичного API под постоянным именем.
exports

List of labels; optional

Список целей proto_library, которые могут быть указаны через "import public" в источнике proto.
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 и/или ее аффилированных компаний.

Последнее обновление 2023-07-25 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.3.0/reference/be/protocol-buffer

Spec-Zone.ru

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