在 Golang 中使用 Protobuf

安裝 goprotobuf

 

1.從 https://github.com/google/protobuf/releases 獲取 Protobuf 編譯器 protoc（可下載到 Windows 下的二進制版本

wget https://github.com/google/protobuf/releases/download/v2.6.1/protobuf-2.6.1.tar.gztar zxvf protobuf-2.6.1.tar.gz
cd protobuf-2.6.1./configure
make
make install
protoc   -h

 

 

2.獲取 goprotobuf 提供的 Protobuf 編譯器插件 protoc-gen-go（被放置於 $GOPATH/bin 下，$GOPATH/bin 應該被加入 PATH 環境變量，以便 protoc 可以找到 protoc-gen-go）

此插件被 protoc 使用，用於編譯 .proto 文件爲 Golang 源文件，經過此源文件能夠使用定義在 .proto 文件中的消息。

go get github.com/golang/protobuf/protoc-gen-go

cd github.com/golang/protobuf/protoc-gen-go

go build

go install

vi /etc/profile 將$GOPATH/bin 加入環境變量

source profile

 

3.獲取 goprotobuf 提供的支持庫，包含諸如編碼（marshaling）、解碼（unmarshaling）等功能

go get github.com/golang/protobuf/proto
cd github.com/golang/protobuf/proto
go build
go install

 

使用 goprotobuf
這裏經過一個例子來講明用法。先建立一個 .proto 文件 test.proto：

package example;enum FOO { X = 17; };

message Test {
required string label = 1;
optional int32 type = 2 [default=77];
repeated int64 reps = 3;
optional group OptionalGroup = 4 {
required string RequiredField = 5;
}
}

 

編譯此 .proto 文件：

protoc --go_out=. *.proto

 

 

這裏經過 –go_out 來使用 goprotobuf 提供的 Protobuf 編譯器插件 protoc-gen-go。這時候咱們會生成一個名爲 test.pb.go 的源文件。

在使用以前，咱們先了解一下每一個 Protobuf 消息在 Golang 中有哪一些可用的接口：

1. 每個 Protobuf 消息對應一個 Golang 結構體

2. 消息中域名字爲 camel_case 在對應的 Golang 結構體中爲 CamelCase

3. 消息對應的 Golang 結構體中不存在 setter 方法，只須要直接對結構體賦值便可，賦值時可能使用到一些輔助函數，例如：

   msg.Foo = proto.String("hello")

4. 消息對應的 Golang 結構體中存在 getter 方法，用於返回域的值，若是域未設置值，則返回一個默認值

5. 消息中非 repeated 的域都被實現爲一個指針，指針爲 nil 時表示域未設置

6. 消息中 repeated 的域被實現爲 slice

7. 訪問枚舉值時，使用「枚舉類型名_枚舉名」的格式（更多內容能夠直接閱讀生成的源碼）

8. 使用 proto.Marshal 函數進行編碼，使用 proto.Unmarshal 函數進行解碼

如今咱們編寫一個小程序：

package main

import (    "log"
    // 輔助庫
    "github.com/golang/protobuf/proto"
    // test.pb.go 的路徑
    "example")

func main() {    // 建立一個消息 Test
    test := &example.Test{        // 使用輔助函數設置域的值
        Label: proto.String("hello"),
        Type:  proto.Int32(17),
        Optionalgroup: &example.Test_OptionalGroup{
            RequiredField: proto.String("good bye"),
        },
    }    // 進行編碼
    data, err := proto.Marshal(test)    if err != nil {
        log.Fatal("marshaling error: ", err)
    }    // 進行解碼
    newTest := &example.Test{}
    err = proto.Unmarshal(data, newTest)    if err != nil {
        log.Fatal("unmarshaling error: ", err)
    }    // 測試結果
    if test.GetLabel() != newTest.GetLabel() {
        log.Fatalf("data mismatch %q != %q", test.GetLabel(), newTest.GetLabel())
    }
}