通訊協定緩衝區規則

規則

• 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 會從 .proto 檔案產生 C++ 程式碼。

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 會根據 .proto 檔案產生 Java 程式碼。

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 會根據 .proto 檔案產生 Java 程式碼。

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 的檔案，這是規則 src 的訊息描述符集。檔案是序列化的 FileDescriptorSet，相關說明請參閱 https://developers.google.com/protocol-buffers/docs/techniques#self-description。

它只包含 proto_library 規則直接提及的 .proto 檔案相關資訊；您可以透過 [ProtoInfo].transitive_descriptor_sets Starlark 供應工具收集轉換描述元件集。請參閱 proto_info.bzl 中的說明文件。

建議的程式碼結構：

• 每個 .proto 檔案只能有一個 proto_library 規則。
• 名稱為 foo.proto 的檔案會位於同一個套件中的 foo_proto 規則中。
• 包裝名為 foo_proto 的 proto_library 的 [language]_proto_library 應稱為 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 規則可讓您使用指令列標記指定要使用的工具鍊；請參閱相關說明文件。

除非您想調整 Java 編譯器，否則通常不應編寫這類規則。

沒有編譯器。系統會從我們附加的 proto_library 規則取得 proto 編譯器。會以指令列標記的形式傳遞給 Blaze。部分功能需要在 proto_library 規則本身上叫用 proto 編譯器。強制執行 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)

引數