protobuf初识

目录

• 1、protobuf
  • 1.1 protobuf介绍
  • 1.2 protobuf使用
  • 1.3 protobuf语法
  • 1.4 编译器安装
  • 1.5 ptotoc
  • 1.6 protoc-gen-go
  • 1.7 编写IDL代码
  • 生成go语言代码

更新、更全的《Go从入门到放弃》的更新网站，更有python、go、人工智能教学等着你：http://www.javashuo.com/article/p-mxrjjcnn-hn.html

protobuf是一种高效的数据格式，平台无关、语言无关、可扩展，可用于 RPC 系统和持续数据存储系统。

1、protobuf

1.1 protobuf介绍

Protobuf是Protocol Buffer的简称，它是Google公司于2008年开源的一种高效的平台无关、语言无关、可扩展的数据格式，目前Protobuf做为接口规范的描述语言，能够做为Go语言RPC接口的基础工具。

1.2 protobuf使用

protobuf是一个与语言无关的一个数据协议，因此咱们须要先编写IDL文件而后借助专用工具生成指定语言的代码，从而实现数据的序列化与反序列化过程。

大体开发流程以下： 1. IDL编写 2. 生成指定语言的代码 3. 序列化和反序列化

1.3 protobuf语法

protobuf3语法指南

1.4 编译器安装

1.5 ptotoc

protobuf协议编译器是用c++编写的，根据本身的操做系统下载对应版本的protoc编译器：https://github.com/protocolbuffers/protobuf/releases，解压后拷贝到GOPATH/bin目录下。

1.6 protoc-gen-go

安装生成Go语言代码的工具

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

1.7 编写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)
}
protobuf_demo/addressaddress $ protoc --go_out=. ./person.protoperson.pb.goprotobuf_demo/main.gopackage 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)
}