白羊的空间

Go语言使用protobuf

以前使用c#,使用protobuf-net习惯了.net的方式,现在学习用go操作protobuf,从基础的来

本文github: https://github.com/zboyco/go-test/tree/master/protobuf

###1. 准备工作
1.1 下载protobuf的编译器protoc
下载地址 https://github.com/google/protobuf/releases
下载后把bin路径加入PATH环境变量

1.2 获取并安装proto-gen-go

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

1.3 获取 goprotobuf 提供的支持库

1
go get github.com/golang/protobuf/proto

###2. 使用Protobuf

创建一个test.proto文件
内容如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//指定版本
syntax = "proto3";

//包名
package models;

// 用户
message User
{
    int32 id = 1; // ID
    string name = 2; // 名称
    string pwd = 3; // 密码
    repeated string phones = 4; //电话
}

// 组
message UserGroup
{
    int32 id = 1; // 组ID
    string name = 2; // 组名
    repeated User users = 3; // 用户列表
}

保存文件后,运行

1
protoc test.proto --go_out=.

生成test.pb.go文件
github: https://github.com/zboyco/go-test/blob/master/protobuf/models/test.pb.go

  • 这个文件是protoc生成的,不要人为修改

###3. 测试
主要用到github.com/golang/protobuf/proto包里的两个方法:

  • Marshal 编码
  • Unmarshal 解码

直接贴代码了

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package main

import (
	"go-test/protobuf/models"
	"log"

	"github.com/golang/protobuf/proto"
)

func main() {
	log.Println("测试protobuf")
	// 创建对象
	group := models.UserGroup{
		Id:   1,
		Name: "测试组",
	}

	for i := 0; i < 3; i++ {

		m := models.User{
			Id:   int32(i),
			Name: "Test",
			Pwd:  "Test",
		}
		m.Phones = append(m.Phones, "1")
		m.Phones = append(m.Phones, "2")
		m.Phones = append(m.Phones, "3")
		group.Users = append(group.Users, &m)
	}

	// 编码
	mData, err := proto.Marshal(&group)
	if err != nil {
		log.Fatalln(err)
	}

	// 解码
	var obj models.UserGroup
	err = proto.Unmarshal(mData, &obj)
	if err != nil {
		log.Fatalln(err)
	}
	log.Println(mData)

	// 输出
	log.Println(obj.Id, obj.Name)
	for _, v := range obj.Users {
		log.Println("UserID:", v.Id)
		log.Println("UserName:", v.Name)
		for _, p := range v.Phones {
			log.Println("Phone:", p)
		}
	}
}

###4. 结果

Golang protobuf