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

รายงานปัญหา ดูแหล่งที่มา ตอนกลางคืน · 7.4 ที่ใช้เวลาเพียง 2 นาที 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_protocol_library (เช่น java_proto_library) ควรเรียกใช้เมธอด Proto-compiler กฎ LANG_proto_library บางข้ออนุญาตให้ระบุเครื่องมือทางเทคนิคที่จะใช้โดยใช้ Flag บรรทัดคำสั่ง โปรดดูเอกสารประกอบ

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

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

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