Android序列化：Google出品的序列化神器Protocol Buffer不瞭解一下？

Carson_Ho發表於2019-03-04

AndroidGoProtocol

前言

習慣用 Json、XML 資料儲存格式的你們，相信大多都沒聽過Protocol Buffer
Protocol Buffer 其實是 Google出品的一種輕量 & 高效的結構化資料儲存格式，效能比 Json、XML 真的強！太！多！

由於 Google出品，我相信Protocol Buffer已經具備足夠的吸引力

今天，我將詳細介紹Protocol Buffer在Android平臺的具體使用

閱讀本文前請先閱讀：快來看看Google出品的Protocol Buffer，別隻會用Json和XML了

1. 定義

一種結構化資料的資料儲存格式（類似於 XML、Json ）

Google 出品（開源）

Protocol Buffer 目前有兩個版本：proto2 和 proto3

因為proto3 還是beta 版，所以本次講解是 proto2

2. 作用

通過將結構化的資料進行序列化（序列化），從而實現 資料儲存 / RPC 資料交換的功能

序列化：將資料結構或物件轉換成二進位制串的過程

反序列化：將在序列化過程中所生成的二進位制串轉換成資料結構或者物件的過程

3. 特點

對比於常見的 XML、Json 資料儲存格式，Protocol Buffer有如下特點：

4. 應用場景

傳輸資料量大 & 網路環境不穩定的資料儲存、RPC 資料交換 的需求場景

如即時IM （QQ、微信）的需求場景

總結

在 傳輸資料量較大的需求場景下，Protocol Buffer比XML、Json 更小、更快、使用 & 維護更簡單！

5. 使用流程

使用 Protocol Buffer 的流程如下：

今天主要講解Protocol Buffer在Android平臺的具體使用

6. 應用例項（Android平臺）

具體步驟如下：

步驟1：將生成的程式碼檔案放入到專案中

對於Android（Java）平臺，即將編譯.proto檔案生成的Java包檔案整個複製到 Android 專案中
放置路徑： app/src/main/java的 資料夾裡

步驟2：在 `Gradle` 新增 `Protocol Buffer` 版本依賴

compile 'com.google.protobuf:protobuf-java:2.6.1'
// 注：protobuf-java的版本 一定要和 安裝protocobuffer的版本 一致
複製程式碼

步驟3：具體在Android專案中使用

3.1 訊息物件類介紹

通過.proto檔案 轉換的 Java原始碼 = Protocol Buffer 類 + 訊息物件類（含Builder內部類）

訊息物件類是 Protocol Buffer 類的內部類

由於最常用的都是訊息物件類和其內部類Builder類的方法&成員變數，所以此處主要講解這兩者。

3.1.1 訊息物件類（`Message`類）

訊息物件類類通過 二進位制陣列 寫和讀訊息型別
使用方法包括：

<-- 方式1：直接序列化和反序列化 訊息 -->
protocolBuffer.toByteArray()；
// 序列化訊息 並 返回一個包含它的原始位元組的位元組陣列
protocolBuffer.parseFrom(byte[] data)；
// 從一個位元組陣列 反序列化（解析） 訊息

<-- 方式2：通過輸入/ 輸出流（如網路輸出流） 序列化和反序列化訊息 -->
protocolBuffer.writeTo(OutputStream output)；
output.toByteArray();
// 將訊息寫入 輸出流 ，然後再 序列化訊息 

protocolBuffer.parseFrom(InputStream input)；
// 從一個 輸入流 讀取並 反序列化（解析）訊息


// 只含包含欄位的getters方法
// required string name = 1;
public boolean hasName();// 如果欄位被設定，則返回true
public java.lang.String getName();

// required int32 id = 2;
public boolean hasId();
public int getId();

// optional string email = 3;
public boolean hasEmail();
public String getEmail();

// repeated .tutorial.Person.PhoneNumber phone = 4;
// 重複（repeated）欄位有一些額外方法
public List<PhoneNumber> getPhoneList();
public int getPhoneCount();
// 列表大小的速記
// 作用：通過索引獲取和設定列表的特定元素的getters和setters
複製程式碼

常用的如上，更多請看官方文件

3.1.2 `Builder`類

作用：建立訊息構造器 & 設定/ 獲取訊息物件的欄位值 & 建立訊息類例項

屬於訊息物件類的內部類

a. 建立訊息構造器

Demo.Person.Builder person = Person.newBuilder();
複製程式碼

b. 設定/ 獲取訊息物件的欄位值具體方法如下：

// 標準的JavaBeans風格：含getters和setters
// required string name = 1;
public boolean hasName();// 如果欄位被設定，則返回true
public java.lang.String getName();
public Builder setName(String value);
public Builder clearName(); // 將欄位設定回它的空狀態

// required int32 id = 2;
public boolean hasId();
public int getId();
public Builder setId(int value);
public Builder clearId();

// optional string email = 3;
public boolean hasEmail();
public String getEmail();
public Builder setEmail(String value);
public Builder clearEmail();

// repeated .tutorial.Person.PhoneNumber phone = 4;
// 重複（repeated）欄位有一些額外方法
public List<PhoneNumber> getPhoneList();
public int getPhoneCount();
// 列表大小的速記
// 作用：通過索引獲取和設定列表的特定元素的getters和setters

public PhoneNumber getPhone(int index);
public Builder setPhone(int index, PhoneNumber value);

public Builder addPhone(PhoneNumber value);
// 將新元素新增到列表的末尾

public Builder addAllPhone(Iterable<PhoneNumber> value);
// 將一個裝滿元素的整個容器新增到列表中
public Builder clearPhone();

public Builder isInitialized() 
// 檢查所有 required 欄位 是否都已經被設定

public Builder toString() :
// 返回一個人類可讀的訊息表示（用於除錯）

public Builder mergeFrom(Message other)
// 將 其他內容 合併到這個訊息中，覆寫單數的欄位，附接重複的。

public Builder clear()
// 清空所有的元素為空狀態。
複製程式碼

3.2 具體使用

使用步驟如下： **步驟1：**通過訊息類的內部類Builder類構造訊息構造器 **步驟2：**通過訊息構造器設定訊息欄位的值 **步驟3：**通過訊息構造器建立訊息類物件 **步驟4：**序列化 / 反序列化訊息
具體使用如下：（註釋非常清晰）

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 步驟1:通過 訊息類的內部類Builder類 構造 訊息類的訊息構造器
        Demo.Person.Builder personBuilder =  Demo.Person.newBuilder();

        // 步驟2:設定你想要設定的欄位為你選擇的值
        personBuilder.setName("Carson");// 在定義.proto檔案時,該欄位的欄位修飾符是required,所以必須賦值
        personBuilder.setId(123);// 在定義.proto檔案時,該欄位的欄位修飾符是required,所以必須賦值
        personBuilder.setEmail("carson.ho@foxmail.com"); // 在定義.proto檔案時,該欄位的欄位修飾符是optional,所以可賦值 / 不賦值(不賦值時將使用預設值)

        Demo.Person.PhoneNumber.Builder phoneNumber =  Demo.Person.PhoneNumber.newBuilder();
        phoneNumber.setType( Demo.Person.PhoneType.HOME);// 直接採用列舉型別裡的值進行賦值
        phoneNumber.setNumber("0157-23443276");
        // PhoneNumber訊息是巢狀在Person訊息裡,可以理解為內部類
        // 所以建立物件時要通過外部類來建立

        // 步驟3:通過 訊息構造器 建立 訊息類 物件
        Demo.Person person = personBuilder.build();

        // 步驟4:序列化和反序列化訊息(兩種方式)

        /*方式1：直接 序列化 和 反序列化 訊息 */
        // a.序列化
        byte[] byteArray1 = person.toByteArray();
        // 把 person訊息類物件 序列化為 byte[]位元組陣列
        System.out.println(Arrays.toString(byteArray1));
        // 檢視序列化後的位元組流
      
        // b.反序列化
        try {

            Demo.Person person_Request = Demo.Person.parseFrom(byteArray1);
            // 當接收到位元組陣列byte[] 反序列化為 person訊息類物件

            System.out.println(person_Request.getName());
            System.out.println(person_Request.getId());
            System.out.println(person_Request.getEmail());
            // 輸出反序列化後的訊息
        } catch (IOException e) {
            e.printStackTrace();
        }
       

        /*方式2：通過輸入/ 輸出流（如網路輸出流） 序列化和反序列化訊息 */
        // a.序列化
        ByteArrayOutputStream output = new ByteArrayOutputStream();
         try {

            person.writeTo(output);
            // 將訊息序列化 並寫入 輸出流(此處用 ByteArrayOutputStream 代替)

        } catch (IOException e) {
            e.printStackTrace();
        }

        byte[] byteArray = output.toByteArray();
        // 通過 輸出流 轉化成二進位制位元組流

        // b. 反序列化
        ByteArrayInputStream input = new ByteArrayInputStream(byteArray);
        // 通過 輸入流 接收訊息流(此處用 ByteArrayInputStream 代替)

        try {

            Demo.Person person_Request = Demo.Person.parseFrom(input);
            // 通過輸入流 反序列化 訊息

            System.out.println(person_Request.getName());
            System.out.println(person_Request.getId());
            System.out.println(person_Request.getEmail());
            // 輸出訊息
        } catch (IOException e) {
            e.printStackTrace();
        }
            
    }
}
複製程式碼

Demo 地址

Carson_Ho的Github ：https://github.com/Carson-Ho/ProtocolBuffer

高階功能

貼心的Google還提供將Protocol Buff 編碼方式轉化為其他編碼方式，如 Json、XML等等

即將 Protocol Buff 物件轉化為其他編碼方式的資料儲存物件

下面展示的是將 Protocol Buff 物件轉化為 Json物件

// 步驟1：在Gradle加入依賴
compile 'com.googlecode.protobuf-java-format:protobuf-java-format:1.4'

// 步驟2：將`Protocol Buff` 物件 序列化 為 `Json`物件
JsonFormat jsonFormat = new JsonFormat();  
String person2json = jsonFormat.printToString(mProtoBuffer); 

複製程式碼

至此，關於Protocol Buffer的使用講解完畢。

7. 總結

看完本文，你應該非常瞭解Protocol Buffer 在Android平臺的使用
關於Protocol Buffer的系列文章請看：

下一篇文章我將對Protocol Buffer 的原始碼進行詳細分析，有興趣可以繼續關注Carson_Ho的安卓開發筆記

請點贊！因為你的鼓勵是我寫作的最大動力！

Protocol Buffer序列化Java框架-Protostuff
2021-11-29
ProtocolJava框架
快來看看 Google 出品的 Protocol Buffer，別隻會用 JSON 和 XML 了
2017-07-07
GoProtocolJSONXML
Google Protocol Buffer 的使用和原理
2013-12-10
GoProtocol
google protocol buffer——protobuf的編碼原理二
2020-08-30
GoProtocol
一文帶你全面瞭解java物件的序列化和反序列化
2021-05-10
Java物件
前端後臺以及遊戲中使用Google Protocol Buffer詳解
2019-02-28
前端遊戲GoProtocol
google protocol buffer——protobuf的基本使用和模型分析
2020-08-16
GoProtocol模型
google protocol buffer——protobuf的使用特性及編碼原理
2020-08-24
GoProtocol
google protocol buffer——protobuf的問題及改進一
2020-09-07
GoProtocol
google protocol buffer——protobuf的問題和改進2
2020-09-20
GoProtocol
這是一份全面 & 詳細的Google序列化神器protocolBuffer 學習指南
2019-03-04
GoProtocol
FaceBook出品 -- Android除錯神器Stetho
2017-03-24
Android除錯
【Java面試】簡單說一下你對序列化和反序列化的理解
2022-07-08
Java面試
策略模式不瞭解一下？
2021-10-27
模式
Java序列化（Serializable）與反序列化詳解
2018-01-08
Java
RabbitMQ訊息佇列的小夥伴: ProtoBuf（Google Protocol Buffer） [轉]
2015-01-06
MQ佇列GoProtocol
Android 中的Json解析工具fastjson 、序列化、反序列化
2015-05-10
AndroidJSONAST
物件序列化（序列化）
2019-02-16
物件
Google Protobuf Primer (1) 實現跨平臺跨語言的序列化/反序列化
2012-03-15
Go
Google Protocol buffer 學習筆記.下篇-動態編譯
2021-09-09
GoProtocol筆記編譯
Java的序列化和反序列化
2019-04-06
Java
Java的序列化與反序列化
2019-01-29
Java
Protocol Buffer 使用指北
2019-02-24
Protocol
TarsGo支援Protocol Buffer
2018-11-16
GoProtocol
TarsGo 支援 protocol buffer
2018-10-12
GoProtocol
python的序列化和反序列化
2019-03-03
Python
PHP的序列化和反序列化入門
2023-03-27
PHP
Android Camera瞭解一下
2019-03-04
Android
.NET物件的XML序列化和反序列化
2021-09-09
物件XML
物件(List<T>)的序列化和反序列化
2013-11-07
物件
解密gRPC: Protocol Buffer
2023-10-26
解密RPCProtocol
iOS中使用Protocol Buffer
2017-12-12
iOSProtocol
Protocol Buffer Basics: C++
2013-11-25
ProtocolC++
protocol buffer的高效編碼方式
2021-08-24
Protocol
Android序列化問題與思考
2020-11-12
Android
C++ 序列化和反序列化
2023-01-14
C++
JSON 物件序列化、反序列化
2016-09-28
JSON物件
Java--序列化與反序列化
2017-10-05
Java

Android序列化：Google出品的序列化神器Protocol Buffer不瞭解一下？

前言

目錄

1. 定義

2. 作用

3. 特點

4. 應用場景

總結

5. 使用流程

6. 應用例項（Android平臺）

步驟1：將生成的程式碼檔案放入到專案中

步驟2：在 `Gradle` 新增 `Protocol Buffer` 版本依賴

步驟3：具體在Android專案中使用

3.1 訊息物件類介紹

3.1.1 訊息物件類（`Message`類）

3.1.2 `Builder`類

3.2 具體使用

Demo 地址

高階功能

7. 總結

請點贊！因為你的鼓勵是我寫作的最大動力！

相關文章

Android序列化：Google出品的序列化神器Protocol Buffer不瞭解一下？

前言

目錄

1. 定義

2. 作用

3. 特點

4. 應用場景

總結

5. 使用流程

6. 應用例項（Android平臺）

步驟1：將生成的 程式碼檔案 放入到專案中

步驟2：在 Gradle 新增 Protocol Buffer 版本依賴

步驟3：具體在Android專案中使用

3.1 訊息物件類介紹

3.1.1 訊息物件類（Message類）

3.1.2 Builder類

3.2 具體使用

Demo 地址

高階功能

7. 總結

請點贊！因為你的鼓勵是我寫作的最大動力！

相關文章

步驟1：將生成的程式碼檔案放入到專案中

步驟2：在 `Gradle` 新增 `Protocol Buffer` 版本依賴

3.1.1 訊息物件類（`Message`類）

3.1.2 `Builder`類