Protobuf笔记以及Java Js 示例

发布时间:2021-06-18 17:30:49

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文件中的数据类型定义如下:


2.2Java使用说明:
2.2.1在Java中使用Protobuf需要注意几点:

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


2.2.2使用说明:
安装protoc:
    windows:首先需要在github的protobuf开源地址下载protoc进行安装 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创建对象:
    通过build的方式创建对象:

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

    通过被编译后的byte[]:

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

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


2.2.3.2序列化对象:
    序列化为byte[]:

userInfo.toByteArray();

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


2.4JS使用说明:
2.4.1Protobuf.js导入方式:
    直接下载protobuf下载地址 使用npm install protobuf也可以安装直接粘贴


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))
});
}

相关文档

  • 李广射虎原文欣赏
  • 键盘坏了电脑启动不了怎么办
  • 利用三层交换机实现vlan通信
  • 关于“爱情”客户关系
  • 万方多难中成就的诗圣阅读答案
  • 优美感动散文
  • 分享到朋友圈没有缩略图?微信自定义标题描述及缩略图最简单完美的办法!
  • 今天的体育课
  • 期权与融资融券的区别
  • 地中海吊顶装修效果图欣赏
  • OpenCV Java 图像直方图均衡化及直方图绘制
  • 如何有效地祛斑
  • 《黄帝内经素问》异法方宜论篇第十二
  • 【STM32学习笔记】软件使用---win10下 keil5打开keil4工程的问题
  • 天津创业扶持政策最新消息
  • 前端实现MD5加密
  • 网签版用户服务合同样书
  • Amazon EC2的简易教程
  • 树叶把森林封的严严实实的封什么词指什么
  • 年会演讲开场白
  • Problem A: 函数---求两个整数的最大公约数
  • 大学生党员新学期学习工作思想汇报
  • 善生童子
  • 村村通道路政策2016年向哪个部门申报
  • 素质教育观的基本内容浅析体育教学中的成功教育与素质教育
  • 枸杞的正确吃法怎样吃比较好
  • 班主任专业素养的几种提升策略
  • 意外之祸AnAccident
  • 2017年西安中考录取分数线公布
  • 四年级春节旅游游记范文400字
  • 猜你喜欢

  • win10企业版|激|活|码
  • 最新-二年级数学下册 有余数除法的认识教案1 苏教版 精品
  • (青少年潜能开发训练营)启迪青少年卓越人生的智慧故事_幸运会敲谁的门
  • 2019厦门卫生事业单位医学心理考试资料:快来测测你的气质类型
  • 机床主轴有限元分析
  • 金城学院毕业设计开题报告_70112960
  • 厚德载物精选书法作品欣赏
  • 河南联化益农化工有限公司企业信用报告-天眼查
  • 2019-2020年八年级数学下册第一章三角形的证明1.1.2等腰三角形课后作业新版北师大版
  • 宁波市鄞州*盛运输有限公司(企业信用报告)- 天眼查
  • 幼儿园中的标语
  • 查询字符串中某字符的个数
  • 农村义务教育学校预算编制辅导讲义共93页文档
  • 沈阳农业大学基建工程队农大饭庄企业信用报告-天眼查
  • 物资党支部在作风建设和谐企业大讨论体会
  • 对灾区朋友的祝福
  • 在心里植棵树
  • 港式小吃的品种和做法
  • 优秀党务工作者村党支部书记先进事迹-精选模板
  • 小满季节养生吃什么效果最好
  • 2018-2019学年高二化学人教版选修3导学精品第3章 晶体结构与性质 第3节
  • 房产策划员的英语简历范本
  • 孩子早上赖床怎么办孩子喜欢赖床怎么立规矩
  • 2018-2019-“中学学校体育计划”体育工作计划-word范文模板 (3页)
  • 网络工程师培训PPT资料
  • 部编人教版一年级语文下册词语搭配专项训练
  • 消防演习总结新版合集
  • 简历资料初中自我介绍范文
  • 田阳县线椒高产种植管理技术
  • 气球压迫治疗高血压合并鼻出血效果及护理措施
  • 《急救设备培训》PPT课件
  • 壳聚糖对黄羽肉鸡平均日增重和血清生化指标的影响
  • 20XX年乡镇农村中心小学德育工作计划第二学期
  • 2019年秋七年级英语上册 Unit 7 How much are these socks(第4课时)Section B(2a-2c)
  • 人教版高中生物选修二4.1《生物性污染及其预防》ppt课件
  • 2019-2020年二年级语文上册 锄禾 1教案 浙教版
  • 做好弘扬红色文化这篇大文章-最新资料
  • 05 “一个流”生产方式
  • 【最新】内科护士辞职信-精选word范文 (3页)
  • 广东省深圳市龙岗区2015-2016学年第一学期期末高一物理试题带答案
  • 2018-2024年中国五分类血球仪市场研究与未来前景预测报告(目录)
  • 幸福甜蜜的情侣签名最新
  • 电脑版