Nest(NestJS)基础复习05 - 配置管理 详细拆解

// app.module.tsimport { Module } from '@nestjs/common';import { ConfigModule } from '@nestjs/config';@Module({  imports: [    ConfigModule.forRoot(),   // 默认读取项目根目录的 .env 文件  ],})export class AppModule {}

# .env（项目根目录，通常提交到仓库保存公共默认值）POSTGRES_HOST=localhostPOSTGRES_PORT=5432

// 任何需要配置的地方注入 ConfigService@Injectable()export class AppService {  constructor(privateconfigService: ConfigService) {}  getDbHost() {    return this.configService.get<string>('POSTGRES_HOST');   // 'localhost'  }}

# .env 文件里写的是POSTGRES_HOST=localhost# 但启动前在 shell 里 export 了系统变量export POSTGRES_HOST=prod-db.example.com

const host = this.configService.get<string>('POSTGRES_HOST');// 结果是 'prod-db.example.com' —— 系统变量优先，.env 没覆盖它

// 场景 A：完全不用 .env（比如配置全部由 K8s/容器注入）ConfigModule.forRoot({  ignoreEnvFile: true,});

// 场景 B：.env 内部互相引用（避免重复写同一段值）ConfigModule.forRoot({  expandVariables: true,});# .env（expandVariables: true 时）HOST=db.example.comPORT=5432DB_URL=${HOST}:${PORT}      # 自动展开为 db.example.com:5432

ConfigModule.forRoot({  envFilePath: ['.env.local', '.env'],   // 前面优先！});

# .env（提交到 git：公共默认值）POSTGRES_HOST=localhostPOSTGRES_PORT=5432# .env.local（gitignore 掉：本地私有覆盖，比如连自己电脑上的数据库）POSTGRES_HOST=192.168.1.100

const host = this.configService.get<string>('POSTGRES_HOST');// 结果是 '192.168.1.100' —— .env.local 排在前面，覆盖了 .env

# .env.development / .env.test / .env.production 各一份# package.json 里用 cross-env 切 NODE_ENV"start:dev":  "cross-env NODE_ENV=development nest start","start:test": "cross-env NODE_ENV=test nest start","start:prod": "cross-env NODE_ENV=production nest start"

// app.module.ts：按 NODE_ENV 选文件ConfigModule.forRoot({  envFilePath: [`.env.${process.env.NODE_ENV}`, '.env'],  // 例如 production 时：先读 .env.production，再兜底 .env});

// env.types.ts —— 定义配置的"形状"interface EnvConfig {  database: {    host: string;    port: number;    password: string;  };  jwt: {    secret: string;  };}

// app.service.tsimport { Injectable } from '@nestjs/common';import { ConfigService } from '@nestjs/config';import { EnvConfig } from './env.types';@Injectable()export class AppService {  // 泛型：告诉 ConfigService "我的配置长这样"  constructor(privateconfigService: ConfigService<EnvConfig>) {}  getDbHost(): string {    // infer: true —— 从 EnvConfig 推导出 string，拼错 key 直接编译报错    return this.configService.get('database.host', { infer: true });  }  getJwtSecret(): string {    // get = 可能拿不到(返回undefined)，不报错；    // getOrThrow = 拿不到就立刻报错，让问题在启动时暴露。    // 配置错误是 "越早暴露越好" 的错误。    // getOrThrow 把问题从 "运行时某次请求才炸" 提前到 "启动就炸"    return this.configService.getOrThrow('jwt.secret', { infer: true });  }}

// ✅ 拼对：编译通过，类型是 stringconst host = this.configService.get('database.host', { infer: true });// ❌ 拼错：编译直接报错，而不是运行时才暴露const host = this.configService.get('database.hostt', { infer: true });// Error: Argument of type '"database.hostt"' is not assignable to ...