js 使用protobuf

最新推荐文章于 2024-09-27 07:07:18 发布

早就在城下

最新推荐文章于 2024-09-27 07:07:18 发布

阅读量2.5w

点赞数 4

分类专栏： javaScript 文章标签： protobuf.js protobuf node

本文链接：https://blog.csdn.net/qq_27119625/article/details/83791959

版权

javaScript 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

之前写过node使用protobuf，这个算是综合一点吧。也涉及到前端页面的对protobuf的使用.

google官方的ProtoBuf

Protocol Buffers ，下载对应的版本，然后将路径加入环境变量，在终端输入protoc 出现下面即可：
添加proto文件：proto_person.proto，然后再终端对于目录下输入： protoc --js_out=import_style=commonjs,binary:. .\proto_person.proto 则会生成对应的文件：proto_person_pb.js
protoc使用

syntax = "proto3";
package properson;

message Person {
  string Name = 1;
  int32 Age = 3;
}

node使用

如果是node使用，则已经可以直接引用了，首先需要添加google-protobuf的包引用。新建package.json，添加依赖。执行 npm install

"dependencies": {
        "google-protobuf": "3.6.0"
    }

新建main.js 添加:

var pb = require('./proto_person_pb');

var p = new pb.Person();
p.setName("Tom");
p.setAge(18);

var bytes = p.serializeBinary();

var unBytes = pb.Person.deserializeBinary(bytes);

var name = p.getName();
var age = p.getAge();

console.log(bytes);
console.log(unBytes);
console.log("==================================");
console.log("my name is ", name, "age is", age);

执行 node main.js 即可看到输出：

Uint8Array [ 10, 3, 84, 111, 109, 24, 18 ]
{ wrappers_: null,
  messageId_: undefined,
  arrayIndexOffset_: -1,
  array: [ 'Tom', <1 empty item>, 18 ],
  pivot_: 1.7976931348623157e+308,
  convertedFloatingPointFields_: {} }
==================================
my name is  Tom age is 18

js 前端的使用

安装包：

npm install -g require
npm install -g browserify

使用browserify对文件进行编译打包

编写脚本保存为exports.js

var personProto = require('./proto_person_pb.js');
module.exports = {
     DataProto: personProto
}

执行命令 browserify exports.js > person.js 将proto_person_pb.js文件进行编译打包生成person.js
编写html：index.html，测试。

 <html>
    <head>
   	 <script src="./person.js"></script>
   	    <script>
  			  var p = new proto.properson.Person();
  			 p.setName("Tom");
  			 p.setAge(18);
  			 var bytes = p.serializeBinary();
   		     var unBytes = proto.properson.Person.deserializeBinary(bytes);
   		     var name = p.getName();
   		     var age = p.getAge();

  			 console.log(bytes);
   		     console.log(unBytes);
   		     console.log("==================================");
  			 console.log("my name is ", name, "age is", age);
 		 </script>
   </head>
</html>

然后在浏览器中打开index.html，打开调试模式的console可以看到：

在这里插入图片描述

protobuf.js 使用

安装包： protobuf.js 。官方网址
npm install -g protobufjs -g 代表全局安装，需要使用pbjs工具。
本目录安装protobufjs，在package.json中的dependencies节点添加：“protobufjs”: “6.8.8”，使用6.8.8版本

node 端使用

protobufjs可以直接反射proto文件，所以这一步不需要生成任何文件。还是刚才的proto文件，在刚才的main.js中写入：（注意路径）

var protobuf = require("protobufjs");

protobuf.load("./proto_person.proto", function (err, root) {
 if (err)
     throw err;

 // Obtain a message type
 var AwesomeMessage = root.lookupType("properson.Person");

 // Exemplary payload
 var payload = { Name: "Tom", Age: 18 };

 // Verify the payload if necessary (i.e. when possibly incomplete or invalid)
 var errMsg = AwesomeMessage.verify(payload);
 if (errMsg)
     throw Error(errMsg);

 // Create a new message
 var message = AwesomeMessage.create(payload); // or use .fromObject if conversion is necessary

 // Encode a message to an Uint8Array (browser) or Buffer (node)
 var buffer = AwesomeMessage.encode(message).finish();
 // ... do something with buffer

 // Decode an Uint8Array (browser) or Buffer (node) to a message
 var message = AwesomeMessage.decode(buffer);
 console.log(message)
 // ... do something with message
});

执行node main.js 即可看到：

Person { Name: 'Tom', Age: 18 }

利用pbjs 生成js 使用，在终端输入： pbjs -t static-module -w commonjs -o person_proto.js .\proto_person.proto 生成person_proto.js文件
+在main.js 中输入：


var protobuf = require("./person_proto");

// Obtain a message type
var p = protobuf.properson.Person;

// Exemplary payload
var payload = { Name: "Tom", Age: 18 };

// Verify the payload if necessary (i.e. when possibly incomplete or invalid)
var errMsg = p.verify(payload);
if (errMsg)
throw Error(errMsg);

// Create a new message
var message = p.create(payload); // or use .fromObject if conversion is necessary

// Encode a message to an Uint8Array (browser) or Buffer (node)
var buffer = p.encode(message).finish();
// ... do something with buffer

// Decode an Uint8Array (browser) or Buffer (node) to a message
var message = p.decode(buffer);
console.log(message)
// ... do something with message

js 前端使用

在刚才的index.html中写入,官网引入：//cdn.rawgit.com/dcodeIO/protobuf.js/6.8.8/dist/protobuf.js 提示找不到包，所以我将protobuf.js，放入本目录直接引进来了。

<html>

<head>
    <!-- <script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.8.8/dist/protobuf.js"></script> -->
    <script src="./protobuf.js"></script>

    <script>
        protobuf.load("./proto_person.proto", function (err, root) {
            if (err)
                throw err;

            // Obtain a message type
            var p = root.lookupType("properson.Person");

            // Exemplary payload
            var payload = { Name: "Tom", Age: 18 };

            // Verify the payload if necessary (i.e. when possibly incomplete or invalid)
            var errMsg = p.verify(payload);
            if (errMsg)
                throw Error(errMsg);

            // Create a new message
            var message = p.create(payload); // or use .fromObject if conversion is necessary

            // Encode a message to an Uint8Array (browser) or Buffer (node)
            var buffer = p.encode(message).finish();
            // ... do something with buffer

            // Decode an Uint8Array (browser) or Buffer (node) to a message
            var message = p.decode(buffer);
            console.log(message)
            // ... do something with message
        });
    </script>
</head>

<body>
    <h3>protobuf test</h3>
</body>

</html>