使用 ts-proto 简化 NestJS 微服务开发

宣苓滢Rosa

于 2025-06-24 09:34:26 发布

阅读量718

点赞数 30

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/gitblog_00765/article/details/148864287

使用 ts-proto 简化 NestJS 微服务开发

前言

在现代微服务架构中，gRPC 因其高效的二进制协议和跨语言支持而广受欢迎。然而，在 TypeScript 生态中，传统的 gRPC 开发方式往往伴随着大量样板代码和类型安全问题。本文将介绍如何利用 ts-proto 项目来简化 NestJS 中的 gRPC 微服务开发。

ts-proto 与 NestJS 集成概述

ts-proto 是一个强大的 Protocol Buffers 代码生成器，它能够为 TypeScript 生成类型安全的 gRPC 客户端和服务端代码。当与 NestJS 结合使用时，可以显著减少样板代码，同时提供编译时类型检查，确保你的服务定义与实现始终保持一致。

核心优势

类型安全：自动生成的 TypeScript 接口确保你的实现与协议定义完全匹配
减少样板代码：自动生成装饰器和客户端/服务端接口
编译时检查：协议变更会立即反映在类型系统中，避免运行时错误
NestJS 原生支持：专为 NestJS 微服务架构优化

配置与代码生成

要生成适用于 NestJS 的 TypeScript 代码，只需在生成命令中添加 --ts_proto_opt=nestJs=true 选项。这会生成专门为 NestJS 优化的代码结构。

命名规范与接口生成

ts-proto 会为每个 Protobuf 服务生成两个关键接口：

Controller 接口：用于服务端实现，命名格式为 {ServiceName}Controller
Client 接口：用于客户端调用，命名格式为 {ServiceName}Client

例如，对于以下 Protobuf 定义：

service HeroService {
    rpc FindOneHero (HeroById) returns (Hero) {}
}

将生成 HeroServiceController 和 HeroServiceClient 两个接口。

服务端实现

控制器装饰器

ts-proto 会生成一个类装饰器工厂（如 @HeroServiceControllerMethods()），它会自动为控制器方法添加必要的 @GrpcMethod 和 @GrpcStreamMethod 装饰器。这种方式比手动添加装饰器更安全可靠。

实现示例

@Controller('hero')
@HeroServiceControllerMethods()
export class HeroController implements HeroServiceController {
  private readonly heroes: Hero[] = [
    { id: 1, name: 'Stephenh' }
  ];

  async findOneHero(data: HeroById): Promise<Hero> {
    return this.heroes.find(({ id }) => id === data.id)!;
  }
}

客户端使用

客户端初始化

生成的代码包含服务名称和包名称常量（如 HERO_SERVICE_NAME 和 HERO_PACKAGE_NAME），这些常量会在编译时检查，避免运行时错误。

使用示例

@Injectable()
export class AppService implements OnModuleInit {
  private heroesService: HeroesServiceClient;

  constructor(@Inject(HERO_PACKAGE_NAME) private client: ClientGrpc) {}

  onModuleInit(): void {
    this.heroesService = this.client.getService<HeroesServiceClient>(HERO_SERVICE_NAME);
  }

  getHero(): Observable<Hero> {
    return this.heroesService.findOne({ id: 1 });
  }
}

高级配置选项

ts-proto 提供了多个针对 NestJS 的优化选项：

添加 gRPC 元数据支持：使用 --ts_proto_opt=addGrpcMetadata=true，服务方法的最后一个参数将接受 gRPC Metadata 类型
支持 NestJS 自定义装饰器：使用 --ts_proto_opt=addNestjsRestParameter=true，服务方法的最后一个参数将是 any 类型的 rest 参数
禁用公共符号导出：使用 --ts_proto_opt=exportCommonSymbols=false 可以控制是否导出包名称符号