高性能消息传输协议Protobuf

• 数据结构序列化与反序列化的一种机制，类似JSON，但数据更小、传输更快

类型的导入与消息格式的定义

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69

// 指定解析语法，默认不指定是proto2
syntax = "proto3";
// 指定包名，防止多个项目之间命名冲突
// 作用类似于命名空间
package user;
// 指定生成代码的import路径,protobuf是项目路径
option go_package = "protobuf/user-proto";
// 导入第三方proto
import "google/protobuf/timestamp.proto";
import "google/protobuf/any.proto";
/*
性别
*/
enum Gender {
    // 枚举类型必须从0开始，后面不是标识号，是值
    FEMALE = 0;
    MALE = 1;
    THIRD = 2;
    UNKNOWN=3;
}

/*
地址信息
*/
message Address {
    string provice = 1;
    string city = 2;
}

/*
用户信息
*/
message User{
    // 类型 字段名 消息标识
    // 每个message内消息标识可以从1开始随意指定，但是要是唯一的，1-15标识站1位，>15站2位，所以频繁的数据标识尽量小
    string name = 1;
    uint32 age = 2;
    // 枚举类型
    Gender gender = 4;
    // 外部import类型
    google.protobuf.Timestamp birthday = 5;
    // 自定义结构
    Address addr = 9;
    // 数组
    repeated string hobys = 10;
    // 集合与any类型
    map<string, google.protobuf.Any> data = 8; 
    // 保留字段标识，用于向前后版本兼容，也就是当服务升级的时候，之前需要删除的字段删除后要对其之前的标识进行保留
    reserved 6,7,16 to 25; // 保留6，7和16到25
    // 保留字段名称
    reserved "phone", "email";
    // []byte，optional表示可选的
    optional bytes byte_data = 11;
    // 内嵌类型
    message phone {
        string area_code = 1;
        string number = 2;
    }
    phone telephone = 12;
    // level字段的取值，取a，b中的一个
    oneof level {
        bool a = 13;
        bool b = 14;
    }
    oneof level2 {
        bool c = 15;
        bool d = 26;
    }
}

protoc编译器与API消息读写

• 生成代码,对齐一下依赖

  1 2	protoc -I . --go_out=. --go_opt=paths=source_relative ./user-proto/user.proto go mod tidy

• api使用

  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

  package main import ( "fmt" user_proto "protobuf/user-proto" "time" "google.golang.org/protobuf/proto" "google.golang.org/protobuf/types/known/anypb" "google.golang.org/protobuf/types/known/timestamppb" ) func main() { any1, _ := anypb.New(&user_proto.Address{ Provice: "hunan", City: "Changsha", }) user := &user_proto.User{ Name: "lin", Age: 10, Gender: user_proto.Gender_FEMALE, Birthday: timestamppb.New(time.Date(2004, time.December, 1, 1, 0, 0, 0, time.Local)), Addr: &user_proto.Address{ Provice: "Guangdong", City: "ShenZhen", }, Hobys: []string{"yumaoqiu", "lanqiu", "pingpangqiu"}, Data: map[string]*anypb.Any{ "a": any1, }, ByteData: []byte("Today is a good day!"), Telephone: &user_proto.UserPhone{ AreaCode: "+86", Number: "13683200000", }, Level: &user_proto.User_A{A: true}, Level2: &user_proto.User_D{D: false}, } fmt.Println(user) fmt.Println("-------------------------------------") bytes, err := proto.Marshal(user) fmt.Println(bytes, err) fmt.Println("-------------------------------------") user1 := &user_proto.User{} err = proto.Unmarshal(bytes, user1) fmt.Println(user1, err) }