Spec-Zone.ru › Bazel 6.1

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

Правила

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

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" в исходном файле прото.
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 Developers. Java — зарегистрированная торговая марка Oracle и/или её дочерних компаний.

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

Spec-Zone.ru

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