Node.js 中怎么使用 gRPC？

gRPC（gRPC Remote Procedure Call）是一种高性能、开源、通用的远程过程调用框架。在 Node.js 中，使用 gRPC 可以轻松构建分布式系统，实现跨语言通信。

gRPC 适用于需要高性能、低延迟和跨语言通信的场景。常见使用场景包括微服务架构、分布式系统、实时通信等。如果你的项目需要这些特性，并且希望通过定义服务接口和消息类型来进行强类型约定，那么 gRPC 是一个理想的选择。

gRPC 基本概念

在开始之前，让我们先了解一些基本概念：

Protocol Buffers（ProtoBuf）: gRPC 使用 ProtoBuf 作为其接口定义语言，用于定义服务接口和消息类型。
服务定义： gRPC 通过 .proto 文件定义服务和消息。
客户端和服务端 Stub: 自动生成的客户端和服务端 Stub 用于调用和实现 gRPC 服务。
四种服务类型： gRPC 支持四种服务类型：Unary（一对一，或者称为一元流）、Server Streaming（服务器流）、Client Streaming（客户端流）和 Bidirectional Streaming（双向流）。

gRPC 功能介绍

gRPC 提供了丰富的功能，包括认证、流控、拦截器等。以下是一些常用功能：

1. 定义服务和消息

在.proto 文件中定义服务和消息：

syntax = "proto3";

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloResponse);
}

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}

2. 生成 Stub

使用 Protocol Buffers 编译器生成客户端和服务端 Stub：

protoc -I=proto_dir --js_out=import_style=commonjs,binary:output_dir --grpc-web_out=import_style=commonjs,mode=grpcwebtext:output_dir service.proto

3. 实现服务

在 Node.js 中实现 gRPC 服务：

const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
const packageDefinition = protoLoader.loadSync('path/to/service.proto');
const service = grpc.loadPackageDefinition(packageDefinition).Greeter;

const server = new grpc.Server();

server.addService(service, {
  SayHello: (call, callback) => {
    const response = { message: `Hello, ${call.request.name}!` };
    callback(null, response);
  },
});

server.bind('127.0.0.1:50051', grpc.ServerCredentials.createInsecure());
server.start();

4. 客户端调

用在 Node.js 中调用 gRPC 服务：

const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
const packageDefinition = protoLoader.loadSync('path/to/service.proto');
const service = grpc.loadPackageDefinition(packageDefinition).Greeter;

const client = new service('localhost:50051', grpc.credentials.createInsecure());

const request = { name: 'John' };

client.SayHello(request, (err, response) => {
  console.log(response.message);
});

在 Node.js 中的实践案例

1. 安装 gRPC 模块

首先，确保你的项目中已经安装了 gRPC 模块。可以使用 npm 进行安装：

npm install grpc

npm install @grpc/proto-loader

npm install @grpc/grpc-js 

npm install minimist

2. 创建 .proto 文件

定义一个简单的服务，文件名为 helloworld.proto：

syntax = "proto3";

package helloworld;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}

  rpc SayHelloStreamReply (HelloRequest) returns (stream HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

3. 生成 Stub

使用 Protocol Buffers 编译器生成客户端和服务端 Stub：

protoc -I=proto_dir --js_out=import_style=commonjs,binary:output_dir --grpc-web_out=import_style=commonjs,mode=grpcwebtext:output_dir calculator.proto

确保你的项目中有 protoc 工具。如果没有，可以通过这里安装。

注：这一步可先忽略，安装 protoc 是为了避免了手动处理底层细节的麻烦

4. 实现服务端

在 Node.js 中实现 gRPC 服务端，创建一个名为 server.js 文件：

/*
  服务端
*/
var PROTO_PATH = __dirname + "/helloworld.proto";

var grpc = require("@grpc/grpc-js");
var protoLoader = require("@grpc/proto-loader");
var packageDefinition = protoLoader.loadSync(PROTO_PATH, {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
});
var hello_proto = grpc.loadPackageDefinition(packageDefinition).helloworld;

/**
 * Implements the SayHello RPC method.
 */
function sayHello(call, callback) {
  callback(null, { message: "Hello " + call.request.name });
}

/**
 * Starts an RPC server that receives requests for the Greeter service at the
 * sample server port
 */
function main() {
  var server = new grpc.Server();
  server.addService(hello_proto.Greeter.service, {
    sayHello: sayHello,
    // 新招呼
    // sayHelloAgain: sayHelloAgain,
  });
  server.bindAsync(
    "0.0.0.0:50051",
    // '127.0.0.1:8080',
    grpc.ServerCredentials.createInsecure(),
    () => {
      server.start();
    }
  );
}

main();

5. 实现客户端

在 Node.js 中实现 gRPC 客户端，创建一个名为 client.js 文件：

/*
  客户端
*/
var PROTO_PATH = __dirname + "/helloworld.proto";

var parseArgs = require("minimist");
var grpc = require("@grpc/grpc-js");
var protoLoader = require("@grpc/proto-loader");
var packageDefinition = protoLoader.loadSync(PROTO_PATH, {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
});
var hello_proto = grpc.loadPackageDefinition(packageDefinition).helloworld;

function main() {
  var argv = parseArgs(process.argv.slice(2), {
    string: "target",
  });
  var target;
  if (argv.target) {
    target = argv.target;
  } else {
    target = "localhost:50051";
  }
  var client = new hello_proto.Greeter(
    target,
    grpc.credentials.createInsecure()
  );
  var user;
  if (argv._.length > 0) {
    user = argv._[0];
  } else {
    user = "world";
  }

  client.sayHello({ name: user }, function (err, response) {
    console.log("服务端消息：", response.message);
  });
}

main();