Правила Protocol Buffer

Правила

• cc_proto_library
• java_lite_proto_library
• java_proto_library
• proto_library
• py_proto_library
• proto_lang_toolchain
• proto_toolchain

cc_proto_library

cc_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library генерирует код C++ из .proto файлов.

deps должно указывать на правила proto_library .

Пример:

cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

Аргументы

java_lite_proto_library

java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library генерирует Java-код из .proto файлов.

deps должно указывать на правила proto_library .

Пример:

java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

Аргументы

java_proto_library

java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library генерирует Java-код из .proto файлов.

deps должно указывать на правила proto_library .

Пример:

java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

Аргументы

proto_library

proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

При использовании Bazel, загрузите правило с 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. См. документацию в proto_info.bzl.

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

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

Аргументы

py_proto_library

py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Аргументы

proto_lang_toolchain

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

При использовании Bazel, загрузите правило с 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",
)

Аргументы

proto_toolchain

proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Аргументы