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

protobuf

protobuf介绍

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

protobuf使用

protobuf是一个与语言无关的一个数据协议，所以我们需要先编写IDL文件然后借助专用工具生成指定语言的代码，从而实现数据的序列化与反序列化过程。
大致开发流程如下： 1. IDL编写 2. 生成指定语言的代码 3. 序列化和反序列化

编译器安装

1. ptotoc

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

2. protoc-gen-go

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

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

protobuf语法

protobuf3语法指南

  1. message xxx {
  2.   // 字段规则：required -> 字段只能也必须出现 1 次
  3.   // 字段规则：optional -> 字段可出现 0 次或1次
  4.   // 字段规则：repeated -> 字段可出现任意多次（包括 0）
  5.   // 类型：int32、int64、sint32、sint64、string、32-bit ....
  6.   // 字段编号：0 ~ 536870911（除去 19000 到 19999 之间的数字）
  7.   字段规则 类型 名称 = 字段编号;
  8. }

list 类型

repeated是protobuf中的一种限定修饰符，从字面意思看有“重复”的意思，实际上它就是用来指定某一个字段可以存放同一个类型的多个数据（当然也可以是0个或者1个），相当于C++中的vector或者Java中的List。repeated类型数据在protobuf中的定义非常简单：

  1. syntax = "proto3";
  2. option java_outer_classname = "AddressBookProtos";
  5. message Person {
  6.   string name = 1;
  7.   int32 id = 2; 
  8.   string email = 3;
  10.   enum PhoneType {
  11.     MOBILE = 0;
  12.     HOME = 1;
  13.     WORK = 2;
  14.   }
  16.   message PhoneNumber {
  17.     string number = 1;
  18.     PhoneType type = 2;
  19.   }
  21.   repeated PhoneNumber phones = 4;
  23. }
  25. message AddressBook {
  26.   repeated Person people = 1;
  27. }

自定义类型/ 枚举类型

  1. public class Person{
  2.     string name ;
  3.     int32 id;  // Unique ID number for this person.
  4.     string email;
  5.     List<PhoneNumber> phones;
  6. }
  7. public class PhoneNumber{
  8.     string number;
  9.     PhoneType type;
  10. }
  12. enum PhoneType {
  13.     MOBILE = 0;
  14.     HOME = 1;
  15.     WORK = 2;
  16. }
  17. public class AddressBook {
  18.   List<Person> persons;
  19. }

IDL 代码示例

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

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

生成go语言代码

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

  1. 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. }