ProtoBuf 3

• ProtoBuf
  如今Google官方的ProtoBuf已經出了ProtoBuf的C-sharp版本,使用proto3語言標準,使用庫檔案需要.Net4.x,需要在Unity的PlayerSettings中將.Net舊版本切換至4.x

• Protobuf與BinaryFormatter比較
  可以參閱這篇

• 目的
  提升序列化反序列化速度,減小二進位制檔案大小提高傳輸效率,協議檔案更具有可讀性。

• 定義協議格式
  首先是包體說明，防止在不同專案中命名衝突

  syntax = “proto3”;
  package tutorial;

  如果沒有用以下官方例子中的方式將csharp_namespace指定一個名稱空間的話,將會預設使用package來進行匹配。

  option csharp_namespace = “Google.Protobuf.Examples.AddressBook”;

  接著是定義message,可以使用一些基本型別作為欄位型別,甚至還能在其它的message中使用已經定義的message型別作為欄位型別。

  message Person {
  string name = 1;
  int32 id = 2; // Unique ID number for this person.
  string email = 3;
  enum PhoneType {
  MOBILE = 0;
  HOME = 1;
  WORK = 2;
  }
  message PhoneNumber {
  string number = 1;
  PhoneType type = 2;
  }
  repeated PhoneNumber phones = 4;
  }
  // Our address book file is just one of these.
  message AddressBook {
  repeated Person people = 1;
  }

  如果一個欄位值沒有被初始化,則會使用預設值。

  • strings預設值是空字元.
  • bytes預設是空.
  • bool預設為false.
  • 數字型別預設值為0.
  • 列舉型別預設是第一個定義的列舉值也就是0.
  • 對於message型別的子彈它沒有設定值,實際型別是根據語言環境來的.

  一個使用了repeated來修飾的欄位,可以看做是個動態陣列。

• 複用
  可以使用import來匯入其它的.proto檔案實現複用

• 編譯protobuf

  1. 安裝編譯器
     建議使用PM包管理工具,只需要執行Install-Package Google.Protobuf.Tools就能在專案下的packages目錄下得到一個工具包

  2. 執行編譯命令
     在編譯器所在目錄下執行命令
     protoc -I=$SRC_DIR --csharp_out=$DST_DIR $SRC_DIR/addressbook.proto
     其中$SRC_DIR指的是.proto檔案所在目錄$DST_DIR是目標目錄
     編譯時需要一個Google.Protobufd的庫,也可以通過PM工具下載:Install-Package Google.Protobuf

  3. 按例子編譯完你就得到了5個可用的型別

     • 一個包含元資料的靜態Addressbook類(名稱空間定義的)
     • 一個帶有一個只讀People型別欄位的AddressBook型別.
     • 一個包含屬性Name、Id、Email 的Person類
     • 一個內嵌於Person.Types這個靜態類中的PhoneNumber類
     • 一個同樣內嵌於Person.Types的列舉型別PhoneType

     在使用這個編譯得到的.cs檔案之前需要引入名稱空間：Google.Protobuf.Examples.AddressBook,也就是我們之前自己定義的。
     現在可以直接使用類Person和AddressBook。另外使用嵌入Person中的類PhoneNumber時需要通過Person.Types.PhoneNumber才能得到。
     Person下的列舉PhoneType使用Person.Types.PhoneType得到。
     還有一個只能新增PhoneNumber型別的陣列呼叫Person的例項_person.Phones得到。

     在C#中使用proto中定義的型別例項時需要對成員進行初始化賦值,否則都是預設值。
     另外一般都會把得到的.cs檔案打包成庫.dll檔案

• 序列化與解析
  一個proto對映生成的cs型別例項擁有一個WriteTo方法可以將型別資訊寫入流中.同時可以通過對應的型別的靜態方法Parser來解析一個寫有該型別資訊的流。
  過程如下：
  先把一個例項寫入一個二進位制檔案中。

  Person person = new Person() { Name = “me”, Id = 0, Email = “8888” };
  FileStream fs= File.Create(“./person.dat”);
  person.WriteTo(fs); //注意這一步必須要有引入Google.Protobuf這個庫,可通過前面編譯時說的方式下載。
  fs.Close();

  這時會在你的專案根目錄下得到一個person.dat檔案。

  解析二進位制檔案得到一個Person例項。

  FileStream fs= File.Open(“./person.dat”, FileMode.Open);
  Person person= Person.Parser.ParseFrom(fs);
  fs.Close();
  Debug.Log(string.Format(“Name:{0} ID:{1} Email:{2}”, person.Name, person.Id, person.Email) );

  列印資訊//Name:me ID:0 Email:8888

• 型別對比proto3

  .proto type

  double

  float

  int32

  int64

  uint32

  uint64

  sint32

  sint64

  fixed32

  fixed64

  sfixed32

  sfixed64

  bool

  string

  bytes

• 開發流程

  1. 書寫協議定義檔案
  2. 將定義協議生成C#程式碼
  3. 將C#程式碼編譯成dll
  4. 將dll匯入到Unity工程的Plugins目錄
  5. 在遊戲裡呼叫dll

更多官方資料