如何在NestJS中从自定义配置文件读取环境配置？

问题根源 #

你通过registerAs('env')定义的自定义配置未被ConfigModule加载，导致ConfigService无法获取env.host配置项，最终引发Mongoose数据库连接失败。

解决方案 #

1. 在根模块中加载自定义配置 #

确保ConfigModule在根模块（如AppModule）导入时，通过load选项加载你的自定义配置文件。假设自定义配置文件路径为src/config/env.config.ts：

// src/app.module.ts
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import envConfig from './config/env.config';
import { DatabaseModule } from './database/database.module';

@Module({
  imports: [
    ConfigModule.forRoot({
      load: [envConfig], // 加载自定义配置
      isGlobal: true, // 可选：设为全局模块，其他模块无需重复导入ConfigModule
    }),
    DatabaseModule,
  ],
})
export class AppModule {}

2. 调整DatabaseModule的配置（未全局注册ConfigModule时） #

若未设置ConfigModule为全局，需在DatabaseModule的MongooseModule.forRootAsync配置中，导入带有自定义配置的ConfigModule：

// src/database/database.module.ts
import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { ConfigModule, ConfigService } from '@nestjs/config';
import envConfig from '../config/env.config';

@Module({
  imports: [
    MongooseModule.forRootAsync({
      imports: [
        ConfigModule.forFeature(envConfig), // 加载自定义配置的命名空间
      ],
      inject: [ConfigService],
      useFactory: async (config: ConfigService) => ({
        uri: config.get<string>('env.host'),
      }),
    }),
  ],
})
export class DatabaseModule {}

3. 验证配置读取状态 #

可在useFactory中添加日志，确认配置是否被正确读取：

useFactory: async (config: ConfigService) => {
  const host = config.get<string>('env.host');
  console.log('MongoDB Host:', host); // 检查控制台输出是否为'mongodb://localhost:27017'
  return {
    uri: host,
  };
},

额外注意事项 #

• 确保自定义配置文件的导出格式正确，使用export default registerAs(...)，且导入路径无误。
• 若启用isGlobal: true，其他模块可直接注入ConfigService，无需重复导入ConfigModule。

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