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.gzcd protobuf-2.6.1./configuremakemake installprotoc   -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-gocd github.com/golang/protobuf/protoc-gen-gogo buildgo installvi /etc/profile 將$GOPATH/bin 加入環境變數source profile

 

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

go get github.com/golang/protobuf/protocd github.com/golang/protobuf/protogo buildgo 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 mainimport (    "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())    }}