Nest.js无法解析CacheConfigService依赖问题求助

问题分析 #

从代码场景来看，核心报错原因有3个：

1. 类属性初始化顺序错误：SupertokensService中直接在类属性里通过this.cacheConfigService获取Redis地址，但类属性初始化时机早于构造函数的依赖注入，此时cacheConfigService还未被实例化，导致url为undefined。
2. 动态模块配置不完整：AuthModule.forRoot返回的动态模块缺少module: AuthModule标识，Nest无法正确识别该动态模块的归属。
3. Redis客户端未建立连接：创建Redis客户端后未调用connect()方法，后续执行set操作会因连接未建立而失败。

修复步骤 #

1. 修正SupertokensService的Redis客户端初始化 #

将Redis客户端的创建移到构造函数中，确保依赖注入完成后再获取配置：

@Injectable()
export class SupertokensService {
  private redisClient: ReturnType<typeof redis.createClient>;

  constructor(
    @Inject(forwardRef(() => UsersService)) private userService: UsersService,
    private cacheConfigService: CacheConfigService
  ) {
    // 构造函数中创建Redis客户端，此时cacheConfigService已完成注入
    this.redisClient = redis.createClient({
      url: this.cacheConfigService.url,
    });
    // 主动建立Redis连接
    this.redisClient.connect().catch(err => console.error('Redis连接失败:', err));

    supertokens.init({
      appInfo: this.config.appInfo,
      supertokens: {
        connectionURI: this.config.connectionURI,
        apiKey: this.config.apiKey,
      },
      recipeList: [
        ThirdPartyEmailPassword.init({
          providers: [
            ThirdPartyEmailPassword.Google({
              clientSecret: 'TODO: GOOGLE_CLIENT_SECRET',
              clientId: 'CLIENT_ID',
            }),
          ],
          signUpFeature: {
            ...signup logic
          },
          override: {
            apis: (originalImplementation: any) => {
              return {
                ...originalImplementation,
                emailPasswordSignInPOST: async (input: any) => {
                  if (originalImplementation.emailPasswordSignInPOST === undefined) {
                    throw Error('Should never come here');
                  }

                  let response: any = await originalImplementation.emailPasswordSignInPOST(input);

                  // 原有业务逻辑
                  const { email } = inputObject;
                  const user = await this.userService.findOneByEmail(email);
                  const id = user?.id;
                  const token = jwt.sign({email, id}, 'mysecret', {
                    expiresIn: '2h',
                  });
                  response.token = token;
                  // 此时Redis连接已建立，可执行缓存操作
                  await this.redisClient.set("Token", token, {
                    EX: 60 * 60 * 24,
                  });
                  return response;
                },
              };
            },
          },
        }),
      ],
    });
  }
}

2. 完善AuthModule的动态模块配置 #

在forRoot方法返回的对象中添加module: AuthModule，确保Nest正确识别动态模块：

@Module({
  providers: [CacheConfigService, SupertokensService],
  exports: [],
  imports: [CacheConfigModule, UsersModule],
  controllers: [],
})
export class AuthModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer.apply(AuthMiddleware).forRoutes('*');
  }

  static forRoot({
    connectionURI,
    apiKey,
    appInfo,
  }: AuthModuleConfig): DynamicModule {
    return {
      module: AuthModule, // 新增该标识
      imports: [CacheConfigModule],
      // 可添加配置提供者，让SupertokensService获取传入的配置
      providers: [
        {
          provide: 'AUTH_MODULE_CONFIG',
          useValue: { connectionURI, apiKey, appInfo },
        },
        SupertokensService
      ],
      exports: [SupertokensService] // 按需导出给其他模块使用
    };
  }
}

3. 优化CacheConfigService的配置读取（可选） #

确保CacheConfigService能正确解析环境变量：

@Injectable()
export class CacheConfigService {
  get url(): string {
    return `redis://${process.env.REDIS_HOST}:${process.env.REDIS_PORT}`;
  }
}

额外建议 #

如果使用Nest官方的CacheModule，可以直接注入CACHE_MANAGER操作缓存，无需手动创建Redis客户端，示例：

import { CACHE_MANAGER, Inject } from '@nestjs/common';
import { Cache } from 'cache-manager';

@Injectable()
export class SupertokensService {
  constructor(
    @Inject(CACHE_MANAGER) private cacheManager: Cache,
    // 其他依赖...
  ) {}

  // 使用示例
  async setToken(token: string) {
    await this.cacheManager.set('Token', token, 60 * 60 * 24);
  }
}

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