闽公网安备 35020302035485号


npm install -g @nestjs/cli nest new grpc-client

nest g app grpc-server



npm run start:dev grpc-client npm run start:dev grpc-server
npm install --save @nestjs/microservicesgrpc 的包:
npm install --save @grpc/grpc-js @grpc/proto-loader修改下 grpc-server 的 main.ts
import { NestFactory } from '@nestjs/core';
import { GrpcOptions, Transport } from '@nestjs/microservices';
import { GrpcServerModule } from './grpc-server.module';
import { join } from 'path';
// 堆代码 duidaima.com
async function bootstrap() {
const app = await NestFactory.createMicroservice<GrpcOptions>(GrpcServerModule, {
transport: Transport.GRPC,
options: {
url: 'localhost:8888',
package: 'book',
protoPath: join(__dirname, 'book/book.proto'),
},
});
await app.listen();
}
bootstrap();
微服务不需要暴露 http 端口,只需要提供微服务之间通信的 tcp 接口就行。这里使用 createMicroservice 创建微服务,指定传输方式 transport 改为 GRPC,并且指定微服务监听端口为 8888。然后在 options 指定 protoPath。
syntax = "proto3";
package book;
service BookService {
rpc FindBook (BookById) returns (Book) {}
}
message BookById {
int32 id = 1;
}
message Book {
int32 id = 1;
string name = 2;
string desc = 3;
}
这是一种叫做 protocol buffer 的语法。

syntax = "proto3"是使用 proto3 版本的语法。
package book;是当前包为 book,也就是一种命名空间。
service BookService {
rpc FindBook (BookById) returns (Book) {}
}
这个就是定义当前服务可以远程调用的方法。有一个 FindBook 方法,参数是 BookById,返回值是 Book。message BookById {
int32 id = 1;
}
message Book {
int32 id = 1;
string name = 2;
string desc = 3;
}
book.proto 只是定义了可用的方法和参数返回值的格式,我们还要在 controller 里实现对应的方法:
@GrpcMethod('BookService', 'FindBook')
findBook(data: { id: number}) {
const items = [
{ id: 1, name: '前端调试通关秘籍', desc: '网页和 node 调试' },
{ id: 2, name: 'Nest 通关秘籍', desc: 'Nest 和各种后端中间件' },
];
return items.find(({ id }) => id === data.id);
}
实现了 findBook 方法,并通过 @GrpcMethod 把它标识为 grpc 的远程调用的方法。
"assets": ["**/*.proto"], "watchAssets": true,把它跑起来:
npm run start:dev grpc-server



import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ClientsModule, Transport } from '@nestjs/microservices';
import { join } from 'path';
@Module({
imports: [
ClientsModule.register([
{
name: 'BOOK_PACKAGE',
transport: Transport.GRPC,
options: {
url: 'localhost:8888',
package: 'book',
protoPath: join(__dirname, 'book/book.proto'),
},
},
]),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}
同样,客户端也是需要 proto 文件的,不然不知道怎么解析协议数据。

import { Controller, Get, Inject, Param, Query } from '@nestjs/common';
import { AppService } from './app.service';
import { ClientGrpc } from '@nestjs/microservices';
interface FindById {
id: number;
}
interface Book {
id: number;
name: string;
desc: string;
}
interface BookService {
findBook(param: FindById): Book
}
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {}
@Inject('BOOK_PACKAGE')
private client: ClientGrpc;
private bookService: BookService;
onModuleInit() {
this.bookService = this.client.getService('BookService');
}
@Get('book/:id')
getHero(@Param('id') id: number) {
return this.bookService.findBook({
id
});
}
}
把它跑起来:npm run start:dev grpc-client浏览器访问下:




今天我们学习了基于 gRPC 的远程方法调用。不同语言的微服务之间可以基于 gRPC 来相互调用对方的方法。它的实现方式是通过 protocol buffer 的语法来定义通信数据的格式,定义 package、service。然后 server 端实现 service 对应的方法,client 端远程调用这些 service。
这样就可以实现在 java、node、go、python 等多种语言之间实现微服务的远程方法调用。如果你写一个 Node 的 BFF 层,调用别的语言的微服务时就会用到 gRPC。