如何扩展NestJS内置NATS客户端以支持NATS的JWT认证?
低成本扩展NestJS NATS客户端补全JWT认证配置的实现方案
完全不需要修改Nest框架源码,通过 继承内置客户端+类型补全 的方式即可完成原生配置透传,改动量小、版本升级兼容成本低,刚好对应你排查到的NatsOptions、ClientOptions、ClientNats、ClientProxy四个关联模块的改造点:
1. 补全配置类型,打通NatsOptions与ClientOptions的类型约束
Nest自带的NATS配置类型对原生nats库的参数做了裁剪,漏掉了JWT认证相关的userJWT、nonceSigner字段,直接在原有类型上扩展即可,不需要修改框架自带的类型定义文件:
import { NatsOptions as NestNatsOptions } from '@nestjs/microservices'; import { UserJWT, NonceSigner } from 'nats'; type ExtendedNatsOptions = NestNatsOptions & { options: NestNatsOptions['options'] & { userJWT?: UserJWT; nonceSigner?: NonceSigner; // 后续其他需要透传的原生NATS配置,直接追加字段即可 } };
这一步的改动完全不涉及ClientProxy基类,只是让你在通过ClientOptions传入配置时,能被TypeScript正确识别,不会报类型错误。
2. 继承内置ClientNats,重写连接逻辑透传缺失配置
内置ClientNats在初始化连接时,会对传入的配置做白名单过滤,不在白名单内的字段会被直接丢弃,这也是为什么即使你传入了userJWT参数,内置客户端也不会生效的根本原因。我们只需要继承内置类,重写连接初始化方法,把认证字段主动透传给原生nats.connect()方法即可:
import { ClientNats as NestClientNats } from '@nestjs/microservices'; import { connect } from 'nats'; import type { NatsConnection } from 'nats'; export class ExtendedClientNats extends NestClientNats { protected async connect(): Promise<NatsConnection> { // 读取框架层解析好的基础连接配置 const baseConfig = this.getOptions() as ExtendedNatsOptions; // 合并基础配置+自定义认证字段,直接调用原生NATS连接方法 const connection = await connect({ ...baseConfig.options, // 主动透传被内置逻辑过滤掉的认证字段 userJWT: baseConfig.options.userJWT, nonceSigner: baseConfig.options.nonceSigner, }); // 直接复用内置类的连接实例绑定逻辑,原有订阅、请求响应、异常处理逻辑完全不动 this.server = connection; return connection; } }
这一步只改ClientNats层的连接逻辑,完全不碰ClientProxy的消息转发核心逻辑,业务侧的NATS调用代码和使用内置客户端时完全一致。
3. 在客户端注册时替换默认实现
通过Nest自带的customClass配置项,指定我们扩展的客户端类代替内置的ClientNats,不需要全局修改框架默认行为:
import { ClientsModule, Transport } from '@nestjs/microservices'; import { ExtendedClientNats } from './extended-nats.client'; @Module({ imports: [ ClientsModule.register([ { name: 'NATS_MESSAGE_BROKER', transport: Transport.NATS, // 指定自定义客户端类,替换内置实现 customClass: ExtendedClientNats, options: { servers: ['nats://你的NATS集群地址:4222'], // 直接传入之前提到的认证配置即可 userJWT: async () => { // 在这里实现你的用户JWT获取逻辑,比如调用自定义认证API拉取对应用户的凭证 return '用户的JWT字符串'; }, nonceSigner: async (nonce) => { // 按照NATS的规则实现nonce签名,用用户私钥对传入的nonce做签名 return '签名后的结果'; } } as ExtendedNatsOptions, }, ]), ], }) export class AppModule {}
落地注意事项
- 整个方案不需要fork修改Nest源码,后续框架升级时,只要内置
ClientNats的核心方法签名不变,自定义类就可以直接兼容使用。 - 作为响应端的Nest应用,也可以用同样的扩展客户端配置连接NATS集群,两端认证配置对齐即可完成JWT授权校验。
- 后续如果Nest官方补全了对应的配置透传能力,只需要移除
customClass指定、删除自定义的扩展客户端文件,即可无缝切回内置实现,没有迁移成本。
内容的提问来源于stack exchange,提问作者zub0r
相关产品推荐
相关产品推荐

