通訊協定緩衝區規則

回報問題 查看原始碼 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

規則

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",
)

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
deps

標籤清單；預設為 []

要產生 C++ 程式碼的 proto_library 規則清單。

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",
)

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
deps

標籤清單；預設為 []

要產生 Java 程式碼的 proto_library 規則清單。

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",
)

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
deps

標籤清單；預設為 []

要產生 Java 程式碼的 proto_library 規則清單。

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，且位於相同套件中。

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
deps

標籤清單；預設為 []

目標依附的其他 proto_library 規則清單。proto_library 只能依附其他 proto_library 目標。可能不會依附語言專屬程式庫。
srcs

標籤清單；預設為 []

系統在建立目標時所處理的 .proto 和 .protodevel 檔案清單。這通常是不會為空的清單。srcs 可為空白的一個用途是別名程式庫。這是 proto_library 規則，在 deps 中含有一或多個其他 proto_library。例如，您可以使用這個模式，以持久名稱匯出公開 API。
allow_exports

標籤；預設為 None

選用的許可清單，可防止 proto 程式庫重新匯出，或用於未列在其中的包裝程式 lang_proto_library。
exports

標籤清單；預設為 []

在 proto 來源中，可透過「import public」參照的 proto_library 目標清單。如果您使用「import public」，但未在 exports 屬性中列出對應的程式庫，就會發生錯誤。請注意，由於並非所有 lang_proto_library 實作項目都已變更，因此您必須在依附元件和匯出項目中列出該程式庫。
import_prefix

字串；預設為 ""

這個規則中 .proto 檔案路徑要新增的前置字串。

設定後，您就可以在這個規則的 srcs 屬性中存取 .proto 來源檔案，該屬性值會附加至相對於存放區的路徑。

系統會先移除 strip_import_prefix 屬性中的前置字串，再新增這個前置字串。
strip_import_prefix

字串；預設為 "/"

要從此規則中 .proto 檔案路徑中移除的前置字串。

設定後，您就可以透過這個前置字串的路徑存取此規則 srcs 屬性中的 .proto 來源檔案。

如果是相對路徑 (開頭不是斜線)，則會視為相對於套件的路徑。如果是絕對路徑，系統會將其視為相對於存放區的路徑。

這個前置字元會在移除後，新增至 import_prefix 屬性。

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)
使用 `py_proto_library` 從 `.proto` 檔案產生 Python 程式庫。 慣例是將 `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"], ) ```

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
deps

標籤清單；預設為 []

要為其產生 Python 程式庫的 `proto_library` 規則清單。通常這只是一個目標：您感興趣的 proto 程式庫。可以是任何提供 `ProtoInfo` 的目標。

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",
)

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
allowlist_different_package

標籤；預設為 None
blacklisted_protos

標籤清單；預設為 []

系統不會為 blacklisted_protos 的 srcs 屬性中所列的檔案產生程式碼。這項功能適用於已連結至 proto 執行階段的 .proto 檔案，例如 any.proto。
command_line

字串；必填

這個值會傳遞至 Proto 編譯器，以產生程式碼。只包含此程式碼產生器/外掛程式專屬的部分 (例如，請勿加入 -I 參數)
  • $(OUT) 是 LANG_proto_library 專屬，規則應定義解讀這個變數的方式。舉例來說，如果是 Java，系統會將 $(OUT) 替換為要建立的 src-jar 檔案名稱。
mnemonic

字串；預設為 "GenProto"

這個值會設為 protoc 動作的助憶法。
output_files

字串；預設為 "legacy"

控管 command_line 中的 $(OUT) 格式設定方式，可透過單一檔案的路徑或輸出目錄 (如果有多個檔案) 來設定。可能的值為「single」(單一) 和「multiple」(多個)。
plugin

標籤；預設為 None

如果提供，則會提供給呼叫 Proto 編譯器的動作，並傳遞至 Proto 編譯器： --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

字串；預設為 ""

如果提供此值，系統會將其傳遞至 proto 編譯器，以便使用外掛程式。這個值必須包含單一 %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, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

引數

屬性
name

名稱 (必填)

這個目標的專屬名稱。
command_line

字串；預設為 "--descriptor_set_out=%s"
mnemonic

字串；預設為 "GenProtoDescriptorSet"
output_files

字串；預設為 "single"
progress_message

字串；預設為 "Generating Descriptor Set proto_library %{label}"
proto_compiler

標籤；預設為 None