Golang Protocol Buffer案例詳解

Posted on by

Golang Protocol Buffer教程

本文介紹如何在Go應用中利用Protocol Buffer數據格式。主要包括什麼是Protocol Buffer數據格式，其超越傳統數據格式XML或JSON的優勢是什麼。

1. Protocol Buffer數據格式

Protocol Buffer，本質就是一種數據格式，和JSON或XML一樣，不同的語言用於結構化數據序列化或反序列化。該數據格式的優勢是較xml或json更小，源於Google。假如我們有一個對象，我們用三種數據結構進行表示：

<person>
  <name>Elliot</name>
  <age>24</age>
</person>

使用json表示占用空間更小：

{
  "name": "Elliot",
  "age": 24
}

如果使用protocol buffer格式表示：

[10 6 69 108 108 105 111 116 16 24]

如果您仔細觀察上面編碼可能會看到，從數組位置2開始名字elliot被拼出來，e = 69, l = 108等等。後面是年齡的字節表示，24歲。

不過編碼格式內容比我們看到的要多，下面會更詳細地解釋,如果您願意可看其官方文檔。

現在這個示例數據，Json和 Protocol Buffer格式幾乎沒有太大差別，但當遇到數據量很大場景時，差別就體現出來瞭。

2. 簡單示例

首先下載必要的依賴：

go get github.com/golang/protobuf
go get github.com/golang/protobuf/proto

下載完成後，確保能夠在命令行中可以運行 protoc 命令。下面我們定義 protobuf 結構，這裡定義上面用來對比不同數據格式之間差異的person 對象。

首先指定我們使用的語法格式，這裡使用 proto3，然後指定存放的包名。最後定義對象，Peson類型的消息及其包括的字段 name 和 age。

person.proto結構定義如下：

syntax="proto3";

package main;

message Person {
      string name = 1;
      int32 age = 2;
}

然後在該文件的路徑下運行下面命令：

protoc --go_out=. *.proto

即在當前目錄下 生成所有擴展名為 proto文件的 .pb.go 文件。
現在我們定義Person類型對象使用 protobuf格式進行序列化。代碼如下；

import (
    "fmt"
    "log"

    "github.com/golang/protobuf/proto"
)

func main() {
  elliot := &Person{
    Name: "Elliot",
    Age:  24,
  }

  data, err := proto.Marshal(elliot)
  if err != nil {
    log.Fatal("marshaling error: ", err)
  }

  // 打印原始的protobuf序列化對象
  fmt.Println(data)


  // 反序列化進行驗證
  newElliot := &Person{}
  err = proto.Unmarshal(data, newElliot)
  if err != nil {
    log.Fatal("unmarshaling error: ", err)
  }

  // 打印 `newElliot` 對象進行驗證
  fmt.Println(newElliot.GetAge())
  fmt.Println(newElliot.GetName())

}

使用go run 命令運行，需要在main.go 後面傳入 person.pb.go，命令如下：

go run main.go test.pb.go

在ide環境中可以直接運行。輸出結果如下：

[10 6 69 108 108 105 111 116 16 24]
name:"Elliot" age:24

3. 嵌套示例

我們已經完成瞭一個非常簡單的示例，但現實中消息格式通常會遇到多個嵌套字段，下面增加嵌套類型字段。

我們仍然使用前面 Person 類型，僅增加社交網絡的粉絲字段。SocialFollowers的消息類型如下：

syntax="proto3";

package main;

message SocialFollowers {
  int32 youtube = 1;
  int32 twitter = 2;
}

message Person {
  string name = 1;
  int32 age = 2;
  SocialFollowers socialFollowers = 3;
}

因為Person 類型已經被修改瞭，需要重新運行 protoc 命令：

protoc --go_out=. *.proto

現在同時修改代碼進行測試，填充 elliot 對象使用 SocialFollowers 類型對象：

package main

import (
    "fmt"
    "log"

    "github.com/golang/protobuf/proto"
)

func main() {

  elliot := Person{
    Name: "Elliot",
    Age:  24,
    SocialFollowers: &SocialFollowers{
        Youtube: 2500,
        Twitter: 1400,
    },
  }

  // 序列化對象
  data, err := proto.Marshal(&elliot)
  if err != nil {
    log.Fatal("marshaling error: ", err)
  }

  // 反序列化對象進行驗證
  newElliot := &Person{}
  err = proto.Unmarshal(data, newElliot)
  if err != nil {
    log.Fatal("unmarshaling error: ", err)
  }

  // 輸出 `newElliot` 對象屬性進行驗證
  fmt.Println(newElliot.GetName())
  fmt.Println(newElliot.GetAge())
  fmt.Println(newElliot.SocialFollowers.GetTwitter())
  fmt.Println(newElliot.SocialFollowers.GetYoutube())
}

運行程序輸出結果：

Elliot
24
1400
2500

4. 總結

本文我們學習瞭Go應用中如何使用 protocol buffer 數據格式。

到此這篇關於Golang Protocol Buffer案例詳解的文章就介紹到這瞭,更多相關Golang Protocol Buffer內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：