Aturan Buffering Protokol

Aturan

• 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, plugin, plugin_format_flag, progress_message, proto_compiler, restricted_to, runtime, tags, target_compatible_with, testonly, visibility)

Tidak digunakan lagi. Sebagai gantinya, buka https://github.com/bazelbuild/rules_proto.

Menentukan cara aturan LANG_proto_library (misalnya, java_proto_library) harus memanggil proto-compiler. Beberapa aturan LANG_proto_library memungkinkan penentuan toolchain yang akan digunakan menggunakan tanda command line; lihat dokumentasinya.

Biasanya, Anda tidak boleh menulis aturan semacam itu kecuali jika Anda ingin menyesuaikan compiler Java.

Tidak ada compiler. Compiler proto diambil dari aturan proto_library yang kita lampirkan. Tanda ini diteruskan sebagai flag command line ke Blaze. Beberapa fitur memerlukan compiler proto untuk dipanggil pada aturan proto_library itu sendiri. Ada baiknya menerapkan compiler yang digunakan oleh LANG_proto_library sama dengan yang digunakan proto_library.

Contoh

Contoh sederhananya adalah:

proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

Argumen

Atribut
name	Name; required Nama unik untuk target ini.
blacklisted_protos	List of labels; optional Tidak ada kode yang akan dibuat untuk file dalam atribut srcs dari blacklisted_protos. Metode ini digunakan untuk file .proto yang sudah ditautkan ke runtime proto, seperti any.proto.
command_line	String; required Nilai ini akan diteruskan ke proto-compiler untuk membuat kode. Hanya sertakan bagian yang khusus untuk pembuat kode/plugin ini (misalnya, jangan sertakan parameter -I) $(OUT) bersifat khusus untuk library LANG_proto_. Aturan ini diharapkan menentukan bagaimana aturan tersebut menafsirkan variabel ini. Untuk Java, misalnya, $(OUT) akan diganti dengan nama file src-jar yang akan dibuat.
mnemonic	String; optional; default is "GenProto" Nilai ini akan ditetapkan sebagai mnemonik pada tindakan protoc.
plugin	Label; optional Jika disediakan, akan tersedia untuk tindakan yang memanggil proto-compiler, dan akan diteruskan ke proto-compiler: --plugin=protoc-gen-PLUGIN=.
plugin_format_flag	String; optional Jika disediakan, nilai ini akan diteruskan ke proto-compiler untuk menggunakan plugin. Nilai harus berisi satu %s yang diganti dengan plugin yang dapat dieksekusi. --plugin=protoc-gen-PLUGIN=.
progress_message	String; optional; default is "Generating proto_library %{label}" Nilai ini akan ditetapkan sebagai pesan progres pada tindakan protoc.
proto_compiler	Label; optional Compiler proto yang dapat dieksekusi. Jika disediakan, target ini akan digunakan sebagai compiler proto untuk membuat kode.
runtime	Label; optional Library khusus bahasa tempat kode yang dihasilkan dikompilasi. Perilaku yang tepat adalah khusus LANG_proto_library. Misalnya, Java harus dikompilasi terhadap runtime.

proto_library

proto_library(name, deps, srcs, data, 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)

Tidak digunakan lagi. Sebagai gantinya, gunakan https://github.com/bazelbuild/rules_proto.

Gunakan proto_library untuk menentukan library buffering protokol yang dapat digunakan dari beberapa bahasa. proto_library dapat dicantumkan dalam klausa deps dari aturan yang didukung, seperti java_proto_library.

Saat dikompilasi pada command line, proto_library akan membuat file bernama foo-descriptor-set.proto.bin, yang merupakan kumpulan deskripsi untuk pesan yang oleh aturan srcs. File ini adalah FileDescriptorSet serial, yang dijelaskan di https://developers.google.com/protocol-buffers/docs/technicals#self-description.

Kumpulan ini hanya berisi informasi tentang file .proto yang disebutkan secara langsung oleh aturan proto_library; kumpulan kumpulan deskriptor transitif tersedia melalui penyedia Starlark [ProtoInfo].transitive_descriptor_sets. Lihat dokumentasi dalam ProtoInfo.java.

Pengaturan kode yang direkomendasikan:

• Satu aturan proto_library per file .proto.
• File bernama foo.proto akan berada dalam aturan bernama foo_proto, yang terletak dalam paket yang sama.
• [language]_proto_library yang menggabungkan proto_library bernama foo_proto harus dipanggil foo_[language]_proto, dan berada di paket yang sama.

Argumen

Atribut
name	Name; required Nama unik untuk target ini.
deps	List of labels; optional Daftar aturan proto_library lain yang menjadi dependensi target. proto_library mungkin hanya bergantung pada target proto_library lainnya. Ini mungkin tidak bergantung pada library bahasa tertentu.
srcs	List of labels; optional Daftar file .proto dan .protodevel yang diproses untuk membuat target. Daftar ini biasanya tidak kosong. Satu kasus penggunaan tempat srcs dapat kosong adalah library alias. Ini adalah aturan proto_library yang memiliki satu atau beberapa proto_library lainnya di deps. Pola ini dapat digunakan untuk, misalnya, mengekspor API publik dengan nama persisten.
exports	List of labels; optional Daftar target proto_library yang dapat direferensikan melalui "import public" di sumber proto.
import_prefix	String; optional Awalan yang akan ditambahkan ke jalur file .proto dalam aturan ini. Jika ditetapkan, file sumber .proto dalam atribut srcs aturan ini dapat diakses adalah nilai atribut ini yang ditambahkan ke jalur repositori-relatifnya. Awalan dalam atribut strip_import_prefix dihapus sebelum awalan ini ditambahkan.
strip_import_prefix	String; optional Awalan yang akan dihapus dari jalur file .proto dalam aturan ini. Jika ditetapkan, file sumber .proto dalam atribut srcs aturan ini dapat diakses di jalurnya dengan awalan ini yang terpotong. Jika jalurnya relatif (tidak dimulai dengan garis miring), garis itu diambil sebagai jalur relatif paket. Jika bersifat absolut, hal ini dianggap sebagai jalur repositori-relatif. Awalan dalam atribut import_prefix ditambahkan setelah awalan ini dihilangkan.