node.js

关注公众号 jb51net

关闭
首页 > 网络编程 > JavaScript > node.js > NodeJS使用GRPC和协议缓冲区

通过NodeJS轻松使用GRPC和协议缓冲区的方法

作者：学会种一棵树

本文介绍了GRPC和协议缓冲区的基本概念,并展示了如何在NodeJS应用程序中使用它们,GRPC是一个高性能RPC框架,协议缓冲区则用于定义服务和序列化消息,本文给大家介绍如何在NodeJS应用程序中使用GRPC和协议缓冲区,感兴趣的朋友一起看看吧

本文将对GRPC和协议缓冲区进行基本介绍。接下来，我将展示如何在NodeJS应用程序中使用GRPC和协议缓冲区

GRPC是什么

GRPC是一个开源高性能RPC框架，那么RPC到底是做什么的呢？请看下面的例子

function getEmployee() {
  return "ABCD";
}
function greetEmployee()
{
  let employee = getEmployee();
  console.log("Greet",employee) 
}

在这里，我们有一个getEmployee函数，它返回一个Employee Name，另一个函数greetEmployee，它调用getEmployee并获取该员工的Name，然后打印一个Greeting。

这里的greetEmployee调用getEmployee是一个常规函数调用。

现在，如果getEmployee和greetEmployee函数位于不同的地址空间中，或者它们位于由网络分隔的2个不同的主机中，则该函数调用称为“远程过程调用”(Remote Procedure Call, RPC)。在这里，具有getEmployee函数的System充当服务器，而具有greetEmployee函数的System充当客户端。

什么是Protocol Buffer (协议缓冲区)

协议缓冲区是默认情况下在GRPC中使用的接口定义语言。

在本文后面的部分中，我们将在使用NodeJS应用程序时看到如何使用protocol buffers(协议缓冲区)。

支持哪些不同类型的RPC？

Unary RPC

这是可用的最简单的RPC。客户端在此处向服务器发送请求消息。服务器处理该请求，然后将响应消息发送回客户端

在本文中，这是我们将重点介绍的grpc。

Server Streaming RPC

在此RPC中，客户端将请求消息发送到服务器，然后服务器以流方式将一系列消息发送回客户端。

Client Streaming RPC

在此RPC中，客户端以流方式向服务器发送一系列消息。然后，服务器处理所有这些请求，然后将响应消息发送回客户端。

Bidirectional Streaming RPC

在此RPC中，客户端以流方式向服务器发送一系列消息。然后，服务器处理请求，然后以流方式将一系列消息发送回客户端。

如何在NodeJS中使用GRPC和协议缓冲区

使用以下命令创建一个名为grpc-nodejs-demo的文件夹并在其中初始化nodejs

mkdir grpc-nodejs-demo
cd grpc-nodejs-demo
npm init

这将创建一个package.json文件。

修改package.json文件

将package.json文件替换为以下内容

{
  "name": "grpc-nodejs-demo",
  "version": "1.0.0",
  "description": "",
  "main": "server.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "@grpc/proto-loader": "^0.1.0",
    "grpc": "^1.11.0",
    "lodash": "^4.6.1"
  },
  "author": "Name",
  "license": "MIT"
}

在这里我们添加了3个依赖项

package.json文件更新后。运行以下命令以安装依赖项

npm install

定义协议缓冲区

在此示例中，我们将构建一个将employee ID作为输入，并提供employee详细信息作为输出的服务。

所需的服务接口和有效负载将在协议缓冲区文件中指定。协议缓冲区文件的扩展名为.proto

现在，我们来创建.proto文件。

在项目中创建一个名为proto的文件夹。在proto文件夹中，创建一个名为employee.proto的文件，并向其中添加以下代码

syntax = "proto3";
package employee;
service Employee {
  rpc getDetails (EmployeeRequest) returns (EmployeeResponse) {}
}
message EmployeeRequest {
  int32 id = 1;
}
message EmployeeResponse{
  EmployeeDetails message = 1;
}
message EmployeeDetails {
  int32 id = 1;
  string email = 2;
  string firstName = 3; 
  string lastName = 4;
}

那么，我们在这里到底做了什么？

syntax="proto3";表示我们要使用Protocol Buffer version 3。

package employee; 表示我们正在创建一个名为employee的程序包，我们将在其中定义我们的services

service Employee {
  rpc getDetails (EmployeeRequest) returns (EmployeeResponse) {}
}

上述脚本表明我们正在创建一个称为Employee的服务。在此服务中，我们正在创建一个名为getDetails的函数（rpc），该函数接受EmployeeRequest类型的输入并以EmployeeResponse格式提供响应

接下来，我们需要定义EmployeeRequest和EmployeeResponse。这是在以下脚本中完成的

message EmployeeRequest {
  int32 id = 1;
}
message EmployeeResponse{
  EmployeeDetails message = 1;
}
message EmployeeDetails {
  int32 id = 1;
  string email = 2;
  string firstName = 3; 
  string lastName = 4;
}

在这里，我们看到消息EmployeeRequest具有单个类型为int32和名称id的字段。此处分配的数字1是字段号，它在消息的编码和解码过程中提供帮助。定义的每个字段应具有唯一的字段号

我们还看到EmployeeResponse有一个类型为EmployeeDetails的自定义字段，并且名称消息的字段编号为1。这意味着甚至也必须定义EmployeeDetails，如上所示。

EmployeeDetails具有4个字段，包括类型int32和string。它们都有唯一的字段编号(unique field numbers)

Field numbers between 1 -15 use 1 byte of space during encoding. and field numbers from 2 - 2047 uses 2 bytes for encoding and hence will take up more space. So try to design in such a way that the field numbers are between 1 - 15 as much as possible

1 -15之间的编号在编码过程中使用1个字节的空间。并且2-2047的字段编号使用2个字节进行编码，因此会占用更多空间。因此，请尝试以尽可能多的字段编号介于1到15之间的方式进行设计

Creating the GRPC Server

创建一个名为server.js的文件

首先，让我们包括我们需要的所有库，并定义.proto文件所在的位置

const PROTO_PATH = __dirname + '/proto/employee.proto';
const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
const _ = require('lodash');

接下来，我们需要加载.proto文件。这是使用protoLoader库的loadSync方法完成的。

let packageDefinition = protoLoader.loadSync(
    PROTO_PATH,
    {keepCase: true,
     longs: String,
     enums: String,
     defaults: true,
     oneofs: true
    }
);

接下来，从已加载的原始文件包定义中，我们需要获取所需的包。这是使用以下脚本完成的

let employee_proto = grpc.loadPackageDefinition(packageDefinition).employee;

在这里，我们将employee包放入employee_proto变量中。

employee_proto现在将具有所有原型定义。

接下来，我们需要创建一些虚拟employees数据供服务器使用。创建一个名为data.js的文件，并将以下脚本添加到其中

let employees = [{
    id: 1,
    email: "abcd@abcd.com",
    firstName: "First1",
    lastName: "Last1"   
},
{
    id: 2,
    email: "xyz@xyz.com",
    firstName: "First2",
    lastName: "Last2"   
},
{
    id: 3,
    email: "temp@temp.com",
    firstName: "First3",
    lastName: "Last3"   
},
];
exports.employees = employees;

接下来，我们需要将data.js导入server.js。为此，在server.js中添加以下脚本

function main() {
  let server = new grpc.Server();
  server.addService(employee_proto.Employee.service, {getDetails: getDetails});
  server.bind('0.0.0.0:4500', grpc.ServerCredentials.createInsecure());
  server.start();
}

let server = new grpc.Server();

是创建新GRPC Server的脚本

在.proto文件中，我们注意到在Employee Service内部有一个名为getDetails的函数。

server.addService（employee_proto.Employee.service，{getDetails：getDetails}）;

是我们在其中添加Service实现的脚本。该脚本表明，我们在employee_proto.Employee Service中添加了getDetails函数。然后，我们将此服务添加到服务器。

server.bind('0.0.0.0:4500', grpc.ServerCredentials.createInsecure()); 是指示服务器将在端口4500上启动且没有身份验证的脚本

server.start(); 是实际启动服务器的脚本

现在待处理的主要事情是实现getDetails函数。下面的脚本显示了实现

function getDetails(call, callback) {
  callback(null, 
    {
       message: _.find(employees, { id: call.request.id })
    });
}

这里的call具有请求参数，而回callback 是我们需要定义实现的地方。

在callback 内部，我们收到一条消息：_.find（employees，{id：call.request.id}），其中显示以下内容

这样就完成了服务器的实现。这是server.js的完整脚本

const PROTO_PATH = __dirname + '/proto/employee.proto';
const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
const _ = require('lodash');
let packageDefinition = protoLoader.loadSync(
    PROTO_PATH,
    {keepCase: true,
     longs: String,
     enums: String,
     defaults: true,
     oneofs: true
    });
let employee_proto = grpc.loadPackageDefinition(packageDefinition).employee;
let {employees} = require('./data.js');
function getDetails(call, callback) {
  console.log('client call :%j', call)
  callback(null, 
    {
       message: _.find(employees, { id: call.request.id })
    });
}
function main() {
  let server = new grpc.Server();
  server.addService(employee_proto.Employee.service, {getDetails: getDetails});
  server.bind('0.0.0.0:4500', grpc.ServerCredentials.createInsecure());
  server.start();
}
main();

Creating the GRPC Client

创建一个名为client.js的文件 将以下脚本复制到client.js

const PROTO_PATH = __dirname + '/proto/employee.proto';
const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
let packageDefinition = protoLoader.loadSync(
    PROTO_PATH,
    {keepCase: true,
     longs: String,
     enums: String,
     defaults: true,
     oneofs: true
    }
);
let employee_proto = grpc.loadPackageDefinition(packageDefinition).employee;

上面的脚本以与server.js中相同的方式将employee包加载到employee_proto变量中

接下来，我们需要一种可以调用RPC的方式。在这种情况下，我们需要能够调用服务器中实现的getDetails函数。

为此，我们需要在客户端中创建一个存根(stub)。这是使用以下脚本完成的。

  let client = new employee_proto.Employee('localhost:4500', grpc.credentials.createInsecure());

该client Stub将帮助我们调用在服务器上运行的Employee Service中定义的getDetails函数。服务器依次在端口4500上运行。代码行还指示未使用身份验证

最后，我们可以使用以下脚本调用getDetails函数

let employeeId = 1;
 client.getDetails({id: employeeId}, function(err, response) {
    console.log('Employee Details for Employee Id:',employeeId,'\n' ,response.message);
  });

如前所述，客户端存根可以像正常函数调用一样帮助我们在服务器中调用getDetails函数。为此，我们将employeeId作为输入。

最后，Response 进入response 变量。然后，我们将打印响应消息。

完整的client.js代码如下

const PROTO_PATH = __dirname + '/proto/employee.proto';
const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
let packageDefinition = protoLoader.loadSync(
    PROTO_PATH,
    {keepCase: true,
     longs: String,
     enums: String,
     defaults: true,
     oneofs: true
    });
let employee_proto = grpc.loadPackageDefinition(packageDefinition).employee;
function main() {
  let client = new employee_proto.Employee('localhost:4500',
                                       grpc.credentials.createInsecure());
  let employeeId;
  if (process.argv.length >= 3) {
    employeeId = process.argv[2];
  } else {
    employeeId = 1;
  }
  client.getDetails({id: employeeId}, function(err, response) {
    console.log('Employee Details for Employee Id:',employeeId,'\n' ,response.message);
  });
}
main();

Running The Server and Client

打开命令提示符并使用以下命令运行服务器

node server.js

打开一个新的命令提示符，并使用以下命令运行客户端

node client.js

当我们运行客户端时。它将打印以下输出

Employee Details for Employee Id: 1 
 { id: 1,
  email: 'abcd@abcd.com',
  firstName: 'First1',
  lastName: 'Last1' 
 }

运行截图

原文地址

How to Easily use GRPC and Protocol Buffers with NodeJS

关于GRPC Streams in NodeJS参考作者原文

我的示例源码地址

到此这篇关于如何通过NodeJS轻松使用GRPC和协议缓冲区的文章就介绍到这了,更多相关NodeJS使用GRPC和协议缓冲区内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文