กฎ
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_protocol_library (เช่น java_proto_library
) ควรเรียกใช้ Proto-Compiler
กฎ LANG_proto_library บางข้ออนุญาตให้ระบุเครื่องมือทางเทคนิคที่จะใช้โดยใช้ Flag บรรทัดคำสั่ง โปรดดูเอกสารประกอบ
โดยทั่วไปแล้ว คุณไม่ควรเขียนกฎประเภทดังกล่าว เว้นแต่ว่าคุณต้องการปรับแต่งคอมไพเลอร์ Java
ไม่มีคอมไพเลอร์ ซึ่งได้มาจากกฎ protocol_library ที่เราแนบไปด้วย ระบบจะส่งค่านี้ผ่านเป็น Flag บรรทัดคำสั่งไปยัง Blaze
มีฟีเจอร์หลายอย่างที่ต้องมีการเรียกใช้ Pro-Compiler ในตัวกฎ Proto_library
การบังคับใช้คอมไพเลอร์ที่ LANG_protocol_library ใช้เหมือนกับที่ proto_library
ใช้
ตัวอย่าง
ตัวอย่างง่ายๆ ได้แก่
proto_lang_toolchain( name = "javalite_toolchain", command_line = "--javalite_out=shared,immutable:$(OUT)", plugin = ":javalite_plugin", runtime = ":protobuf_lite", )
อาร์กิวเมนต์
Attributes | |
---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
blacklisted_protos
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ srcs ของ blacklisted_protos
ใช้สำหรับไฟล์ .prof ที่ลิงก์กับรันไทม์ของ Pro อยู่แล้ว เช่น any.proto
|
command_line
|
สตริง ต้องระบุ ค่านี้จะส่งไปยังโปรโตคอมไพเลอร์เพื่อสร้างโค้ด รวมเฉพาะส่วนที่เฉพาะเจาะจงสำหรับโปรแกรมสร้าง/ปลั๊กอินนี้ (เช่น อย่ารวมพารามิเตอร์ -I)
|
mnemonic
|
สตริง ค่าเริ่มต้นคือ |
output_files
|
สตริง ค่าเริ่มต้นคือ $(OUT) ใน command_line โดยระบุเส้นทางไปยังไฟล์เดียวหรือไดเรกทอรีเอาต์พุตในกรณีที่มีไฟล์หลายไฟล์
ค่าที่เป็นไปได้คือ "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
ซึ่งเป็นชุดตัวบ่งชี้สำหรับข้อความแหล่งที่มาของกฎ ไฟล์นี้เป็น FileDescriptorSet
ที่แปลงเป็นอนุกรม ซึ่งอธิบายไว้ใน
https://developers.google.com/protocol-buffers/docs/techniques#self-description
โดยจะมีเฉพาะข้อมูลเกี่ยวกับไฟล์ .proto
ที่กฎ proto_library
กล่าวถึงโดยตรง คุณจะดูชุดตัวระบุแบบเปลี่ยนผ่านได้ผ่านผู้ให้บริการ [ProtoInfo].transitive_descriptor_sets
Starlark
ดูเอกสารประกอบใน ProtoInfo.java
การจัดระเบียบโค้ดที่แนะนำ:
- กฎ
proto_library
1 รายการต่อ.proto
ไฟล์ - ไฟล์ชื่อ
foo.proto
จะอยู่ในกฎชื่อfoo_proto
ซึ่งอยู่ในแพ็กเกจเดียวกัน -
[language]_proto_library
ที่รวมproto_library
ที่มีชื่อว่าfoo_proto
ควรมีชื่อว่าfoo_[language]_proto
และอยู่ในแพ็กเกจเดียวกัน
อาร์กิวเมนต์
Attributes | |
---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสําหรับเป้าหมายนี้ |
deps
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ proto_library อื่นๆ ที่เป้าหมายอ้างอิง
proto_library หนึ่งๆ อาจขึ้นอยู่กับเป้าหมาย proto_library อื่นๆ เท่านั้น
อาจต้องใช้ไลบรารีเฉพาะภาษา
|
srcs
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ .proto และ .protodevel ที่ประมวลผลเพื่อสร้างเป้าหมาย ซึ่งโดยปกติแล้วจะเป็นรายการที่ไม่ใช่รายการว่าง Use Case หนึ่งที่ srcs อาจเป็นค่าว่างได้คือ alias-library นี่เป็นกฎ proto_library ที่มี proto_library อื่นๆ อย่างน้อย 1 รายการใน deps
รูปแบบนี้สามารถใช้เพื่อส่งออก Public API ภายใต้ชื่อถาวรได้
|
allow_exports
|
ป้ายกำกับ ค่าเริ่มต้นคือ |
exports
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ |
import_prefix
|
สตริง ค่าเริ่มต้นคือ เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .proto ในแอตทริบิวต์ ระบบจะนำคำนำหน้าในแอตทริบิวต์ |
strip_import_prefix
|
สตริง ค่าเริ่มต้นคือ เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .prof ในแอตทริบิวต์ หากเป็นเส้นทางแบบสัมพัทธ์ (ไม่ได้เริ่มต้นด้วยเครื่องหมายทับ) ระบบจะใช้เส้นทางนี้เป็นเส้นทางที่สัมพันธ์กับแพ็กเกจ หากเป็นเส้นทางสัมบูรณ์ ระบบเข้าใจว่าเป็นเส้นทางที่สัมพันธ์กับที่เก็บ ระบบจะเพิ่มคำนำหน้าในแอตทริบิวต์ |