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

รายงานปัญหา ดูแหล่งที่มา Nightly{/19/} Nightly{/19/} /4} /20}

กฎ

• proto_library
• proto_lang_toolchain

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, toolchains, visibility)

หากใช้ Bazel โปรดโหลดกฎจาก https://github.com/bazelbuild/rules_protocol

ใช้ proto_library เพื่อกำหนดไลบรารีของบัฟเฟอร์โปรโตคอลที่อาจใช้จากหลายภาษา proto_library อาจแสดงอยู่ในเงื่อนไข deps ของกฎที่รองรับ เช่น java_proto_library

เมื่อคอมไพล์ในบรรทัดคำสั่ง proto_library จะสร้างไฟล์ชื่อ foo-descriptor-set.proto.bin ซึ่งเป็นชุดตัวบ่งชี้สำหรับข้อความที่กฎ srcs ไฟล์นี้เป็น FileDescriptorSet แบบต่อเนื่อง ซึ่งอธิบายไว้ใน https://developers.google.com/protocol-buffers/docs/techniques#self-description

ซึ่งมีเฉพาะข้อมูลเกี่ยวกับไฟล์ .proto ที่กฎ proto_library พูดถึงโดยตรง คอลเลกชันของชุดคำอธิบายทรานซิทีฟพร้อมให้ใช้งานผ่านผู้ให้บริการ Starlark [ProtoInfo].transitive_descriptor_sets ดูเอกสารประกอบใน proto_info.bzl

การจัดระเบียบโค้ดที่แนะนำ:

• กฎ 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 รูปแบบนี้สามารถใช้เพื่อ เช่น ส่งออก API สาธารณะภายใต้ชื่อถาวร
allow_exports	ป้ายกำกับ ค่าเริ่มต้นคือ None รายการที่อนุญาตซึ่งไม่บังคับที่ป้องกันไม่ให้มีการส่งออก Proto ไลบรารีอีกครั้งหรือใช้ใน lang_proto_library ที่ไม่ได้อยู่ในแพ็กเกจที่ระบุไว้
exports	รายการป้ายกำกับ ค่าเริ่มต้นคือ [] รายการเป้าหมาย Proto_library ที่อ้างอิงได้ผ่าน "นำเข้าสาธารณะ" ในซอร์สโปรโต ซึ่งจะเป็นข้อผิดพลาดหากคุณใช้ "นำเข้าแบบสาธารณะ" แต่ไม่ได้แสดงรายการไลบรารีที่เกี่ยวข้องในแอตทริบิวต์การส่งออก โปรดทราบว่าคุณได้แสดงรายการไลบรารีทั้งใน Dep และการส่งออกเนื่องจากการใช้งาน lang_protocol_library ยังไม่มีการเปลี่ยนแปลง
import_prefix	สตริง ค่าเริ่มต้นคือ "" คำนำหน้าที่จะเพิ่มลงในเส้นทางของไฟล์ .prof ในกฎนี้ เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .prof ในแอตทริบิวต์ srcs ของกฎนี้จะเข้าถึงได้ที่ คือค่าของแอตทริบิวต์นี้ ซึ่งไว้ข้างหน้าเส้นทางที่สัมพันธ์กับที่เก็บ ระบบจะนำคำนำหน้าในแอตทริบิวต์ strip_import_prefix ออกก่อนที่จะเพิ่มคำนำหน้านี้
strip_import_prefix	สตริง ค่าเริ่มต้นคือ "/" คำนำหน้าที่จะตัดออกจากเส้นทางของไฟล์ .prof ในกฎนี้ เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .prof ในแอตทริบิวต์ srcs ของกฎนี้จะเข้าถึงได้ที่เส้นทางของไฟล์โดยตัดคำนำหน้านี้ หากเป็นเส้นทางแบบสัมพัทธ์ (ไม่ได้เริ่มต้นด้วยเครื่องหมายทับ) ระบบจะใช้เป็นเส้นทางหนึ่งที่สัมพันธ์กับแพ็กเกจ หากเป็นเส้นทางสัมบูรณ์ ระบบเข้าใจว่าเป็นเส้นทางที่สัมพันธ์กับที่เก็บ ระบบจะเพิ่มคำนำหน้าในแอตทริบิวต์ import_prefix หลังจากที่เลิกใช้คำนำหน้านี้

proto_lang_toolchain

ดูแหล่งที่มาของกฎ

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

หากใช้ Bazel โปรดโหลดกฎจาก https://github.com/bazelbuild/rules_protocol

ระบุกฎ LANG_proto_library (เช่น java_proto_library) ควรเรียกใช้ Proto-Compiler กฎ LANG_Pro_library บางกฎอนุญาตให้ระบุ Toolchain ที่จะใช้โดยใช้แฟล็กบรรทัดคำสั่งได้ โปรดศึกษาเอกสารประกอบ

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

ไม่มีคอมไพเลอร์ ซึ่งได้มาจากกฎ protocol_library ที่เราแนบไปด้วย และส่งเป็นแฟล็กบรรทัดคำสั่งไปยัง Blaze มีฟีเจอร์หลายอย่างที่ต้องมีการเรียกใช้ Pro-compiler ในตัวกฎ protocol_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	ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
allowlist_different_package	ป้ายกำกับ ค่าเริ่มต้นคือ None
blacklisted_protos	รายการป้ายกำกับ ค่าเริ่มต้นคือ [] จะไม่มีการสร้างโค้ดสำหรับไฟล์ในแอตทริบิวต์ srcs ของ blacklisted_protos ใช้สำหรับไฟล์ .Pro ที่ลิงก์กับรันไทม์ของ Pro แล้ว เช่น any.proto
command_line	สตริง ต้องระบุ ค่านี้จะส่งไปยังโปรโตคอมไพเลอร์เพื่อสร้างโค้ด รวมเฉพาะส่วนเฉพาะสำหรับโปรแกรมสร้าง/ปลั๊กอินนี้ (เช่น อย่ารวมพารามิเตอร์ -I) $(OUT) เป็น LANG_protocol_library โดยเฉพาะ คาดหวังให้กฎกำหนดวิธีการตีความตัวแปรนี้ ตัวอย่างเช่น $(OUT) สำหรับ Java จะแทนที่ด้วยชื่อไฟล์ src-jar ที่จะสร้าง
mnemonic	สตริง ค่าเริ่มต้นคือ "GenProto" ค่านี้จะตั้งเป็นการช่วยจำในการทำงานของโปรโตค
output_files	สตริง ค่าเริ่มต้นคือ "legacy" ควบคุมวิธีจัดรูปแบบ $(OUT) ใน command_line ไม่ว่าจะเป็นตามเส้นทางไปยังไฟล์เดียวหรือไดเรกทอรีเอาต์พุตในกรณีที่มีไฟล์หลายไฟล์ ค่าที่เป็นไปได้คือ "single", "multiple"
plugin	ป้ายกำกับ ค่าเริ่มต้นคือ None หากมี จะพร้อมใช้งานสำหรับการดำเนินการที่เรียกใช้ Proto-compiler และจะส่งไปยังคอมไพเลอร์ Proto:--plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag	สตริง ค่าเริ่มต้นคือ "" หากระบุ ระบบจะส่งค่านี้ไปยัง Proto-compiler เพื่อใช้ปลั๊กอิน ค่าต้องมี %s เดี่ยวซึ่งแทนที่ด้วยไฟล์ปฏิบัติการของปลั๊กอิน --plugin=protoc-gen-PLUGIN=<executable>.
progress_message	สตริง ค่าเริ่มต้นคือ "Generating proto_library %{label}" ค่านี้จะตั้งเป็นข้อความแสดงความคืบหน้าในการดำเนินการ Protoc
protoc_minimal_do_not_use	ป้ายกำกับ ค่าเริ่มต้นคือ None
runtime	ป้ายกำกับ ค่าเริ่มต้นคือ None ไลบรารีเฉพาะภาษาที่มีการนำโค้ดที่สร้างขึ้นมาคอมไพล์ การทำงานจะเหมือนกับ LANG_prod_library เช่น Java ควรคอมไพล์ตามรันไทม์
toolchain_type	ป้ายกำกับ ค่าเริ่มต้นคือ None