gRPC Node.js快速开始

本文翻译自gRPC官网的Node.js示例,链接地址为:https://www.grpc.io/docs/languages/node/Quick start

gRPC Node

gRPC是一个高性能、开源的通用RPC框架,其官方地址为:https://www.grpc.io/,如下图所示:

https://www.grpc.io/

目前gRPC项目已经托管到Github上面,其Github仓库地址为:https://github.com/grpc/grpc

快速开始

本指南通过一个简单的示例使您开始在Node中使用gRPC。

先决条件

Node版本4.0.0或更高版本

下载示例

您需要本示例代码的本地副本才能完成此快速入门。 从我们的GitHub存储库下载示例代码(以下命令将克隆整个存储库,但是您仅需要有关此快速入门和其他教程的示例):

# Clone the repository to get the example code
$ git clone -b v1.33.2 https://github.com/grpc/grpc
# Navigate to the dynamic codegen "hello, world" Node example:
$ cd grpc/examples/node/dynamic_codegen
# Install the example's dependencies
$ npm install

运行gRPC应用程序

在examples/node/dynamic_codegen目录中:

  • 1.运行服务端:
$ node greeter_server.js
  • 2.从另一个终端,运行客户端:
$ node greeter_client.js

恭喜你! 您刚刚使用gRPC运行了客户端服务器应用程序。

注意
在gRPC服务端和客户端程序运行之前需要在本地使用npm或者yarn安装所需的依赖库。针对gRPC v1.33.2的Node版本,需要安装grpc@grpc/proto-loader依赖库,对于目前最新的gRPC Node版本,则需要安装@grpc/grpc-js@grpc/proto-loader依赖库。
假如使用的是gRPC v1.33.2的Node版本的源代码,如果使用的是npm,在grpc/examples/node/dynamic_codegen目录下,执行如下命令:

npm init -y
npm install grpc @grpc/proto-loader

如果使用的是yarn,在grpc/examples/node/dynamic_codegen目录下,执行如下命令:

yarn init -y
yarn add grpc @grpc/proto-loader

下面是我在Windows10下使用grpc github仓库的最新grpc代码node示例程序运行的结果,使用之前需要安装Node.js开发环境和npm、cnpm、yarn等,然后在grpc源代码的grpc\examples\node\dynamic_codegen目录下使用yarn安装@grpc/grpc-js@grpc/proto-loader依赖库,命令如下:

yarn init -y
yarn add @grpc/grpc-js '@grpc/proto-loader

然后分别运行服务端和客户端,如下图所示:


gRPC Node服务端

gRPC Node客户端

更新gRPC服务

现在,让我们看一下如何使用服务器上的其他方法更新应用程序,以供客户端调用。 我们的gRPC服务是使用protocol buffers的; 您可以在基础知识教程中找到更多有关如何在.proto文件中定义服务的信息。 现在,您只需要知道服务器和客户端“stub”都有一个SayHelloRPC方法,该方法从客户端获取HelloRequest参数,并从服务器返回HelloReply,并且该方法的定义如下:

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

让我们对其进行更新,以使Greeter服务具有两种方法。 编辑examples/protos/helloworld.proto并使用具有相同请求和响应类型的新SayHelloAgain方法对其进行更新:

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  // Sends another greeting
  rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

记住要保存文件!

更新并运行应用程序

现在,我们有了一个新的服务定义,但是仍然需要在示例应用程序的人工编写部分中实现并调用新方法。

更新服务端

在同一目录中,打开greeter_server.js。 像这样实现新方法:

function sayHello(call, callback) {
  callback(null, {message: 'Hello ' + call.request.name});
}

function sayHelloAgain(call, callback) {
  callback(null, {message: 'Hello again, ' + call.request.name});
}

function main() {
  var server = new grpc.Server();
  server.addService(hello_proto.Greeter.service,
                         {sayHello: sayHello, sayHelloAgain: sayHelloAgain});
  server.bind('0.0.0.0:50051', grpc.ServerCredentials.createInsecure());
  server.start();
}

更新客户端

在同一目录中,打开greeter_client.js。 像这样调用新方法:

function main() {
  var client = new hello_proto.Greeter('localhost:50051',
                                       grpc.credentials.createInsecure());
  client.sayHello({name: 'you'}, function(err, response) {
    console.log('Greeting:', response.message);
  });
  client.sayHelloAgain({name: 'you'}, function(err, response) {
    console.log('Greeting:', response.message);
  });
}

运行!

就像我们之前一样,从examples/node/dynamic_codegen目录:

  • 1.运行服务器:
$ node greeter_server.js
  • 2.从另外一个终端,运行客户端:
$ node greeter_client.js

下面是我在自己购买的阿里云服务器上运行服务端和客户端的演示结果:


运行gRPC Node服务端和客户端

下一步是什么

参考资料

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容

  • gRPC 是一个高性能、通用的开源RPC框架,基于HTTP/2协议标准和Protobuf序列化协议开发,支持众多的...
    小波同学阅读 19,494评论 6 19
  • 1. gRpc 概述 gRpc是什么 ?gRPC是Google开源的可以在任何环境中运行的现代开源高性能RPC框架...
    楚江云阅读 1,046评论 0 9
  • 本文翻译自gRPC简介[https://grpc.io/docs/what-is-grpc/introductio...
    雪域迷影阅读 3,001评论 0 0
  • gRPC 是啥 A high performance, open-source universal RPC fra...
    专职跑龙套阅读 4,086评论 0 4
  • gRPC 的两个核心模块: http2.0 + protoBuffer 先在本机搭建好环境(go 要在1.13以上...
    Atomas阅读 339评论 0 0