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

รายงานปัญหา ดูแหล่งที่มา Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

กฎ

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) ควรเรียกใช้ โปรโตคอมไพเลอร์ กฎ LANG_proto_library บางอย่างอนุญาตให้ระบุ Toolchain ที่จะใช้โดยใช้แฟล็กบรรทัดคำสั่ง โปรดดูเอกสารประกอบ

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

ไม่มีคอมไพเลอร์ คอมไพเลอร์โปรโตมาจากกฎ proto_library ที่เราแนบมา โดยจะ ส่งเป็น Flag บรรทัดคำสั่งไปยัง Blaze ฟีเจอร์หลายอย่างต้องเรียกใช้โปรแกรมคอมไพเลอร์ Proto ในกฎ 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"` ค่านี้จะตั้งเป็น Mnemonic ในการดำเนินการ 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` ไฟล์ที่เรียกใช้งานได้ของคอมไพเลอร์โปรโต หากระบุไว้ ระบบจะใช้เป้าหมายนี้เป็นโปรโตคอมไพเลอร์เพื่อสร้างโค้ด
`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 เพื่อกำหนดไลบรารีของ Protocol Buffer ซึ่งอาจใช้ได้จากหลายภาษา 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 Provider ดูเอกสารประกอบใน ProtoInfo.java

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

กฎ proto_library หนึ่งข้อต่อไฟล์ .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` อาจว่างเปล่าคือไลบรารีแทนชื่อ นี่คือ กฎ 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` หลังจากที่นำคำนำหน้านี้ออก แล้ว