GO语言使用protobuf

古城微笑少年丶 2022-08-31 11:24 189阅读 0赞

protobuf的安装可参考[《protobuf安装》][protobuf]，下面只讲具体的使用

在这里我们以[官方demo][demo]为例,定义消息的.proto文件是`addressbook.proto`

.proto文件以包声明开头，这有助于防止不同项目之间的命名冲突。

syntax = "proto3";
    package tutorial;
    
    import "google/protobuf/timestamp.proto";

接下来，是消息定义。消息只是包含一组类型字段的聚合。许多标准的简单数据类型都可用作字段类型，包括bool，int32，float，double和string。还可以使用其他消息类型作为字段类型，为消息添加更多结构。

message Person { 
      string name = 1;
      int32 id = 2;  // Unique ID number for this person.
      string email = 3;
    
      enum PhoneType { 
        MOBILE = 0;
        HOME = 1;
        WORK = 2;
      }
    
      message PhoneNumber { 
        string number = 1;
        PhoneType type = 2;
      }
    
      repeated PhoneNumber phones = 4;
    
      google.protobuf.Timestamp last_updated = 5;
    }
    
    // Our address book file is just one of these.
    message AddressBook { 
      repeated Person people = 1;
    }

然后，运行如下命令：

protoc -I=. --go_out=paths=source_relative addressbook.proto

*  \-I指定当前输入目录
 *  –go\_out指定输入目录
 *  最后指定.proto文件

会生成一个`addressbook.pd.go`文件

如果我们想实例化一个`Persion`对象，使用如下写法：

p := pb.Person{ 
    	Id: 1,
    	Name:  "Lyn",
    	Email: "lyn@csdn.com",
    	Phones: []*pb.Person_PhoneNumber{ 
    	        { Number: "1234", Type: pb.Person_HOME},
    	},
    }

在Go中序列化protocol buffer数据

book := &pb.AddressBook{ }
    b, err := proto.Marshal(book)
    if err != nil { 
            log.Fatalln("Failed to encode address book:", err)
    }

在Go中解析protocol buffer

book := &pb.AddressBook{ }
    if err := proto.Unmarshal(b, book); err != nil { 
            log.Fatalln("Failed to parse address book:", err)
    }

或者我们也可以选择直接转成json

book := &pb.AddressBook{ }
    b, err := json.Marshal(book)
    if err != nil { 
            log.Fatalln("Failed to encode address book:", err)
    }

[protobuf]: https://jiandansuifeng.blog.csdn.net/article/details/119078629
[demo]: https://github.com/protocolbuffers/protobuf/blob/master/examples/addressbook.proto