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

Nightly · 9.1 · 9.0 · 8.7 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

กฎ

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

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

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

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

แอตทริบิวต์
name

ชื่อ; ต้องระบุ

ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
blacklisted_protos

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

ระบบจะไม่สร้างโค้ดสำหรับไฟล์ใน srcs แอตทริบิวต์ของ blacklisted_protos ซึ่งใช้สำหรับไฟล์ .proto ที่ลิงก์กับรันไทม์ proto แล้ว เช่น any.proto.
command_line

สตริง; ต้องระบุ

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

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

ระบบจะตั้งค่านี้เป็น mnemonic ในการดำเนินการ protoc
output_files

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

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

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

หากระบุไว้ ระบบจะทำให้พร้อมใช้งานสำหรับการดำเนินการที่เรียกใช้ proto-compiler และจะส่งไปยัง proto-compiler:--plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

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

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

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

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

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

ไฟล์ปฏิบัติการของ proto-compiler หากระบุไว้ ระบบจะใช้เป้าหมายนี้เป็น proto-compiler เพื่อสร้างโค้ด
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

เมื่อคอมไพล์ในบรรทัดคำสั่ง a 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 โปรดดูเอกสารประกอบใน ProtoInfo.java

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

  • กฎ proto_library 1 ข้อต่อไฟล์ .proto 1 ไฟล์
  • ไฟล์ชื่อ foo.proto จะอยู่ในกฎชื่อ foo_proto ซึ่ง อยู่ในแพ็กเกจเดียวกัน
  • [language]_proto_library ที่ห่อหุ้ม proto_library ชื่อ foo_proto ควรเรียกว่า foo_[language]_proto และอยู่ในแพ็กเกจเดียวกัน

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

แอตทริบิวต์
name

ชื่อ; ต้องระบุ

ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้
deps

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

รายการกฎ proto_library อื่นๆ ที่เป้าหมายขึ้นอยู่ด้วย proto_library ขึ้นอยู่กับเป้าหมาย proto_library อื่นๆ ได้เท่านั้น และขึ้นอยู่กับไลบรารีเฉพาะภาษาไม่ได้
srcs

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

รายการไฟล์ .proto และ .protodevel ที่ ประมวลผลเพื่อสร้างเป้าหมาย ซึ่งโดยปกติแล้วจะเป็นรายการที่ไม่ว่างเปล่า กรณีการใช้งานที่ srcs อาจว่างเปล่าคือ ไลบรารีนามแฝง ซึ่งเป็นกฎ proto_library ที่มี proto_library อื่นอย่างน้อย 1 รายการใน deps คุณสามารถใช้รูปแบบนี้เพื่อส่งออก API สาธารณะภายใต้ชื่อที่คงอยู่ได้ เช่น
allow_exports

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

รายการที่อนุญาตที่ไม่บังคับซึ่งป้องกันไม่ให้ส่งออกไลบรารี proto อีกครั้งหรือใช้ใน 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 หลังจากนำคำนำหน้านี้ออก