กฎบัฟเฟอร์ของโปรโตคอล

รายงานปัญหา ดูซอร์สโค้ด รุ่น Nightly · 8.0 7.4 7.3 · 7.2 · 7.1 · 7.0 · 6.5

กฎ

• 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, 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 บางข้ออนุญาตให้ระบุเครื่องมือทางเทคนิคที่จะใช้โดยใช้ Flag บรรทัดคำสั่ง โปรดดูเอกสารประกอบ

โดยทั่วไปแล้ว คุณไม่ควรเขียนกฎประเภทดังกล่าว เว้นแต่ว่าคุณต้องการปรับแต่งคอมไพเลอร์ Java

ไม่มีคอมไพเลอร์ คอมไพเลอร์โปรโตคอลนำมาจากกฎ proto_library ที่เราแนบไว้ ระบบจะส่งค่านี้ผ่านเป็น Flag บรรทัดคำสั่งไปยัง 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",
)

อาร์กิวเมนต์

Attributes
name	ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
blacklisted_protos	รายการป้ายกํากับ ค่าเริ่มต้นคือ [] ระบบจะไม่สร้างโค้ดสำหรับไฟล์ในแอตทริบิวต์ srcs ของ blacklisted_protos ใช้สำหรับไฟล์ .proto ที่ลิงก์กับรันไทม์ proto อยู่แล้ว เช่น any.proto
command_line	สตริง ต้องระบุ ระบบจะส่งค่านี้ไปยังคอมไพเลอร์โปรโตเพื่อสร้างโค้ด ใส่เฉพาะส่วนที่เกี่ยวข้องกับเครื่องมือสร้างโค้ด/ปลั๊กอินนี้เท่านั้น (เช่น อย่าใส่พารามิเตอร์ -I) $(OUT) เฉพาะ LANG_proto_library กฎควรกําหนดวิธีตีความตัวแปรนี้ เช่น สำหรับ Java ระบบจะแทนที่ $(OUT) ด้วยชื่อไฟล์ src-jar ที่จะสร้าง
mnemonic	สตริง ค่าเริ่มต้นคือ "GenProto" ระบบจะตั้งค่านี้เป็นคําช่วยจําในการดําเนินการ protoc
output_files	สตริง ค่าเริ่มต้นคือ "legacy" ควบคุมการจัดรูปแบบ $(OUT) ใน command_line โดยระบุเส้นทางไปยังไฟล์เดียวหรือไดเรกทอรีเอาต์พุตในกรณีที่มีไฟล์หลายไฟล์ ค่าที่ใช้ได้คือ "single", "multiple"
plugin	ป้ายกํากับ ค่าเริ่มต้นคือ None หากระบุไว้ ระบบจะทําให้พร้อมใช้งานสําหรับการดําเนินการที่เรียกใช้คอมไพเลอร์โปรโต และส่งต่อไปยังคอมไพเลอร์โปรโต ดังนี้ --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag	สตริง ค่าเริ่มต้นคือ "" หากระบุไว้ ระบบจะส่งค่านี้ไปยังคอมไพเลอร์โปรโตเพื่อใช้ปลั๊กอิน ค่าต้องมี %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 อาจแสดงอยู่ในประโยค 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 1 ไฟล์
• ไฟล์ชื่อ 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 รูปแบบนี้สามารถใช้เพื่อส่งออก API สาธารณะภายใต้ชื่อถาวรได้
allow_exports	ป้ายกํากับ ค่าเริ่มต้นคือ None รายการที่อนุญาตซึ่งไม่บังคับซึ่งป้องกันไม่ให้ส่งออกไลบรารีโปรโตอีกครั้งหรือใช้ใน lang_proto_library ที่ไม่ได้อยู่ในแพ็กเกจที่ระบุ
exports	รายการป้ายกํากับ ค่าเริ่มต้นคือ [] รายการเป้าหมาย proto_library ที่อ้างอิงได้ผ่าน "import public" ในแหล่งที่มาของ proto
import_prefix	สตริง ค่าเริ่มต้นคือ "" คำนำหน้าที่จะเพิ่มลงในเส้นทางของไฟล์ .proto ในกฎนี้ เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .proto ในแอตทริบิวต์ srcs ของกฎนี้จะเข้าถึงได้ที่ค่าของแอตทริบิวต์นี้ที่ใส่ไว้ข้างหน้าเส้นทางแบบสัมพัทธ์กับที่เก็บ ระบบจะนำคำนำหน้าในแอตทริบิวต์ strip_import_prefix ออกก่อนเพิ่มคำนำหน้านี้
strip_import_prefix	สตริง ค่าเริ่มต้นคือ "" คำนำหน้าที่จะตัดออกจากเส้นทางของไฟล์ .proto ในกฎนี้ เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .proto ในแอตทริบิวต์ srcs ของกฎนี้จะเข้าถึงได้ที่เส้นทางโดยตัดคำนำหน้านี้ออก หากเป็นเส้นทางแบบสัมพัทธ์ (ไม่ได้ขึ้นต้นด้วยเครื่องหมายทับ) ระบบจะถือว่าเส้นทางนั้นสัมพันธ์กับแพ็กเกจ หากเป็นเส้นทางสัมบูรณ์ ระบบจะเข้าใจว่าเป็นเส้นทางสัมพัทธ์กับที่เก็บ ระบบจะเพิ่มคำนำหน้าในแอตทริบิวต์ import_prefix หลังจากที่นำคำนำหน้านี้ออก