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

รายงานปัญหา ดูซอร์ส รุ่น Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

กฎ

cc_proto_library

ดูแหล่งที่มาของกฎ 
cc_proto_library(name, deps, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, 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",
)

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

Attributes
name

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

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

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

รายการกฎ proto_library ที่จะสร้างโค้ด C++

java_lite_proto_library

ดูแหล่งที่มาของกฎ 
java_lite_proto_library(name, deps, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, 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",
)

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

Attributes
name

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

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

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

รายการกฎ proto_library ที่จะสร้างโค้ด Java

java_proto_library

ดูแหล่งที่มาของกฎ 
java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_group_compatible_with, exec_properties, features, licenses, package_metadata, 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",
)

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

Attributes
name

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

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

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

รายการกฎ proto_library ที่จะสร้างโค้ด Java
distribs

รายการสตริง ค่าเริ่มต้นคือ []

proto_library

ดูแหล่งที่มาของกฎ 
proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, exports, features, import_prefix, licenses, package_metadata, 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 และอยู่ในแพ็กเกจเดียวกัน

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

Attributes
name

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

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

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

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

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

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

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

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

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

รายการเป้าหมาย proto_library ที่อ้างอิงได้ผ่าน "import public" ในแหล่งที่มาของ proto ระบบจะแสดงข้อผิดพลาดหากคุณใช้ "import public" แต่ไม่ได้ระบุไลบรารีที่เกี่ยวข้องในแอตทริบิวต์ exports โปรดทราบว่าคุณต้องระบุไลบรารีทั้งใน deps และ exports เนื่องจากมีการใช้งาน _lang_proto_library เพียงบางส่วนเท่านั้นที่เปลี่ยนแปลง
import_prefix

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

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

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

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

strip_import_prefix

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

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

เมื่อตั้งค่าแล้ว ไฟล์ต้นฉบับ .proto ในแอตทริบิวต์ srcs ของกฎนี้จะเข้าถึงได้ที่เส้นทางโดยตัดคำนำหน้านี้ออก

หากเป็นเส้นทางแบบสัมพัทธ์ (ไม่ขึ้นต้นด้วยเครื่องหมายทับ) ระบบจะถือว่าเส้นทางนั้นสัมพันธ์กับแพ็กเกจ หากเป็นเส้นทางสัมบูรณ์ ระบบจะเข้าใจว่าเป็นเส้นทางสัมพัทธ์กับที่เก็บ

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

py_proto_library

ดูแหล่งที่มาของกฎ 
py_proto_library(name, deps, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
 ใช้ `py_proto_library` เพื่อสร้างไลบรารี Python จากไฟล์ `.proto` ธรรมเนียมปฏิบัติคือตั้งชื่อกฎ `py_proto_library` เป็น `foo_py_pb2` เมื่อรวมกฎ `proto_library` ของ `foo_proto` `deps` ต้องชี้ไปยังกฎ `proto_library` ตัวอย่าง ```starlark py_library( name = "lib", deps = [":foo_py_pb2"], ) py_proto_library( name = "foo_py_pb2", deps = [":foo_proto"], ) proto_library( name = "foo_proto", srcs = ["foo.proto"], ) ```

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

Attributes
name

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

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

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

รายการกฎ `proto_library` ที่จะสร้างไลบรารี Python โดยปกติแล้วจะมีเพียงเป้าหมายเดียวเท่านั้น ได้แก่ ไลบรารีโปรโตที่สนใจ อาจเป็นเป้าหมายใดก็ได้ที่ให้ "ProtoInfo"

proto_lang_toolchain

ดูแหล่งที่มาของกฎ 
proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, 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",
)

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

Attributes
name

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

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

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

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

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

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

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

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

ระบบจะตั้งค่านี้เป็นคําช่วยจําในการดําเนินการ 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
protoc_minimal_do_not_use

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

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

ไลบรารีเฉพาะภาษาที่คอมไพล์โค้ดที่สร้างขึ้น ลักษณะการทำงานที่แน่นอนจะขึ้นอยู่กับ LANG_proto_library เช่น Java ควรคอมไพล์กับรันไทม์
toolchain_type

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

proto_toolchain

ดูแหล่งที่มาของกฎ 
proto_toolchain(name, command_line, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

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

Attributes
name

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

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

สตริง ค่าเริ่มต้นคือ "--descriptor_set_out=%s"
mnemonic

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

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

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

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