mac 下配置 protobuf golang外掛程式 並使用

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

[TOC]

介紹

Google Protocol Buffer( 簡稱 Protobuf) 是 Google 公司內部的混合語言資料標準
Protocol Buffers 是一種輕便高效的結構化資料存放區格式

• 可以用於結構化資料序列化，或者說序列化。
• 它很適合做資料存放區或 RPC 資料交換格式。
• 可用於通訊協議、資料存放區等領域的語言無關、平台無關、可擴充的序列化結構資料格式。

支援語言很多，C++ java python php golang 等，支援列表

Language	Source
C++ (include C++ runtime and protoc)	src
Java	java
Python	python
Objective-C	objectivec
C#	csharp
JavaNano	javanano
JavaScript	js
Ruby	ruby
Go	golang/protobuf
PHP	allegro/php-protobuf

protobuf 3.0 與 之前的 protobuf 2.6 的文法是不一樣的

安裝 ProtoBuf

安裝 2.6

# 查看protobuf資訊brew info protobuf# 安裝brew install protobuf# 檢查安裝結果protoc --versionlibprotoc 2.6.1

Linux 請查詢 apt-get or yum

Windows protbuf 2.6.1

安裝 3.0 版本

因為3.0在開發中，不能直接使用brew安裝穩定版

• 可以選擇讓brew安裝開發版
• 可以選擇編譯安裝開發版本，編譯過程需要自備梯子

-Windows protobuf 3.0.2

brew tap 安裝

http://brewformulas.org/Protobuf

➜  ~ brew tap homebrew/versions➜  ~ brew info protobufprotobuf: stable 3.0.2 (bottled), HEADProtocol buffers (Google's data interchange format)https://github.com/google/protobuf//usr/local/Cellar/protobuf/2.6.1 (121 files, 6.9M) *  Poured from bottle on 2016-09-07 at 12:08:43From: https://github.com/Homebrew/homebrew-core/blob/master/Formula/protobuf.rb==> DependenciesBuild: autoconf , automake , libtool ==> Options--c++11           Build using C++11 mode--universal           Build a universal binary--with-test           Run build-time check--without-python           Build without python support--HEAD           Install HEAD version==> CaveatsEditor support and examples have been installed to:  /usr/local/Cellar/protobuf/3.0.2/share/doc/protobuf➜  ~brew install protobuf

編譯安裝

因為3.0在開發中，不能直接使用brew安裝，需要編譯，編譯過程需要自備梯子

下載源碼 https://github.com/google/protobuf

protobuf release tag 3.0.0

編譯過程需要 gtest

brew info automakebrew info libtool# 沒有這兩個就安裝./autogen.sh# 檢查沒問題了./configuremake -j4make checkmake install

檢查安裝結果

protoc  --version

安裝golang for protobuf外掛程式

需要

• proto
• protoc-gen-go

go get -u -v github.com/golang/protobuf/protogo get -u -v github.com/golang/protobuf/protoc-gen-go

請將你的$GOPATH/bin 設定為環境變數，這樣才可以使用protoc-gen-go

使用protobuf

說明：本用例是在protobuf version 2.6.1中執行

編寫 proto 檔案

使用文字編輯器編輯檔案 Im.helloworld.proto，內容為

請認真對待 proto 檔案的檔案名稱，常用規則packageName.MessageName.proto

package Im; enum FOO { X = 17; }; message helloworld {    required int32     id = 1;  // Id    required string    str = 2;  // Str    optional int32     opt = 3;  // Opt optional field }

解釋這個文本

• package 名字叫做 Im
• 定義了一個訊息 helloworld
• 該訊息有三個成員，類型為 int32 的 id，另一個為類型為 string 的成員 str。opt 是一個可選的成員，即訊息中可以不包含該成員

編譯 .proto 檔案

protoc --go_out=. Im.helloworld.proto# 編譯目前的目錄下所有的proto檔案protoc --go_out=. *.proto

出現錯誤提示，請檢查上面的安裝過程

產生的檔案為 Im.helloworld.pb.go

內容主體有

const ( FOO_X FOO = 17)type Helloworld struct { Id               *int32  `protobuf:"varint,1,req,name=id" json:"id,omitempty"` Str              *string `protobuf:"bytes,2,req,name=str" json:"str,omitempty"` Opt              *int32  `protobuf:"varint,3,opt,name=opt" json:"opt,omitempty"` XXX_unrecognized []byte  `json:"-"`}

測試這個產生代碼

編寫測試代碼

package mainimport (    "github.com/golang/protobuf/proto"    "example"    "fmt")func main() {    // 建立一個訊息 Info    info := &example.Helloworld{        Id: proto.String("hello"),        Str: proto.Int32(17),    }    // 進行編碼    data, err := proto.Marshal(info)    if err != nil {        fmt.Printf("marshaling error: ", err)    }    // 進行解碼    newInfo := &example.Helloworld{}    err = proto.Unmarshal(data, newInfo)    if err != nil {        fmt.Printf("unmarshaling error: ", err)    }    if info.GetId() != newInfo.GetId() {        fmt.Printf("data mismatch %q != %q", info.GetId(), newInfo.GetId())    }}

測試回合一下，如果出現問題或者代碼有誤，請自行解決一下~~

Nothing is a line of code can not be resolved, if have just use two lines on !