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

กฎ

• cc_proto_library
• java_lite_proto_library
• java_proto_library
• proto_library
• py_proto_library
• proto_lang_toolchain
• proto_toolchain

cc_proto_library

cc_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library สร้างโค้ด C++ จากไฟล์ .proto

deps ต้องชี้ไปยังกฎ proto_library

ตัวอย่าง

cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

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

java_lite_proto_library

java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library สร้างโค้ด Java จากไฟล์ .proto

deps ต้องชี้ไปยังกฎ proto_library

ตัวอย่าง

java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

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

java_proto_library

java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library สร้างโค้ด Java จากไฟล์ .proto

deps ต้องชี้ไปยังกฎ proto_library

ตัวอย่าง

java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

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

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

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

py_proto_library

py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

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

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

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

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

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

proto_toolchain

proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

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