Nodejs Nestjs配置管理插件nestjs-config的使用

Nodejs Nestjs配置管理插件nestjs-config的使用
nestjs-config 是一个用于 NestJS 的配置管理库，它可以帮助你更方便地管理和访问应用的配置信息。下面是如何安装和使用 nestjs-config 的步骤。

1. 安装

首先，你需要安装 nestjs-config 及其相关依赖：

npm install @nestjs/config class-validator

这里我们还安装了 class-validator，因为它可以帮助我们验证配置。

2. 配置文件结构

通常我们会将配置文件放在 src/config/ 目录下，并为不同的环境（如开发、生产）创建不同的配置文件。例如：

• src/config/env/development.ts
• src/config/env/production.ts

这些文件中可以包含你的环境变量，比如数据库连接字符串等。

示例 development.ts 文件内容：

export default {
  database: {
    host: 'localhost',
    port: 5432,
    user: 'dev_user',
    password: 'dev_password',
  },
};

3. 创建配置服务

接下来，我们需要创建一个配置服务来加载和提供配置。在 src/config/ 目录下创建一个 config.service.ts 文件：

import { Injectable } from '@nestjs/common';
import { ConfigService as NestConfigService } from '@nestjs/config';

@Injectable()
export class ConfigService {
  constructor(private readonly configService: NestConfigService) {}

  get<T>(key: string): T {
    return this.configService.get<T>(key);
  }

  getString(key: string, defaultValue?: string): string {
    return this.configService.get<string>(key, defaultValue);
  }

  getNumber(key: string, defaultValue?: number): number {
    return this.configService.get<number>(key, defaultValue);
  }

  getBoolean(key: string, defaultValue?: boolean): boolean {
    return this.configService.get<boolean>(key, defaultValue);
  }
}

4. 初始化配置模块

在你的主模块（通常是 app.module.ts）中初始化 ConfigModule：

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ConfigService } from './config/config.service';

@Module({
  imports: [
    ConfigModule.forRoot({
      envFilePath: `.env.${process.env.NODE_ENV}`, // 根据环境加载不同的配置文件
      isGlobal: true, // 设置为全局模块
    }),
  ],
  controllers: [AppController],
  providers: [AppService, ConfigService],
})
export class AppModule {}

确保你的项目根目录下有一个 .env 文件模板，以及针对不同环境的 .env.development 和 .env.production 文件。

5. 使用配置

现在你可以在任何服务或控制器中注入并使用 ConfigService 来获取配置信息：

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

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

  @Get('database')
  getDatabaseConfig() {
    const dbConfig = this.configService.get('database');
    console.log(dbConfig);
    return dbConfig;
  }
}

以上就是使用 nestjs-config 进行配置管理的基本步骤。通过这种方式，你可以轻松地管理不同环境下的配置，并且能够更好地组织和维护你的应用配置。