详解vue中使用protobuf踩坑记


Posted in Javascript onMay 07, 2019

官方解释为:

Protocol buffers are a flexible, efficient, automated mechanism for serializing structured data ? think XML, but smaller, faster, and simpler. You define how you want your data to be structured once, then you can use special generated source code to easily write and read your structured data to and from a variety of data streams and using a variety of languages. You can even update your data structure without breaking deployed programs that are compiled against the "old" format.

翻译是(机翻---我英语不好)

协议缓冲区是用于序列化结构化数据的灵活,高效的自动化机制 - 思考XML,但更小,更快,更简单。您可以定义一次数据的结构,然后您可以使用特殊的源代码轻松地将结构化数据写入各种数据流并使用各种语言读取和读取数据。您甚至可以更新您的数据结构,而不会中断根据“旧”格式编译的已部署程序。

特点:

  • 更简单
  • 是3到10倍小
  • 速度要快20到100倍
  • 不太模糊
  • 生成更易于以编程方式使用的数据访问类

代码

在github上写了个demo demo地址 有需要的可以下载下来跑一下就理解了。PS:如果觉得有用 请给我个小星星 (笔芯~)

使用

其实最开始我尝试使用一个第三方JSprotobuf.js protobuf.load 的时候浏览器报了个错illegal token '<' (/demo.proto, line 1) 查找了下官网issue,大意应该是proto文件多了个字符,但是我查看过proto文件并没有发现有多的'<',怎么办呢,最后放弃使用第三方。用官方提供的方法。

下载protobuf编译器

下载地址 (我下载的是3.40版) github也提供了zip包,可自行下载 (目前最新版本是v3.6.0) 用来编译proto为JS文件方便调用

配置环境变量

由于公司用的是win10 只需要将下载的文件地址添加到path即可 Mac与window命令唯一的区别就是需要将protoc改成protoc.exe 前提是需要添加环境变量

编写proto文件

为了确保前后一致,下面是后台写给我的一个测试proto,我司后台是java

syntax = "proto2";//protobuf版本
option java_package = "com.test.protobuf";
option java_outer_classname = "PersonMessage";
message Person {
 required int32 id = 1;
 optional string name = 2;
 optional string email = 3;
 repeated string list = 4;
 extensions 100 to 1000;//允许扩展的ID
}

message PersonTree {
 optional string id = 1;
 optional string title = 2;
 repeated PersonTree childs = 3;
}

extend Person {
 optional int32 count = 101;
 optional int32 likes_cnt= 102;
}

message PersonEx {
 optional int32 id = 1;
 extend Person {
  optional int32 px = 103;
  optional int32 py= 104;
 }
 optional Person p = 2;
}

使用vue-cli构建一个工程目录

npm install -g vue-cli
vue init webpack my-project
cd my-project
npm install
npm run dev

安装插件: npm install axios element-ui google-protobuf --save

编译proto为JS

进入 awesome.proto 的存放路径 使用如下命令 protoc.exe --js_out=import_style=commonjs,binary:. awesome.proto

  • 会生成一个awesome_pb.js文件
  • 点击查看awesome_pb.js其实可以看到里面是生成好的方法。只需要在页面中引入JS调用即可

之后我们将这个文件引入页面,当然你也可以考虑全局引用

测试

本地测试

编写一个测试页面,创建一个测试按钮 我是在测试页面 import messages from './awesome_pb.js' 方法为:

methods: {
  protobufferTest () {
   var message = new messages.Person() // 调用Person对象 实例化
   // 赋值
   message.setId(23)
   message.setName('asd')
   // 序列化
   var bytes = message.serializeBinary()

   console.log(bytes) // Uint8Array(7) [8, 23, 18, 3, 97, 115, 100]

   // 反序列化
   var message2 = messages.Person.deserializeBinary(bytes)

   console.log(message2) // proto.PersonTree {wrappers_: null, messageId_: undefined, arrayIndexOffset_: -1, array: Array(3), pivot_: 1.7976931348623157e+308, …}

  }
 }

到此,本地测试完成,没什么毛病了。

前后端联调测试

前方有坑

前后传输是使用的FormData,然后悲剧的事情来了。后台解析不了。查看了下数据 [8, 23, 18, 3, 97, 115, 100] 确实是传过去了。

后来排查出原因是应该是解析成了字符串,然后数值变了。所以解析不出来。 后来使用fromCharCode()方法编辑成字符串形式传输给后台。在使用charCodeAt()取值。

此方法已弃用
protobufferTest () {
   var message = new messages.Person() // 调用Person对象 实例化
   // 赋值
   message.setId(23)
   message.setName('asd')
   // 序列化
   var bytes = message.serializeBinary()

   console.log(bytes) // Uint8Array(7) [8, 23, 18, 3, 97, 115, 100]

   var tests = ''
   for (let index = 0; index < bytes.length; index++) {
    tests += String.fromCharCode(bytes[index])
   }
   console.log(tests) // asd

   // 存入FormData
   let uploadDatas = new FormData()
   uploadDatas.append('protobuf', tests)

   // 使用axios传输给后台
   this.axios.post('/test', uploadDatas)
    .then(function (response) {
     // 将传回的字符串转为数组
     console.log(response.data.split('')) // ["↵", "", "3", "2", "", "", "a", "s", "d", "f"]
     let str = response.data.split('')
     let toChar = []
     for (let index = 0; index < str.length; index++) {
      toChar.push(str[index].charCodeAt())
     }
     console.log(toChar) // [10, 2, 51, 50, 18, 4, 97, 115, 100, 102]

     // 后台传回来的是PersonTree里面的值所以调用PersonTree来反序列化
     var message2 = messages.PersonTree.deserializeBinary(toChar)

     console.log(message2) // proto.PersonTree {wrappers_: null, messageId_: undefined, arrayIndexOffset_: -1, array: Array(3), pivot_: 1.7976931348623157e+308, …}

     // 获取PersonTree的id值
     console.log(message2.getId()) // 32
    })
    .catch(function (error) {
     console.log(error)
    })

  }

以上方法可能存在安全隐患。 向后端传值 因为FormData支持两种方式传输string和blob所以将bytes存入blob中 前端获取数据 对axios的默认传输方式做个更改 axios.defaults.responseType = 'arraybuffer' 将以上的JS代码更改为以下内容

protobufferTest () {
   var message = new messages.Person()
   message.setId(23)
   message.setName('asd')
   var bytes = message.serializeBinary()
   
   console.log(bytes)
   let uploadDatas = new FormData()
   var blob = new Blob([bytes], {type: 'application/octet-stream'})

   uploadDatas.append('protobuf', blob)
   
   this.axios.post('/test', uploadDatas)
    .then(function (response) {
     console.log(response)

     var message2 = messages.PersonTree.deserializeBinary(response.data)
     console.log(message2.getId())
    })
    .catch(function (error) {
     console.log(error)
    })
   // console.log(bytes)
  }

至此前后联调完成

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
简单的js分页脚本
May 21 Javascript
jQuery学习笔记[1] jQuery中的DOM操作
Dec 03 Javascript
深入理解JavaScript系列(26):设计模式之构造函数模式详解
Mar 03 Javascript
在Javascript中处理字符串之big()方法的使用
Jun 08 Javascript
js组件SlotMachine实现图片切换效果制作抽奖系统
Apr 17 Javascript
jQuery遍历节点树方法分析
Sep 08 Javascript
xmlplus组件设计系列之分隔框(DividedBox)(8)
May 02 Javascript
AngularJS 支付倒计时功能实现思路
Jun 05 Javascript
js制作简单的音乐播放器的示例代码
Aug 28 Javascript
js 获取json数组里面数组的长度实例
Oct 31 Javascript
Vuepress 搭建带评论功能的静态博客的实现
Feb 17 Javascript
bootstrap-treeview实现多级树形菜单 后台JSON格式如何组织?
Jul 26 Javascript
Node.js一行代码实现静态文件服务器的方法步骤
May 07 #Javascript
微信小程序扫描二维码获取信息实例详解
May 07 #Javascript
Vue数据绑定简析小结
May 07 #Javascript
javascript实现对话框功能警告(alert 消息对话框)确认(confirm 消息对话框)
May 07 #Javascript
详解Vue、element-ui、axios实现省市区三级联动
May 07 #Javascript
webpack结合express实现自动刷新的方法
May 07 #Javascript
记录一次开发微信网页分享的步骤
May 07 #Javascript
You might like
PHP编码规范的深入探讨
2013/06/06 PHP
PHP修改session_id示例代码
2014/01/08 PHP
PHPUnit测试私有属性和方法功能示例
2018/06/12 PHP
JavaScript 学习小结(适合新手参考)
2009/07/30 Javascript
使用UglifyJS合并/压缩JavaScript的方法
2012/03/07 Javascript
javascript里模拟sleep(两种实现方式)
2013/01/25 Javascript
解决JS浮点数运算出现Bug的方法
2013/03/12 Javascript
jQuery中delegate和on的用法与区别详细解析
2014/01/26 Javascript
jQuery实现多按钮单击变色
2014/11/27 Javascript
javascript图片切换综合实例(循环切换、顺序切换)
2016/01/13 Javascript
基于Bootstrap的标签页组件及bootstrap-tab使用说明
2017/07/25 Javascript
微信小程序实现炫酷的弹出式菜单特效
2019/01/28 Javascript
Nodejs实现图片上传、压缩预览、定时删除功能
2019/10/25 NodeJs
解决vue更新路由router-view复用组件内容不刷新的问题
2019/11/04 Javascript
vue实现导航标题栏随页面滚动渐隐渐显效果
2020/03/12 Javascript
JS中循环遍历数组的四种方式总结
2021/01/23 Javascript
Python列出一个文件夹及其子目录的所有文件
2016/06/30 Python
Python如何实现文本转语音
2016/08/08 Python
python简单实现操作Mysql数据库
2018/01/29 Python
Python中的十大图像处理工具(小结)
2019/06/10 Python
python selenium登录豆瓣网过程解析
2019/08/10 Python
Python pygame绘制文字制作滚动文字过程解析
2019/12/12 Python
Python制作运行进度条的实现效果(代码运行不无聊)
2021/02/24 Python
利用html5 file api读取本地文件示例(如图片、PDF等)
2018/03/07 HTML / CSS
HTML5之SVG 2D入门12—SVG DOM及DOM操作介绍
2013/01/30 HTML / CSS
美国当红的名品折扣网:Gilt Groupe
2016/08/15 全球购物
荷兰鞋子在线:Nelson Schoenen
2017/12/25 全球购物
综合实践教学反思
2014/01/31 职场文书
全国优秀辅导员事迹材料
2014/05/14 职场文书
应届毕业生求职信范文
2014/07/07 职场文书
幼儿教师年度个人总结
2015/02/05 职场文书
情况说明书怎么写
2015/10/08 职场文书
《最后一头战象》教学反思
2016/02/16 职场文书
Go语言并发编程 sync.Once
2021/10/16 Golang
vue自定义右键菜单之全局实现
2022/04/09 Vue.js
python使用pycharm安装pyqt5以及相关配置
2022/04/22 Python