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

ルール

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 コンパイラは、アタッチする proto_library ルールから取得されます。Blaze にコマンドライン フラグとして渡されます。一部の機能では、proto_library ルール自体で proto コンパイラを呼び出す必要があります。 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

名前(必須)

このターゲットの一意の名前。

blacklisted_protos

ラベルのリスト(デフォルトは[]

srcs 属性のファイルに対してコードは生成されません。blacklisted_protosこれは、proto ランタイムにすでにリンクされている .proto ファイルに使用されます。たとえば、 any.proto.
command_line

文字列(必須)

この値は、コードを生成するために proto コンパイラに渡されます。このコードジェネレータ/プラグインに固有の部分のみを含めます(-I パラメータは含めないでください)。
  • $(OUT) は LANG_proto_library 固有です。ルールは、この変数を解釈する方法を定義する必要があります 。たとえば、Java の場合、$(OUT) は 作成する src-jar ファイル名に置き換えられます。
mnemonic

文字列(デフォルトは "GenProto"

この値は、protoc アクションのニーモニックとして設定されます。
output_files

文字列(デフォルトは "legacy"

複数のファイルがある場合に、単一のファイルまたは出力ディレクトリへのパスで command_line$(OUT) の形式を制御します。有効な値は「single」と「multiple」です。
plugin

ラベル(デフォルトは None

指定すると、proto コンパイラを呼び出すアクションで使用できるようになり、proto コンパイラに渡されます:--plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

文字列(デフォルトは ""

指定すると、この値は proto コンパイラに渡されてプラグインが使用されます。値には、プラグイン実行可能ファイルに置き換えられる %s が 1 つ含まれている必要があります。--plugin=protoc-gen-PLUGIN=<executable>.
progress_message

文字列(デフォルトは "Generating proto_library %{label}"

この値は、protoc アクションの進行状況メッセージとして設定されます。
proto_compiler

ラベル(デフォルトは None

proto コンパイラ実行可能ファイル。 指定すると、このターゲットはコードを生成する proto コンパイラとして使用されます。
runtime

ラベル(デフォルトは None

生成されたコードがコンパイルされる言語固有のライブラリ。 正確な動作は LANG_proto_library 固有です。 たとえば、Java はランタイムに対してコンパイルする必要があります。

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 は、サポートされているルールの deps 句にリストできます。たとえば、java_proto_library などです。

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

.proto ファイルに関する情報のみが含まれます。推移的な記述子セットのコレクションは、[ProtoInfo].transitive_descriptor_sets Starlark プロバイダから取得できます。proto_libraryProtoInfo.java のドキュメントをご覧ください。

推奨されるコード構成:

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

引数

属性
name

名前(必須)

このターゲットの一意の名前。

deps

ラベルのリスト(デフォルトは[]

ターゲットが依存する他の proto_library ルールのリスト。 proto_library は、他の proto_library ターゲットにのみ依存できます。 言語固有のライブラリに依存することはできません。
srcs

ラベルのリスト(デフォルトは[]

ターゲットを作成するために処理される .proto ファイルと .protodevel ファイルのリスト。通常、これは空ではないリストです。`srcs` が空になるユースケースの 1 つは、エイリアス ライブラリです。 これは、 `deps` に 1 つ以上の他の proto_library を持つ proto_library ルールです。 depsこのパターンを使用して、永続的な名前で公開 API をエクスポートできます。
allow_exports

ラベル(デフォルトは None

リストされたパッケージに含まれていない lang_proto_library で proto ライブラリが再エクスポートまたは使用されないようにする、省略可能な許可リスト。
exports

ラベルのリスト(デフォルトは[]

proto ソースの「import public」で参照できる proto_library ターゲットのリスト。
import_prefix

文字列(デフォルトは ""

このルールの .proto ファイルのパスに追加する接頭辞。

設定すると、このルールの srcs 属性の .proto ソースファイルに アクセスできます。ここで、 は、リポジトリ相対パスに付加されたこの属性の値です。

この接頭辞が追加される前に、strip_import_prefix 属性の接頭辞が削除されます。

strip_import_prefix

文字列(デフォルトは ""

このルールの .proto ファイルのパスから削除する接頭辞。

設定すると、このルールの srcs 属性の .proto ソースファイルに、この接頭辞が削除されたパスでアクセスできます。

相対パス(スラッシュで始まらない)の場合は、パッケージ相対パスとして扱われます。 絶対パスの場合は、リポジトリ相対パスとして扱われます。

この接頭辞が削除された後、import_prefix 属性の接頭辞が追加されます。