如何在NestJS模块中构建类型安全的多支付网关统一访问对象

要在GatewaysModule中构建类型安全的统一网关访问对象，你可以通过**工厂函数（useFactory）**注入各个网关服务实例，并结合TypeScript类型定义实现类型约束，具体步骤如下：

1. 统一导出网关服务（可选优化） #

先修改gateways/modules/index.ts，同时导出网关模块和服务类，方便后续统一导入：

// gateways/modules/index.ts
export * from './first-gateway/first-gateway.module';
export * from './first-gateway/first-gateway.service';
export * from './second-gateway/second-gateway.module';
export * from './second-gateway/second-gateway.service';

2. 定义类型安全的网关映射 #

在GatewaysModule中定义GatewayMap类型，明确每个网关key对应的服务类型，确保类型约束：

// gateways/gateways.module.ts
import { Module, Provider } from '@nestjs/common';
import { 
  FirstGatewayModule, 
  FirstGateWayService, 
  SecondGatewayModule, 
  SecondGateWayService 
} from './modules/index';

// 类型安全的网关映射
type GatewayMap = {
  first: FirstGateWayService;
  second: SecondGateWayService;
};

3. 构建统一网关提供者 #

使用useFactory注入所有网关服务实例，组装成统一的访问对象：

// 继续在gateways/gateways.module.ts中编写
const gatewaysProvider: Provider = {
  provide: 'Gateways', // 自定义注入标识
  useFactory: (
    firstGateway: FirstGateWayService,
    secondGateway: SecondGateWayService
  ): GatewayMap => ({
    first: firstGateway,
    second: secondGateway,
  }),
  inject: [FirstGateWayService, SecondGateWayService], // 声明需要注入的依赖服务
};

@Module({
  imports: [FirstGatewayModule, SecondGatewayModule],
  providers: [gatewaysProvider],
  exports: ['Gateways'], // 导出供上层模块（如PaymentsModule）调用
})
export class GatewaysModule {}

4. 上层模块中使用统一网关对象 #

在PaymentsService中通过@Inject('Gateways')注入，并利用GatewayMap获得完整的类型提示：

// payments.service.ts
import { Inject, Injectable } from '@nestjs/common';
import { GatewayMap } from './gateways/gateways.module';

@Injectable()
export class PaymentsService {
  constructor(
    @Inject('Gateways') private readonly gateways: GatewayMap,
  ) {}

  async createPayment(gatewayName: keyof GatewayMap) {
    // 自动获得类型提示，避免拼写错误
    return this.gateways[gatewayName].createPayment();
  }

  async verifyPayment(gatewayName: keyof GatewayMap, paymentId: string) {
    return this.gateways[gatewayName].verifyPayment(paymentId);
  }
}

扩展说明 #

• 新增网关时，只需在GatewayMap中添加对应的key和服务类型，并在inject数组和useFactory参数中补充新服务即可，TypeScript会自动检查类型一致性。
• 如果网关数量较多，可结合NestJS的DiscoveryModule自动扫描所有继承GatewayService的服务，减少手动配置量，但手动注入的方式类型更明确、更易维护。

内容的提问来源于stack exchange，提问作者Mohammad