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

protobuf

protobuf介绍

ProtobufProtocol 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语言代码的工具

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

编写IDL代码

protobuf_demo/address目录下新建一个名为person.proto的文件具体内容如下:

  1. // 指定使用protobuf版本
  2. // 此处使用v3版本
  3. syntax = "proto3";
  4. // 包名,通过protoc生成go文件
  5. package address;
  6. // 性别类型
  7. // 枚举类型第一个字段必须为0
  8. enum GenderType {
  9. SECRET = 0;
  10. FEMALE = 1;
  11. MALE = 2;
  12. }
  13. // 人
  14. message Person {
  15. int64 id = 1;
  16. string name = 2;
  17. GenderType gender = 3;
  18. string number = 4;
  19. }
  20. // 联系簿
  21. message ContactBook {
  22. repeated Person persons = 1;
  23. }

生成go语言代码

protobuf_demo/address目录下执行以下命令。

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

此时在当前目录下会生成一个person.pb.go文件,我们的Go语言代码里就是使用这个文件。 在protobuf_demo/main.go文件中:

  1. package main
  2. import (
  3. "fmt"
  4. "io/ioutil"
  5. "github.com/golang/protobuf/proto"
  6. "github.com/Q1mi/studygo/code_demo/protobuf_demo/address"
  7. )
  8. // protobuf demo
  9. func main() {
  10. var cb address.ContactBook
  11. p1 := address.Person{
  12. Name: "小王子",
  13. Gender: address.GenderType_MALE,
  14. Number: "7878778",
  15. }
  16. fmt.Println(p1)
  17. cb.Persons = append(cb.Persons, &p1)
  18. // 序列化
  19. data, err := proto.Marshal(&p1)
  20. if err != nil {
  21. fmt.Printf("marshal failed,err:%v\n", err)
  22. return
  23. }
  24. ioutil.WriteFile("./proto.dat", data, 0644)
  25. data2, err := ioutil.ReadFile("./proto.dat")
  26. if err != nil {
  27. fmt.Printf("read file failed, err:%v\n", err)
  28. return
  29. }
  30. var p2 address.Person
  31. proto.Unmarshal(data2, &p2)
  32. fmt.Println(p2)
  33. }