プロトコル バッファ ルール

ルール

• 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 は、.proto ファイルから C++ コードを生成します。

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 は、.proto ファイルから Java コードを生成します。

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 は、.proto ファイルから Java コードを生成します。

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 という名前のファイルを作成します。これは、ルールの src のメッセージのディスクリプタ セットです。このファイルはシリアル化された FileDescriptorSet です。詳細については、 https://developers.google.com/protocol-buffers/docs/techniques#self-description をご覧ください。

proto_library ルールで直接参照される .proto ファイルに関する情報のみが含まれます。伝播記述子セットのコレクションは、[ProtoInfo].transitive_descriptor_sets Starlark プロバイダで利用できます。proto_info.bzl のドキュメントをご覧ください。

推奨されるコードの編成:

• .proto ファイルごとに 1 つの proto_library ルール。
• foo.proto という名前のファイルは、同じパッケージにある foo_proto という名前のルールに格納されます。
• foo_proto という名前の proto_library をラップする [language]_proto_library は 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 コンパイラは、アタッチする 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)

引数