Node Express解析Protobuf

Node Express解析Protobuf

Protobuf 简介

Protobuf 提供了一种语言中立、平台中立、可扩展的机制,用于以向前兼容和向后兼容的方式序列化结构化数据。它类似于 JSON,只是它更小更快,并且生成本地语言绑定。

Protobuf 是定义语言(在 .proto文件中创建)、proto 编译器生成的与数据接口的代码、特定于语言的运行时库以及写入文件(或通过网络连接)。

更多介绍可以查看 Google开发文档

Express端

Protobuf 的请求体使用二进制,所以关键在于 Express 接收到数据后,需要将二进制内容进行编解码,转换成对应的JSON结构体

const axios = require('axios');
const express = require('express');
const protobuf = require('protobufjs');

const app = express();

run().catch(err => console.log(err));

async function run() {
  const root = await protobuf.load('user.proto');

  const doc = { name: 'Bill', age: 30 };
  const User = root.lookupType('userpackage.User');

  app.get('/user', function(req, res) {
    res.send(User.encode(doc).finish());
  });

  // 在decode之前需要用raw中间件处理一遍protobuf数据
  app.post('/user', express.raw({ type: '*/*' }), function(req, res) {
    // Assume `req.body` contains the protobuf as a utf8-encoded string
    const user = User.decode(Buffer.from(req.body));
    Object.assign(doc, user);
    res.end();
  });

  await app.listen(3000);
}

Client端

let data = await axios.get('http://localhost:3000/user').then(res => res.data);

// "Before POST User { name: 'Bill', age: 30 }"
console.log('Before POST', User.decode(Buffer.from(data)));
const postBody = User.encode({ name: 'Joe', age: 27 }).finish();
await axios.post('http://localhost:3000/user', postBody).
then(res => res.data);

data = await axios.get('http://localhost:3000/user').then(res => res.data);
// "After POST User { name: 'Joe', age: 27 }"
console.log('After POST', User.decode(Buffer.from(data)));