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

時間  2019-11-09
標籤 android 序列 google 出品 神器 protocol buffer 不瞭解 一下 欄目 Android 简体版
原文   原文鏈接

前言

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

因爲 Google出品，我相信Protocol Buffer已經具有足夠的吸引力html

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

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

目錄

示意圖

1. 定義

一種 結構化數據 的數據存儲格式（相似於 XML、Json ）git

  1. Google 出品 （開源）
  2. Protocol Buffer 目前有兩個版本：proto2 和 proto3
  3. 由於proto3 仍是beta 版，因此本次講解是 proto2

2. 做用

經過將 結構化的數據 進行 串行化（序列化），從而實現 數據存儲 / RPC 數據交換的功能github

  1. 序列化： 將 數據結構或對象 轉換成 二進制串 的過程
  2. 反序列化：將在序列化過程當中所生成的二進制串 轉換成 數據結構或者對象 的過程

3. 特色

  • 對比於 常見的 XML、Json 數據存儲格式，Protocol Buffer有以下特色：

Protocol Buffer 特色

4. 應用場景

傳輸數據量大 & 網絡環境不穩定 的數據存儲、RPC 數據交換 的需求場景json

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

總結

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

5. 使用流程

  • 使用 Protocol Buffer 的流程以下：

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 ：github.com/Carson-Ho/P…

高級功能

  • 貼心的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的系列文章請看：
  1. 快來看看Google出品的Protocol Buffer，別隻會用Json和XML了
  2. 手把手教你如何安裝Protocol Buffer
  3. 這是一份頗有誠意的 Protocol Buffer 語法詳解
  4. Protocol Buffer 序列化原理大揭祕 - 爲何Protocol Buffer性能這麼好？
  5. Android：手把手帶你分析 Protocol Buffer使用 源碼

請點贊！由於你的鼓勵是我寫做的最大動力！

歡迎關注carson_ho的微信公衆號

示意圖

示意圖
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程