protobuf初識

protobuf初識

protobuf是一種高效的數據格式，平臺無關、語言無關、可擴展，可用於 RPC 系統和持續數據存儲系統。

protobuf

protobuf介紹

Protobuf是Protocol Buffer的簡稱，它是Google公司於2008年開源的一種高效的平臺無關、語言無關、可擴展的數據格式，目前Protobuf做爲接口規範的描述語言，能夠做爲Go語言RPC接口的基礎工具。

protobuf使用

protobuf是一個與語言無關的一個數據協議，因此咱們須要先編寫IDL文件而後藉助專用工具生成指定語言的代碼，從而實現數據的序列化與反序列化過程。

大體開發流程以下： 1. IDL編寫 2. 生成指定語言的代碼 3. 序列化和反序列化

protobuf語法

protobuf3語法指南

編譯器安裝

ptotoc

protobuf協議編譯器是用c++編寫的，根據本身的操做系統下載對應版本的protoc編譯器：https://github.com/protocolbuffers/protobuf/releases，解壓後拷貝到`GOPATH/bin`目錄下。

protoc-gen-go

安裝生成Go語言代碼的工具

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

編寫IDL代碼

在protobuf_demo/address目錄下新建一個名爲person.proto的文件具體內容以下：

// 指定使用protobuf版本
// 此處使用v3版本
syntax = "proto3";

// 包名，經過protoc生成go文件
package address;

// 性別類型
// 枚舉類型第一個字段必須爲0
enum GenderType {
    SECRET = 0;
    FEMALE = 1;
    MALE = 2;
}

// 人
message Person {
    int64 id = 1;
    string name = 2;
    GenderType gender = 3;
    string number = 4;
}

// 聯繫簿
message ContactBook {
    repeated Person persons = 1;
}

生成go語言代碼

在protobuf_demo/address目錄下執行如下命令。

address $ protoc --go_out=. ./person.proto

此時在當前目錄下會生成一個person.pb.go文件，咱們的Go語言代碼裏就是使用這個文件。 在protobuf_demo/main.go文件中：

package main

import (
    "fmt"
    "io/ioutil"

    "github.com/golang/protobuf/proto"

    "github.com/Q1mi/studygo/code_demo/protobuf_demo/address"
)

// protobuf demo

func main() {
    var cb address.ContactBook

    p1 := address.Person{
        Name:   "小王子",
        Gender: address.GenderType_MALE,
        Number: "7878778",
    }
    fmt.Println(p1)
    cb.Persons = append(cb.Persons, &p1)
    // 序列化
    data, err := proto.Marshal(&p1)
    if err != nil {
        fmt.Printf("marshal failed,err:%v\n", err)
        return
    }
    ioutil.WriteFile("./proto.dat", data, 0644)

    data2, err := ioutil.ReadFile("./proto.dat")
    if err != nil {
        fmt.Printf("read file failed, err:%v\n", err)
        return
    }
    var p2 address.Person
    proto.Unmarshal(data2, &p2)
    fmt.Println(p2)
}