ルール
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
)はプロトコンパイラを呼び出す必要があります。一部の 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", )
引数
属性 | |
---|---|
name |
名前: 必須 このターゲットの名前。 |
blacklisted_protos
|
ラベルのリスト。デフォルトは blacklisted_protos の srcs 属性のファイルにはコードは生成されません。これは、any.proto など、proto ランタイムにすでにリンクされている .proto ファイルに使用されます。 |
command_line
|
文字列(必須) この値はプロトコル コンパイラに渡され、コードが生成されます。このコード生成ツール/プラグインに固有の部分のみを含めます(例: -I パラメータは含めない)。
|
mnemonic
|
文字列。デフォルトは |
output_files
|
文字列。デフォルトは command_line の $(OUT) の形式を制御します。単一ファイルの場合はパス、複数のファイルの場合は出力ディレクトリです。有効な値は「single」、「multiple」です。 |
plugin
|
ラベル(デフォルトは --plugin=protoc-gen-PLUGIN=<executable>.
|
plugin_format_flag
|
文字列。デフォルトは --plugin=protoc-gen-PLUGIN=<executable>.
|
progress_message
|
文字列。デフォルトは |
proto_compiler
|
ラベル(デフォルトは |
runtime
|
ラベル(デフォルトは |
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_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 プロバイダで利用できます。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 を空にできるユースケースの一つは、エイリアス ライブラリです。これは、deps に 1 つ以上の他の proto_library を持つ proto_library ルールです。このパターンは、たとえば、公開 API を永続的な名前でエクスポートする場合に使用できます。
|
allow_exports
|
ラベル(デフォルトは |
exports
|
ラベルのリスト。デフォルトは |
import_prefix
|
文字列。デフォルトは 設定すると、このルールの この接頭辞が追加される前に、 |
strip_import_prefix
|
文字列。デフォルトは 設定すると、このルールの 相対パス(スラッシュで始まらないパス)の場合は、パッケージ相対パスとして扱われます。絶対パスの場合は、リポジトリ相対パスとして解釈されます。
|