前言
- 習慣用
Json、XML資料儲存格式的你們，相信大多都沒聽過Protocol Buffer Protocol Buffer其實 是Google出品的一種輕量 & 高效的結構化資料儲存格式，效能比Json、XML真的強！太！多！
由於
Protocol Buffer已經具備足夠的吸引力
- 今天，我將詳細介紹
Protocol Buffer在Android平臺 的具體使用
目錄
1. 定義
一種 結構化資料 的資料儲存格式（類似於 XML、Json ）
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的系列文章請看：
- 快來看看Google出品的Protocol Buffer，別隻會用Json和XML了
- 手把手教你如何安裝Protocol Buffer
- 這是一份很有誠意的 Protocol Buffer 語法詳解
- Protocol Buffer 序列化原理大揭祕 – 為什麼Protocol Buffer效能這麼好？
- Android：手把手帶你分析 Protocol Buffer使用 原始碼
- 下一篇文章我將對
Protocol Buffer的原始碼進行詳細分析，有興趣可以繼續關注Carson_Ho的安卓開發筆記