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

問題を報告 ソースを表示

ルール

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 ルール自体で 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

ラベルのリスト。デフォルトは [] です。

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

文字列、必須

この値は、コードを生成するためにプロト コンパイラに渡されます。このコード生成ツールまたはプラグインに固有の部分のみを含めます（たとえば、-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-compiler に渡されます。値には、プラグインの実行可能ファイルに置き換えられる 1 つの %s を含める必要があります。 --plugin=protoc-gen-PLUGIN=<executable>.
progress_message

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

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

ラベル: デフォルトは None

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 は、サポートされているルール（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 という名前を付けて、同じパッケージ内に配置する必要があります。

引数

属性
name

名前（必須）

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

ラベルのリスト。デフォルトは [] です。

ターゲットが依存する他の proto_library ルールのリスト。 proto_library は、他の proto_library ターゲットにのみ依存できます。言語固有のライブラリに依存しない場合があります。
srcs

ラベルのリスト。デフォルトは [] です。

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

ラベル: デフォルトは None

リストにあるパッケージのいずれにも含まれていない proto ライブラリの再エクスポートや lang_proto_library での使用を防ぐ許可リスト（省略可）。
exports

ラベルのリスト。デフォルトは [] です。

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

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

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

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

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

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

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

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

相対パス（スラッシュで始まらない）の場合は、パッケージ相対パスとみなされます。絶対パスの場合は、リポジトリ相対パスとみなされます。

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