Protobuf笔记以及Java Js 示例

柔情只为你懂 2022-06-05 08:17 179阅读 0赞

# Google Protocol Buffer #

## 1.协议介绍： ##

[Google Protocol Buffer][]是google 的一种数据交换的格式，它独立于语言，独立于平台。google 提供了多种语言的实现：java、c\#、c++、go、python、js等，每一种实现都包含了相应语言的编译器以及库文件。由于它是一种二进制的格式，比使用 xml 进行数据交换快许多。可以把它用于分布式应用之间的数据通信或者异构环境下的数据交换。作为一种效率和兼容性都很优秀的二进制数据传输格式，可以用于诸如网络传输、配置文件、数据存储等诸多领域。

## 2.使用说明: ##

### 2.1proto文件说明: ###

###### 不管是同种语言还是不同语言，在使用Protobuf进行数据交互的时候需要统一的一个数据结构。这个数据结构使用.proto后缀，并使用proto的特殊语法进行定义。此文件格式如下: ######

syntax="proto2" //语法格式
        package tutorial; //包
        //option:可赋值非必须赋值 java_package:java包名
        option java_package = "com.example.tutorial";
        //java类名，生成com.example.tutorial.AddressBookProtos java类
        option java_outer_classname = "ProtoEntity";
        option csharp_namespace = "Google.ProtocolBuffers.Examples.AddressBook";
        //message定义所需要序列化的数据的格式。每一个Message都是一个小的信息逻辑单元，
        //包含了一些列的name-value对。
        message Person {
          required string name = 1; //required必须赋值，是永久性的
          required int32 id = 2;        // Unique ID number for this person.
          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类似数组或集合（java里是list）
          repeated PhoneNumber phone = 4;
        }
        //用户信息
        message UserInfo {
            optional string userId=1;//用户id
            optional string userNickname=2;//用户昵称
            optional string userPicPath=3;//头像地址
            optional sint64 shopId=4;//商店id
            optional string tableId=5;//桌台id
            optional string clearType=6;//清理类型
            optional string orderId=7;//订单id
            optional sint64 tag=8;//tag
            optional sint32 source=9[default=1];//来源 1微信 2pad
        }  
        // Our address book file is just one of these.
        message AddressBook {
          repeated Person person = 1;
        }

##### 由于Protobuf需要在多种语言之间进行交互，所以对于proto文件中的数据类型定义如下： #####

![数据类型对比][SouthEast]

### 2.2Java使用说明： ###

#### 2.2.1在Java中使用Protobuf需要注意几点： ####

1.java\_package属性：在class生成时，会在相对路径后加上这个属性对应的包名，在定义时需要与项目中你希望放Protobuf Class的路径相同。   
2.java\_outer\_classname属性：这个属性是在生成Class后的类名，下面包含的message都是这个class下的内部类。

#### 2.2.2使用说明： ####

##### 安装protoc： #####

1.  windows：首先需要在github的protobuf[开源地址][Link 1]下载protoc进行安装
2.  mac:依次执行brew install automake brew install libtool brew install protobuf

##### protoc使用: #####

protoc --java_out=src/main/java/ src/main/resources/proto/shoppingcart.proto

java\_out:生成的java文件输出目录   
后面的指定的是proto文件的地址

#### 2.2.3Usage: ####

下列使用上面2.1proto文件中的UserInfo对象来进行举例：

##### 2.2.3.1创建对象： #####

1.  通过build的方式创建对象:

ProtoEntity.UserInfo proUserInfo =  ProtoEntity.UserInfo.newBuilder().setTableId("1234").setShopId(1234).setUserId("userid").setUserNickname("测试").setTag(1234444L).build();

1.  通过被编译后的byte\[\]:

ProtoEntity.UserInfo joinRoomUserInfo = ProtoEntity.UserInfo.parseFrom(data.getData());

同时Protobuf的对象parseFrom方法还有通过InputStream和ByteString对象来生成对象的方式。

##### 2.2.3.2序列化对象： #####

1.  序列化为byte\[\]:

userInfo.toByteArray();

同时，protobuf的每个对象也可以序列化为InputStream和ByteString等。

### 2.4JS使用说明: ###

#### 2.4.1Protobuf.js导入方式: ####

1.  直接下载[protobuf下载地址][protobuf]
2.  使用npm install protobuf也可以安装
3.  直接粘贴

#### 2.4.2Usage: ####

##### 2.4.2.1创建对象: #####

protobuf.load("./js/proto/shoppingcart.proto", function (err, root) { 
                    if (err) throw err;
                    var UserInfo = root.lookup("proto.UserInfo");
                    var message = UserInfo.create(userinfo);
                    var encodedObj = UserInfo.encode(message).finish();

##### 2.4.2.2序列化对象: #####

getProtoObj("./js/proto/shoppingcart.proto", "proto.UserInfo", data, function (result) { 
                    console.info(result);
                });
        function getProtoObj(protoPath, objName, data, cb) { 
                protobuf.load(protoPath, function (err, root) { 
                    if (err) throw err;
                    var info = root.lookup(objName);
                    var result = Uint8Array.from(JSON.parse(data).data);//此时jsProtobuf使用的是无符号byte数组，而java序列化后是带符号的，所以需要先进行转换成无符号的byte数组
                    cb(info.decode(result))
                });
            }

[Google Protocol Buffer]: https://developers.google.com/protocol-buffers/
[SouthEast]: /images/20220605/ada80b0cd21e458583f4688b9d65b4f5.png
[Link 1]: https://github.com/google/protobuf/releases
[protobuf]: https://github.com/dcodeIO/protobuf.js/tree/master/dist