Nest.js 超强实战技巧：微服务中的 gRPC 之道

2023-10-31 00:20:23

在 Nest.js 的微服务领域中，gRPC 无疑是耀眼的明星之一。它以高效、可靠的特性，让开发者在构建微服务时如虎添翼。这篇文章将带你深入了解 Nest.js 中的 gRPC，掌握它的内在原理和使用技巧，开启你的微服务之旅。

gRPC：微服务的通信基石

gRPC（gRPC远程过程调用）是一种开源框架，它允许不同编程语言编写的服务进行高效的通信。它基于 HTTP/2 协议，支持双向流和流控制，为微服务之间的交互提供了稳固的基础。

在 Nest.js 中，gRPC 模块提供了全面的支持，让开发者轻松地构建和消费 gRPC 服务。它包含了一系列开箱即用的工具，可以简化 gRPC 集成，同时保持代码的简洁性和可读性。

搭建你的 gRPC 服务

构建一个 Nest.js gRPC 服务很简单。首先，安装 @nestjs/grpc 包，然后创建你的服务类。使用 @GrpcService 装饰器标记你的服务类，并为其定义方法。这些方法将作为你的 gRPC 服务的端点。

import { GrpcService } from '@nestjs/grpc';

@GrpcService('MyService')
export class MyGrpcService {
  getHello(data: HelloRequest): HelloResponse {
    return { message: 'Hello, world!' };
  }
}

接下来，你需要创建 gRPC protobuf 定义文件（.proto 文件），它将你的服务和消息类型。编译此文件将生成 gRPC 代码，用于生成客户端和服务器代码。

消费 gRPC 服务

要消费 gRPC 服务，请在你的 Nest.js 应用程序中安装 @nestjs/grpc-client 包。然后，创建你的客户端类并使用 @GrpcClient 装饰器标记它。在你的客户端类中，定义服务方法，它们将连接到远程 gRPC 服务。

import { GrpcClient, GrpcMethod } from '@nestjs/grpc-client';

@GrpcClient('MyService')
export class MyGrpcClient {
  @GrpcMethod('getHello')
  getHello(data: HelloRequest): Observable<HelloResponse> {
    return this.client.send('getHello', data);
  }
}

实战案例：商品管理微服务

为了更好地理解 Nest.js gRPC 的强大之处，让我们考虑一个商品管理微服务的示例。在这个微服务中，我们可以使用 gRPC 来定义和实现 CRUD 操作。

定义服务

syntax = "proto3";

package my.proto;

service ProductService {
  rpc GetProduct(GetProductRequest) returns (Product) {}
  rpc CreateProduct(CreateProductRequest) returns (Product) {}
  rpc UpdateProduct(UpdateProductRequest) returns (Product) {}
  rpc DeleteProduct(DeleteProductRequest) returns (DeleteProductResponse) {}
}

message GetProductRequest {
  int64 id = 1;
}

message Product {
  int64 id = 1;
  string name = 2;
  double price = 3;
}

message CreateProductRequest {
  Product product = 1;
}

message UpdateProductRequest {
  Product product = 1;
}

message DeleteProductRequest {
  int64 id = 1;
}

message DeleteProductResponse {
  bool success = 1;
}

实现服务

import { GrpcService } from '@nestjs/grpc';
import { Injectable } from '@nestjs/common';

@GrpcService('ProductService')
@Injectable()
export class ProductService {
  private readonly products: Product[] = [];

  getProduct(request: GetProductRequest): Product {
    return this.products.find(product => product.id === request.id);
  }

  createProduct(request: CreateProductRequest): Product {
    const product = request.product;
    product.id = this.products.length + 1;
    this.products.push(product);
    return product;
  }

  updateProduct(request: UpdateProductRequest): Product {
    const index = this.products.findIndex(product => product.id === request.product.id);
    if (index !== -1) {
      this.products[index] = request.product;
      return request.product;
    }
    return null;
  }

  deleteProduct(request: DeleteProductRequest): DeleteProductResponse {
    const index = this.products.findIndex(product => product.id === request.id);
    if (index !== -1) {
      this.products.splice(index, 1);
      return { success: true };
    }
    return { success: false };
  }
}

使用服务

import { GrpcClient, GrpcMethod } from '@nestjs/grpc-client';
import { Injectable } from '@nestjs/common';

@GrpcClient('ProductService')
@Injectable()
export class ProductClient {
  @GrpcMethod('getProduct')
  getProduct(request: GetProductRequest): Observable<Product> {
    return this.client.send('getProduct', request);
  }

  @GrpcMethod('createProduct')
  createProduct(request: CreateProductRequest): Observable<Product> {
    return this.client.send('createProduct', request);
  }

  @GrpcMethod('updateProduct')
  updateProduct(request: UpdateProductRequest): Observable<Product> {
    return this.client.send('updateProduct', request);
  }

  @GrpcMethod('deleteProduct')
  deleteProduct(request: DeleteProductRequest): Observable<DeleteProductResponse> {
    return this.client.send('deleteProduct', request);
  }
}