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

ルール

• 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)

Bazel を使用している場合は、 https://github.com/bazelbuild/rules_proto からルールを読み込んでください。

LANG_proto_library ルール（java_proto_library など）で、proto コンパイラを呼び出す必要があります。 一部の LANG_proto_library ルールでは、コマンドライン フラグを使用して使用するツールチェーンを指定できます。ドキュメントをご覧ください。

通常、Java コンパイラをチューニングする場合を除き、このようなルールを作成しないでください。

コンパイラはありません。proto-compiler は、アタッチ先の 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_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, visibility)

非推奨です。代わりに https://github.com/bazelbuild/rules_proto を使用してください。

proto_library を使用して、複数の言語から使用できるプロトコル バッファのライブラリを定義します。proto_library は、サポートされているルール（java_proto_library など）の deps 句にリストされることがあります。

コマンドラインでコンパイルすると、proto_library は foo-descriptor-set.proto.bin という名前のファイルを作成します。これは、ルール srcs のメッセージ用の記述子セットです。このファイルは、シリアル化された FileDescriptorSet です。詳しくは、 https://developers.google.com/protocol-buffers/docs/techniques#self-description をご覧ください。

proto_library ルールによって直接言及される .proto ファイルに関する情報のみが含まれます。推移的記述子セットのコレクションは、[ProtoInfo].transitive_descriptor_sets Starlark プロバイダを通じて利用できます。ProtoInfo.java のドキュメントをご覧ください。

推奨されるコードの整理:

• .proto ファイルごとに 1 つの proto_library ルール。
• foo.proto という名前のファイルは、同じパッケージ内にある foo_proto という名前のルールに含まれます。
• foo_proto という名前の proto_library をラップする [language]_proto_library は、foo_[language]_proto という名前を付けて、同じパッケージ内に配置する必要があります。

引数