NestJS无法解析Module/Service依赖问题求助

错误信息 #

[Nest] 18316 - 24.04.2023, 15:35:59 ERROR [ExceptionHandler] Nest can't resolve dependencies of the MailService (MailerService, ?). Please make sure that the argument dependency at index [1] is available in the AuthModule context.

Potential solutions:

• Is AuthModule a valid NestJS module?
• If dependency is a provider, is it part of the current AuthModule?
• If dependency is exported from a separate @Module, is that module imported within AuthModule?
  @Module({
  imports: [ /* the Module containing dependency */ ]
  })

问题根源 #

AuthModule中同时导入了MailModule又在providers数组中声明了MailService，导致Nest尝试在AuthModule上下文内实例化MailService，但MailService依赖的ConfigType<typeof mailConfig>仅在MailModule中通过ConfigModule.forFeature(mailConfig)导入，AuthModule未提供该依赖，因此无法解析。

修复步骤 #

1. 修改AuthModule #

从providers中移除MailService，因为MailModule已经导入并导出了MailService，AuthModule可直接使用导出的实例：

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { TypeOrmModule } from '@nestjs/typeorm';
import { HttpModule } from '@nestjs/axios';
import { JwtModule } from '@nestjs/jwt';
import { AuthController } from './auth.controller';
import { AuthService } from './auth.service';
import { GoogleStrategy } from './strategy/google.strategy';
import { FacebookStrategy } from './strategy/facebook.strategy';
import googleConfig from '../config/google.config';
import facebookConfig from '../config/facebook.config';
import { MailModule } from './mail/mail.module';
import { UsersModule } from '../users/users.module';
import { User } from '../users/entities/user.entity';
import { Profile } from '../users/entities/profile.entity';

@Module({
  imports: [
    HttpModule,
    JwtModule.registerAsync({
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: async (configService: ConfigService) => ({
        secret: configService.get('jwt.secretKet'),
        signOptions: { expiresIn: configService.get('jwt.expirationTime') },
      }),
    }),
    UsersModule,
    ConfigModule.forFeature(googleConfig),
    ConfigModule.forFeature(facebookConfig),
    TypeOrmModule.forFeature([User, Profile]),
    MailModule,
  ],
  controllers: [AuthController],
  providers: [
    AuthService,
    GoogleStrategy,
    FacebookStrategy,
    // 移除MailService
  ],
  exports: [AuthService],
})
export class AuthModule {}

2. 优化MailModule（可选但推荐） #

MailerModule.forRootAsync会自动注册MailerService，无需手动在providers中声明，避免重复注册：

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { MailerModule, MailerService } from '@nestjs-modules/mailer';
import { MailService } from './mail.service';
import * as handlebars from 'handlebars';
import mailConfig from '../../config/mail.config';

@Module({
  imports: [
    ConfigModule.forFeature(mailConfig),
    MailerModule.forRootAsync({
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: async (configService: ConfigService) => ({
        transport: {
          host: configService.get('mail.host'),
          port: configService.get('mail.port'),
          secure: configService.get('mail.secure') === 'true',
          auth: {
            user: configService.get('mail.user'),
            pass: configService.get('mail.password'),
          },
        },
        defaults: {
          from: `"${configService.get('APP_NAME')}" <${configService.get(
            'mail.user',
          )}>`,
        },
        template: {
          dir: './templates',
          adapter: new HandlebarsAdapter(),
          options: {
            strict: true,
          },
        },
      }),
    }),
  ],
  controllers: [],
  providers: [MailService], // 移除MailerService
  exports: [MailService], // 移除MailerService（如果AuthModule不需要直接用它）
})
export class MailModule {}

export class HandlebarsAdapter {
  compile(mail: any, callback: any, mailerOptions: any) {
    const template = handlebars.compile(mail.data.html);
    const html = template(mail.data.context);
    mail.data.html = html;
    callback();
  }
}

验证逻辑 #

• MailModule通过ConfigModule.forFeature(mailConfig)获取邮件配置，确保MailService能注入ConfigType<typeof mailConfig>
• MailModule导出MailService，AuthModule导入MailModule后，AuthService可直接注入MailService
• 避免在多个模块中重复声明同一个Provider，防止Nest创建多个实例或依赖解析失败

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