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

วันที่ รายงานปัญหา ดูแหล่งที่มา ตอนกลางคืน · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

กฎ

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_proto.

ใช้ 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 คอลเล็กชันของสกรรมกริยา ชุดข้อบ่งชี้พร้อมให้ใช้งานผ่าน [ProtoInfo].transitive_descriptor_sets ผู้ให้บริการ Starlark ดูเอกสารประกอบใน 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 ที่ ประมวลผลเพื่อสร้างเป้าหมาย ซึ่งโดยปกติเป็นรายการที่ไม่ว่างเปล่า หนึ่งกรณีการใช้งาน ค่าที่ srcs สามารถเว้นว่างได้คือ alias-library นี่คือ กฎ Proto_library ที่มี proto_library อื่นอย่างน้อย 1 รายการใน deps รูปแบบนี้สามารถใช้เพื่อทําสิ่งต่อไปนี้ได้ ส่งออก API สาธารณะภายใต้ชื่อถาวร
allow_exports

ป้ายกำกับ ค่าเริ่มต้นคือ None

รายการที่อนุญาตที่ไม่บังคับซึ่งป้องกันไม่ให้มีการส่งออกหรือใช้ไลบรารี Proto อีกครั้ง lang_prod_library ที่ไม่ได้อยู่ในแพ็กเกจที่ระบุไว้
exports

รายการป้ายกำกับ ค่าเริ่มต้นคือ []

รายการเป้าหมาย Proto_library ที่สามารถอ้างอิงผ่าน "นำเข้าสาธารณะ" ได้ ในช่วง แหล่งที่มาของ Proto คุณจะเห็นข้อผิดพลาดหากคุณใช้ "นำเข้าแบบสาธารณะ" แต่ไม่แสดงไลบรารีที่เกี่ยวข้อง ในแอตทริบิวต์การส่งออก โปรดทราบว่าคุณได้แสดงรายการไลบรารีทั้งใน Dep และการส่งออก เนื่องจากไม่ใช่บางรายการ การใช้งาน lang_protocol_library ได้รับการเปลี่ยนแปลงแล้ว
import_prefix

String; ค่าเริ่มต้นคือ ""

คำนำหน้าที่จะเพิ่มลงในเส้นทางของไฟล์ .prof ในกฎนี้

เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .protocol ในแอตทริบิวต์ srcs ของกฎนี้จะเป็น "เข้าถึงได้ที่" คือค่าของแอตทริบิวต์นี้ที่เพิ่มไว้ข้างหน้าเส้นทางที่สัมพันธ์กับที่เก็บ

ระบบนำคำนำหน้าในแอตทริบิวต์ strip_import_prefix ออกก่อนหน้านั้น เพิ่มคำนำหน้าแล้ว

strip_import_prefix

String; ค่าเริ่มต้นคือ "/"

คำนำหน้าที่จะตัดออกจากเส้นทางของไฟล์ .prof ในกฎนี้

เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .protocol ในแอตทริบิวต์ 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_proto.

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

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

ไม่มีคอมไพเลอร์ ซึ่งได้มาจากกฎ protocol_library ที่เราแนบไปด้วย ใช่เลย ส่งเป็นแฟล็กบรรทัดคำสั่งไปยัง Blaze มีฟีเจอร์หลายอย่างที่ต้องมีการเรียกใช้ Pro-Compiler ในตัวกฎ Proto_library การบังคับใช้คอมไพเลอร์ที่ LANG_prof_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 ใช้สำหรับไฟล์ .prof ที่ลิงก์กับรันไทม์ของ Pro แล้ว เช่น any.proto
command_line

String; ต้องระบุ

ค่านี้จะส่งไปยังโปรโตคอมไพเลอร์เพื่อสร้างโค้ด ใส่เฉพาะส่วน เฉพาะสำหรับโปรแกรมสร้าง/ปลั๊กอินนี้ (เช่น อย่ารวมพารามิเตอร์ -I)
  • $(OUT) เป็น LANG_protocol_library โดยเฉพาะ กฎเหล่านี้เป็นสิ่งที่เป็นตัวกำหนด วิธีที่ตัวแปรนี้ตีความ ตัวอย่างเช่น สำหรับ Java $(OUT) จะถูกแทนที่ด้วย ชื่อไฟล์ src-jar ที่จะสร้าง
mnemonic

String; ค่าเริ่มต้นคือ "GenProto"

ค่านี้จะตั้งเป็นการช่วยจำในการทำงานของโปรโตค
output_files

String; ค่าเริ่มต้นคือ "legacy"

ควบคุมวิธีจัดรูปแบบ $(OUT) ใน command_line ด้วย เส้นทางไปยังไฟล์เดียวหรือไดเรกทอรีเอาต์พุตในกรณีที่มีไฟล์หลายไฟล์ ค่าที่เป็นไปได้คือ "single", "multiple"
plugin

ป้ายกำกับ ค่าเริ่มต้นคือ None

ถ้ามี จะพร้อมใช้งานสำหรับการทำงานที่เรียกใช้ Proto-Compiler และจะ ที่ส่งไปยังคอมไพเลอร์ Proto: --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

String; ค่าเริ่มต้นคือ ""

หากระบุ ระบบจะส่งค่านี้ไปยัง Proto-compiler เพื่อใช้ปลั๊กอิน ค่าต้องมี %s เดี่ยวซึ่งแทนที่ด้วยไฟล์ปฏิบัติการของปลั๊กอิน --plugin=protoc-gen-PLUGIN=<executable>.
progress_message

String; ค่าเริ่มต้นคือ "Generating proto_library %{label}"

ค่านี้จะตั้งเป็นข้อความแสดงความคืบหน้าในการดำเนินการ Protoc
protoc_minimal_do_not_use

ป้ายกำกับ ค่าเริ่มต้นคือ None

runtime

ป้ายกำกับ ค่าเริ่มต้นคือ None

ไลบรารีเฉพาะภาษาที่คอมไพล์โค้ดที่สร้างขึ้น การทำงานจะเหมือนกับ LANG_prod_library เช่น Java ควรคอมไพล์ตามรันไทม์
toolchain_type

ป้ายกำกับ ค่าเริ่มต้นคือ None