Protobuf概述

什么是Protobuf

Protobuf（Protocol Buffers）協(xié)議?? Protobuf 是一種由 Google 開發(fā)的二進制序列化格式和相關的技術，它用于高效地序列化和反序列化結構化數(shù)據(jù)，通常用于網(wǎng)絡通信、數(shù)據(jù)存儲等場景

為什么要使用Protobuf

其實 Protobuf 在許多領域都得到了廣泛應用，特別是在分布式系統(tǒng)、RPC（Remote Procedure Call）框架和數(shù)據(jù)存儲中，它提供了一種高效、簡潔和可擴展的方式來序列化和交換數(shù)據(jù)，Protobuf 的主要優(yōu)點包括：

• 高效性：Protobuf 序列化后的二進制數(shù)據(jù)通常比其他序列化格式（比如超級常用的JSON）更小，并且序列化和反序列化的速度更快，這對于性能敏感的應用非常有益。
• 簡潔性：Protobuf 使用一種定義消息格式的語法，它允許定義字段類型、順序和規(guī)則（消息結構更加清晰和簡潔）
• 版本兼容性：Protobuf 支持向前和向后兼容的版本控制，使得在消息格式發(fā)生變化時可以更容易地處理不同版本的通信。
• 語言無關性：Protobuf 定義的消息格式可以在多種編程語言中使用，這有助于跨語言的通信和數(shù)據(jù)交換（截至本文發(fā)布目前官方支持的有C++/C#/Dart/Go/Java/Kotlin/python）
• 自動生成代碼：Protobuf 通常與相應的工具一起使用，可以自動生成代碼，包括序列化/反序列化代碼和相關的類（減少了手動編寫代碼的工作量，提高效率，后面的??里有保姆級操作指南）

Protobuf實戰(zhàn)

環(huán)境配置

首先我們需要在 pom.xml 文件中添加如下依賴：

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>3.20.3</version>
</dependency>
<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java-util</artifactId>
    <version>3.20.3</version>
</dependency>

接著如果你希望.proto文件可以被idea識別的話，就需要安裝 Protobuf 插件（非必要）

創(chuàng)建文件

然后我們創(chuàng)建一個.proto文件，如下圖（完整代碼在文末附錄）

其中 syntax = "proto3" 表示協(xié)議版本，option java_package = "com.aqin.protobuf" 表示生成的類所處的層級，option java_multiple_files = true 表示需要將生成的類拆分為多個（false 的話就是不需要），MyRequest 和 Header 是消息結構。

進入到文件??AQin.proto所在目錄下，執(zhí)行如下代碼：

protoc -I=./ --java_out=./ ./AQin.proto

參數(shù)說明：

• -I 用于指定 .proto 文件所在的路徑（也可以用-proto_path代替）
• --java_out 用于指定生成的 java 文件的路徑
• ./AQin.proto 就是需要編譯的.proto文件

有一點需要注意的是這三個路徑要使用相對路徑就都使用相對路徑，要使用絕對路徑就都使用絕對路徑（不要混著用），執(zhí)行完成后，就會在指定的位置生成指定的文件，如下圖

然后我們就可以通過生成的Java類來對接收到的信息進行解析，或者封裝數(shù)據(jù)進對象進行發(fā)送

解析/封裝數(shù)據(jù)

常用API

• newBuilder()：用于創(chuàng)建Java類（通過.proto文件生成的）并返回該對象
  • setXXX()：設置屬性值
  • getXXX()：獲取屬性值
• byte[] toByteArray()：用于序列化信息并返回一個字節(jié)數(shù)組
• writeTo(OutputStream output): 序列化信息并寫入一個輸出流
• parseFrom(byte[] data)：解析傳入的字節(jié)數(shù)組（一般用于接收數(shù)據(jù)）
• parseFrom(InputStream input)：解析傳入的輸入流（一般用于接收數(shù)據(jù)）

那我們上面的AQin.proto舉個??

MyInfo myInfo = MyInfo.newBuilder().setName("Zhangsan");
Body body = Body.newBuilder().setMyInfo(myInfo).build();
ByteBuffer byteBuffer = ByteBuffer.allocate(body.toByteArray().length);
body.writeTo(CodedOutputStream.newInstance(byteBuffer));
//然后就可以發(fā)送了～～

附錄

AQin.proto 完整代碼

//協(xié)議版本
syntax = "proto3";
//生成的類所處的層級
option java_package = "com.aqin.protobuf";
//是否需要將生成的類拆分為多個
option java_multiple_files = true;
// request
message MyRequest{
  Header header = 1;
  Body body = 2;
}
//Header
message Header {
  uint32  RequestId = 1;
  int64   Timestamp = 2;
}
//Body
message Body {
  MyInfo Info = 1;  //消息
  ServiceResult serviceResult = 2;  //結果反饋
}
message MyInfo{
  string  name = 1;
  string  age = 2;
}
message ServiceResult{
  uint32 ErrorCode = 1;
  string ErrorMsg = 2;
}

到此這篇關于Protobuf詳解及入門指南的文章就介紹到這了,更多相關Protobuf入門內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論