Protobuf协议

作者: 闫正阳 | 来源:发表于2017-09-18 01:27 被阅读29次

    数据交互协议

    在网络通信中,我们经常需要通过一种约定俗称的方式来进行数据交互。在这中间,有很多如xml,json等等很常见的数据格式。

    xml

    xml是一种标签语言,通过<tag>content</tag>来描述数据内容,出现时间最早,应用最广泛,但是传输效率低。

    json

    json作为一种轻量级的数据交换格式,其无效的字符数远远低于xml,且原生被js支持,故经常出现在前端请求中以及app与服务器的数据交互。

    protobuf

    protobuf是google的一种数据交换格式,相比于其他的几种交互方式,其优势在于数据的重编码,在传输时会将其编译为二进制数据流,而当需要使用时再进行反序列化。
    protobuf支持几乎绝大多数的语言。

    PB用法

    声明数据格式

    通过proto文件,我们可以了解到一个数据的详细类型。

    message Person {
        required string name = 1;
        required int32 id = 2;
        optional string email = 3;
    
        enum PhoneType {
            MOBILE = 0;
            HOME = 1;
            WORK = 2;
        }
    
        message PhoneNumber {
            required string number = 1;
            optional PhoneType type = 2 [default = HOME];
        }
    
        repeated PhoneNumber phone = 4;
    }
    

    在官方示例中可以看到一个数据类型的声明方法:message 对象 {}。在{}中则是添加相应的字段描述,每个字段描述如下

        required|optional|repeated type name = code [default = *]
    
    • required 必须字段 在序列化之前必须设置该值 在反序列化时该字段必须有值
    • optional 可选字段
    • repeated 重复字段 意思是这个字段为一个list(0...n)

    数据类型为protobuf声明的数据类型,每个类型在不同的语言上均有特定的映射。
    或可以是一个声明的自定义数据类型。

    声明完成后通过protoc编译为特定语言的头文件。

    使用proto

    引入头文件后 首先声明一个对象

        import addressbook_pb2
        person = addressbook_pb2.Person()
    

    通过person.xxx可以直接对某个字段进行赋值

        person.id = 1234
        person.name = "John Doe"
        person.email = "jdoe@example.com"
    
        phone = person.phones.add()
        phone.number = "555-4321"
        phone.type = addressbook_pb2.Person.HOME
    

    序列化

        pb_bin = person.SerailzeToString()
    

    在序列化过程中有可能因为required未被赋值而导致序列化失败
    序列化成功后便可以将二进制数据发送出去

    反序列化

    收到对应的数据后,我们需要从二进制数据中获取对应的对象
    person = addressbook_pb2.Person()
    person.ParseFromString(pb_bin)

    相关文章

      网友评论

        本文标题:Protobuf协议

        本文链接:https://www.haomeiwen.com/subject/ixrvsxtx.html