How to get config in controller route of NestJS?

在 NestJS 中，您可以通过多种方法在控制器路由中获取配置信息。以下是一些最常见和最有效的方式：

1. 使用 ConfigService

NestJS 有一个官方的配置包 @nestjs/config，它基于 dotenv 库，允许您轻松地访问环境变量。首先，您需要安装该包并导入 ConfigModule：

bash
npm install @nestjs/config

然后，在模块中导入 ConfigModule：

typescript
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [ConfigModule.forRoot()],
})
export class AppModule {}

在控制器中，您可以通过依赖注入 ConfigService 来获取配置：

typescript
import { Controller, Get } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Controller('example')
export class ExampleController {
  constructor(private configService: ConfigService) {}

  @Get('config')
  getConfig(): string {
    const someValue = this.configService.get<string>('SOME_CONFIG');
    return someValue;
  }
}

2. 使用 @Configurable() 装饰器

NestJS 允许您动态地解析方法的参数。通过使用 @Configurable() 装饰器，您可以在方法参数中注入配置值。

3. 自定义装饰器

您可以创建自定义装饰器来注入配置值，这样可以使代码更加干净和可维护：

typescript
import { createParamDecorator, ExecutionContext } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

export const ConfigValue = createParamDecorator(
  (data: string, ctx: ExecutionContext) => {
    const configService = ctx.switchToHttp().getRequest().app.get(ConfigService);
    return configService.get(data);
  },
);

@Controller('example')
export class ExampleController {
  @Get('config')
  getConfig(@ConfigValue('SOME_CONFIG') someValue: string): string {
    return someValue;
  }
}

4. 环境变量直接注入

另一种较少推荐的方法是直接在控制器中使用 process.env 获取环境变量。这种方法不那么灵活，也不易于测试：

typescript
@Controller('example')
export class ExampleController {
  @Get('config')
  getConfig(): string {
    const someValue = process.env.SOME_CONFIG;
    return someValue;
  }
}

实践举例：

假设您想要获取数据库连接信息，您可以在 .env 文件中设置对应的环境变量：

shell
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_USER=username
DATABASE_PASSWORD=password

然后在控制器中使用 ConfigService 获取这些配置信息：

typescript
@Controller('database')
export class DatabaseController {
  constructor(private configService: ConfigService) {}

  @Get('info')
  getDatabaseInfo(): any {
    const host = this.configService.get<string>('DATABASE_HOST');
    const port = this.configService.get<number>('DATABASE_PORT');
    const user = this.configService.get<string>('DATABASE_USER');
    const password = this.configService.get<string>('DATABASE_PASSWORD');
    
    // 在实际应用中，出于安全考虑，您可能不会直接返回密码信息。
    return { host, port, user };
  }
}

通过这种方式，您可以在 NestJS 的控制器路由中安全、高效地获取配置信息，并且可以通过环境变量轻松地在不同环境（开发、测试、生产）之间进行切换。