grpc node入门教程

本章主要介绍在node.js中grpc的基本用法。

前置知识点：

1.环境要求

在开始之前先安装一些东西。

node版本大于4.0.0

大家可以直接到node官网下载最新的版本安装。

2.下载例子代码

我们直接从grpc的github地址下载演示代码。

$ # 下载v1.24.0版本的代码，当然你可以下载其他版本
$ git clone -b v1.24.0 https://github.com/grpc/grpc

$ # 切换到node演示代码目录
$ cd grpc/examples/node/dynamic_codegen

$ # 安装下node的依赖包
$ npm install

3.运行grpc应用

首先运行服务端

$ node greeter_server.js

另外打开一个新的命令窗口，运行客户端

$ node greeter_client.js

ok, 这个时候你就看到客户端请求服务端的输出结果，后面我们演示下怎么添加一个新的rpc方法。

4.更新rpc服务

grpc的接口是通过protocol buffers定义的，通常都保存在.proto文件中。

如果你打开，前面例子的服务端和客户端代码看，你会发现有一个SayHello的方法，这个方法接受HelloRequest参数，并返回HelloReply参数，下面看看对应的.proto文件，是如何定义rpc接口的。

打开：examples/protos/helloworld.proto 协议文件。

// 定义Greeter，你可以当成类
service Greeter {
  // 定义一个rpc方法SayHello，接受HelloRequest消息，返回HelloReply消息
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// 定义请求参数，HelloRequest消息
message HelloRequest {
  string name = 1;
}

// 定义响应参数，HelloReply消息
message HelloReply {
  string message = 1;
}

现在我们添加一个新的rpc方法，现在.proto定义变成这样。

// 定义Greeter，你可以当成类
service Greeter {
  // SayHello方法
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  // 定义一个SayHelloAgain方法，接受HelloRequest消息，返回HelloReply消息
  rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}
}

// 定义请求参数，HelloRequest消息
message HelloRequest {
  string name = 1;
}

// 定义响应参数，HelloReply消息
message HelloReply {
  string message = 1;
}

5.生成grpc代码

node.js支持动态编译proto协议文件，可以不用手动将.proto文件转换成javascript代码。

6.更新并运行应用程序

6.1. 更新服务端代码

下面是完整的服务端代码，文件：greeter_server.js

// 我们定义的.proto协议文件路径
var PROTO_PATH = __dirname + '/../../protos/helloworld.proto';

// 加载grpc包
var grpc = require('grpc');
var protoLoader = require('@grpc/proto-loader');
// 下面是处理动态加载.proto协议文件
var packageDefinition = protoLoader.loadSync(
    PROTO_PATH,
    {keepCase: true,
     longs: String,
     enums: String,
     defaults: true,
     oneofs: true
    });
var hello_proto = grpc.loadPackageDefinition(packageDefinition).helloworld;

/**
 * 实现 SayHello RPC 方法.
 */
function sayHello(call, callback) {
  callback(null, {message: 'Hello ' + call.request.name});
}

/**
 * 实现 SayHelloAgain RPC 方法.
 */
function sayHelloAgain(call, callback) {
  callback(null, {message: 'Hello again, ' + call.request.name});
}

/**
 * 启动 RPC server
 */
function main() {
  var server = new grpc.Server();
  // 注册我们实现的rpc方法
  server.addService(hello_proto.Greeter.service,
                         {sayHello: sayHello, sayHelloAgain: sayHelloAgain});
  // 设置rpc服务端绑定的地址
  server.bind('0.0.0.0:50051', grpc.ServerCredentials.createInsecure());
  // 启动服务端
  server.start();
}

main();

6.2. 更新客户端代码

完成客户端代码，文件：greeter_client.js

// proto协议文件路径
var PROTO_PATH = __dirname + '/../../protos/helloworld.proto';

var grpc = require('grpc');

// 下面是处理动态加载.proto协议文件
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() {
  // 设置rpc服务端连接地址
  var client = new hello_proto.Greeter('localhost:50051',
                                       grpc.credentials.createInsecure());
  var user;
  if (process.argv.length >= 3) {
    user = process.argv[2];
  } else {
    user = 'world';
  }
  // 请求服务端的sayHello方法
  client.sayHello({name: user}, function(err, response) {
    console.log('Greeting:', response.message);
  });
 
  // 请求服务端的sayHelloAgain方法
  client.sayHelloAgain({name: 'you'}, function(err, response) {
    console.log('Greeting:', response.message);
  });
}

main();

重新运行服务端和客户端即可。

grpc框架