NestJS 7.x 环境变量和配置：轻松管理应用程序设置

前端

2023-12-16 21:20:34

NestJS 中的环境变量和配置管理：最佳实践

简介

在现代应用程序开发中，环境变量和配置管理对于轻松管理应用程序设置至关重要。本文将探讨 NestJS 7.x 中环境变量和配置管理的最佳实践，帮助您实现应用程序的灵活性、可移植性和可靠性。

环境变量：

环境变量是存储在操作系统中的键值对。
通过 process.env 对象在应用程序启动时访问。
跨不同环境（开发、测试、生产）轻松更改设置。
建议使用环境变量管理应用程序设置。

配置源：

NestJS 支持多种配置源，包括：

环境变量： 如上所述，用于在不同环境中存储和管理设置。
JSON 文件： 存储键值对的文本文件。
数据库： 持久化存储，也可作为配置源。
其他： YAML 文件、XML 文件等。

配置验证：

配置验证确保配置格式和内容正确无误。

使用 @nestjs/config-validator 包。
使用装饰器（@IsDefined(), @IsString()）验证格式和内容。
确保应用程序启动时不会出现问题。

配置使用：

通过注入 ConfigService 类获取配置。
ConfigService 提供便捷方法获取配置。

最佳实践：

使用环境变量： 跨环境轻松管理设置。
敏感信息存储在环境变量中： 保护机密信息。
配置验证： 确保配置正确。
默认值： 防止应用程序启动问题。
使用 ConfigService： 简化配置获取。

代码示例：

// .env 文件
APP_NAME=My Awesome App

// app.module.ts
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

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

// app.service.ts
import { Injectable, Inject } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {
  constructor(
    @Inject(ConfigService)
    private readonly configService: ConfigService,
  ) {}

  getHello(): string {
    return this.configService.get('APP_NAME');
  }
}