protobuf快速上手指南

🕓 · ☕2 min read

什么是protobuf

Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准。

Protocol Buffers 是一种轻便高效的结构化数据存储格式,可以用于结构化数据串行化,或者说序列化。它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。

如何安装protobuf

  • 在github获取protobuf源码,windows系统可以直接下载exe文件:https://github.com/google/protobuf/releases

  • macos和linux环境使用源码进行安装的步骤

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    
    # 获取源码包
    wget https://github.com/google/protobuf/archive/v3.5.0.tar.gz
    
    # 解压缩并进入源码目录
    tar -zxvf v3.5.0.tar.gz
    cd protobuf-3.5.0
    
    # 生成configure文件
    ./autogen.sh
    
    # 编译安装
    ./configure
    make
    make check
    make install

在执行./autogen.sh过程中可能会因缺乏automake依赖库而报错:autoreconf: failed to run aclocal: No such file or directory,要解决此错误,在linux系统可以通过sudo yum install automake或者sudo apt-get install automake安装automake,在macos系统可以通过brew install automake安装automake。

  • 检测protobuf是否已成功安装

命令行执行protoc --version。windows系统需要将protoc.exe文件所在的目录添加到环境变量。

如何使用protobuf

protobuf支持跨语言使用,很多主流的开发语言都有protobuf支持库,我们用golang来演示如何使用protobuf进行数据序列化。

  • 在golang中安装protobuf相关的库

    1
    
    go get -u github.com/golang/protobuf/{protoc-gen-go,proto}
  • 编写.proto文件

$GOPATH/src/test/protobuf/pb/user.proto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
syntax = "proto3";
package pb;

message user {
    int32 id = 1;
    string name = 2;
}

message multi_user {
    repeated user users = 1;
}
  • 基于.proto文件生成数据操作代码

    1
    
    protoc --go_out=. user.proto

执行命令完成,在与user.proto文件同级的目录下生成了一个user.pb.go文件

  • 数据序列化演示 $GOPATH/src/test/protobuf/main.go

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    
    package main
    
    import (
    "log"
    "test/protobuf/pb"
    
    "github.com/golang/protobuf/proto"
    )
    
    func main() {
    user1 := pb.User{
        Id:   *proto.Int32(1),
        Name: *proto.String("Mike"),
    }
    
    user2 := pb.User{
        Id:   2,
        Name: "John",
    }
    
    users := pb.MultiUser{
        Users: []*pb.User{&user1, &user2},
    }
    
    // 序列化数据
    data, err := proto.Marshal(&users)
    if err != nil {
        log.Fatalln("Marshal data error: ", err)
    }
    println(users.Users[0].GetName()) // output: Mike
    
    // 对已序列化的数据进行反序列化
    var target pb.MultiUser
    err = proto.Unmarshal(data, &target)
    if err != nil {
        log.Fatalln("Unmarshal data error: ", err)
    }
    println(target.GetUsers()[1].Name) // output: John
    
    }

相关扩展

sublime插件:Protobuf Syntax Hightlighting

参考资料