程式設計指南

了解如何在專案中使用 Protocol Buffers。

語言指南(版本)

涵蓋如何在專案中使用 Protocol Buffers 語言的 2023 年版本。

語言指南 (proto 2)

涵蓋如何在專案中使用 Protocol Buffers 語言的 proto2 版本。

語言指南 (proto 3)

涵蓋如何在專案中使用 Protocol Buffers 語言的 proto3 版本。

Proto 限制

涵蓋 proto schema 中支援的元素數量限制。

風格指南

提供有關如何最佳化結構化 proto 定義的指引。

列舉行為

說明列舉在 Protocol Buffers 中的目前運作方式與應有的運作方式。

編碼

說明 Protocol Buffers 如何將資料編碼至檔案或傳輸。

ProtoJSON 格式

涵蓋如何使用 Protobuf 至 JSON 轉換工具。

技術

描述一些常用於處理 Protocol Buffers 的設計模式。

第三方附加元件

連結至許多開放原始碼專案,這些專案旨在於 Protocol Buffers 之上新增實用的功能。

擴充宣告

詳細描述擴充宣告是什麼、為何需要它們以及如何使用它們。

應用說明:欄位存在性

說明 protobuf 欄位的各種存在性追蹤機制。它也說明使用基本類型的單數 proto3 欄位之顯式存在性追蹤的行為。

Proto 序列化並非標準

說明序列化如何運作,以及為何它不是標準。

不支援可為空的 Setter/Getter

涵蓋 Protobuf 為何不支援可為空的 setter 和 getter

Proto 最佳實踐

最佳實踐主題的概述。

Proto 最佳實踐

分享經審核的撰寫 Protocol Buffers 最佳實踐。

API 最佳實踐

一個具有前瞻性的 API 難以正確。本文檔中的建議會進行取捨,以利於長期、無錯誤的演變。

1-1-1 最佳實踐

每個檔案的所有 proto 定義都應有一個頂層元素和建置目標。