当前位置：首页 > news >正文

NestJS Config入门教程：从安装到配置文件加载的完整步骤

news 2026/7/27 20:53:58

NestJS Config入门教程：从安装到配置文件加载的完整步骤

【免费下载链接】nestjs-configConfig module for nestjs using dotenv :key:项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-config

NestJS Config是一个专为NestJS框架设计的配置组件，它利用dotenv实现环境变量管理，支持多种配置文件加载方式，帮助开发者轻松管理不同环境的应用配置。本文将带你快速掌握NestJS Config的安装、配置和使用方法，让你的NestJS项目配置管理更加高效。

快速安装NestJS Config的两种方式

NestJS Config提供了简单的安装方式，你可以根据项目使用的包管理器选择适合的命令：

使用Yarn安装

yarn add nestjs-config

使用NPM安装

npm install nestjs-config --save

安装完成后，你就可以在项目中引入并使用NestJS Config模块了。

基础配置：注册ConfigModule到应用

要使用NestJS Config，首先需要在应用模块中注册ConfigModule。假设你的项目中有一个src/config目录，包含多个配置文件，你可以这样注册：

// src/app.module.ts import { Module } from '@nestjs/common'; import { ConfigModule } from 'nestjs-config'; import * as path from 'path'; @Module({ imports: [ ConfigModule.load(path.resolve(__dirname, 'config', '**/!(*.d).{ts,js}')), ], }) export class AppModule {}

上述代码中，ConfigModule.load()方法接受一个glob模式参数，用于匹配配置文件。这里使用的**/!(*.d).{ts,js}模式会匹配所有.ts和.js文件，但排除.d.ts类型定义文件，确保在生产环境中正常工作。

配置文件结构与示例

NestJS Config支持多种配置文件结构，最常见的是将不同功能的配置分离到不同文件中。例如：

/src ├── app.module.ts ├── config │ ├── express.ts │ ├── database.ts │ └── app.ts

每个配置文件可以导出一个默认对象，例如：

// src/config/express.ts export default { port: process.env.EXPRESS_PORT || 3000, environment: process.env.NODE_ENV || 'development', // 配置文件中的辅助方法 isProduction() { return this.environment === 'production'; } }

这种结构使配置管理更加清晰，便于维护和扩展。

环境变量与.env文件使用

NestJS Config集成了dotenv，允许你使用.env文件管理环境变量。首先创建一个.env文件：

# .env EXPRESS_PORT=3000 DATABASE_HOST=localhost DATABASE_USER=root DATABASE_PASSWORD=password

然后在配置文件中直接使用process.env访问这些变量：

// src/config/database.ts export default { host: process.env.DATABASE_HOST, username: process.env.DATABASE_USER, password: process.env.DATABASE_PASSWORD, port: parseInt(process.env.DATABASE_PORT) || 5432, };

默认情况下，NestJS Config会在项目根目录查找.env文件。如果需要指定其他路径，可以在加载配置时设置：

ConfigModule.load(path.resolve(__dirname, 'config/**/*.{ts,js}'), { path: path.resolve(__dirname, '..', '.env.staging') });

在控制器和服务中使用配置

配置加载完成后，你可以通过依赖注入在控制器或服务中使用配置。有两种常用方式：

使用ConfigService注入

import { Injectable } from '@nestjs/common'; import { ConfigService } from 'nestjs-config'; @Injectable() export class AppService { constructor(private readonly config: ConfigService) {} getServerPort() { return this.config.get('express.port'); } isProduction() { return this.config.get('express').isProduction(); } }

使用@InjectConfig装饰器

import { Injectable } from '@nestjs/common'; import { InjectConfig } from 'nestjs-config'; @Injectable() export class AppService { constructor(@InjectConfig() private readonly config) {} getDatabaseConfig() { return this.config.get('database'); } }

两种方式都可以方便地访问配置值，你可以根据个人喜好选择。

高级用法：多环境配置与自定义路径

在实际项目中，你可能需要为不同环境（开发、测试、生产）使用不同的配置。NestJS Config支持根据环境变量加载不同的.env文件：

// src/app.module.ts const ENV = process.env.NODE_ENV; @Module({ imports: [ ConfigModule.load(path.resolve(__dirname, 'config/**/*.{ts,js}'), { path: path.resolve(process.cwd(), !ENV ? '.env' : `.env.${ENV}`), }), ], }) export class AppModule {}

然后创建不同环境的配置文件：.env.dev、.env.test、.env.prod，并在启动应用时指定环境：

NODE_ENV=prod node dist/main.js

这种方式可以轻松切换不同环境的配置，非常适合CI/CD流程。

与TypeORM集成示例

NestJS Config常与TypeORM一起使用，配置数据库连接。以下是一个集成示例：

// src/app.module.ts import { Module } from '@nestjs/common'; import { ConfigModule, ConfigService } from 'nestjs-config'; import { TypeOrmModule } from '@nestjs/typeorm'; import * as path from 'path'; @Module({ imports: [ ConfigModule.load(path.resolve(__dirname, 'config', '**', '!(*.d).{ts,js}')), TypeOrmModule.forRootAsync({ useFactory: (config: ConfigService) => config.get('database'), inject: [ConfigService], }), ], }) export class AppModule {}

对应的数据库配置文件：

// config/database.ts export default { type: 'mysql', host: process.env.TYPEORM_HOST, username: process.env.TYPEORM_USERNAME, password: process.env.TYPEORM_PASSWORD, database: process.env.TYPEORM_DATABASE, port: parseInt(process.env.TYPEORM_PORT), entities: process.env.TYPEORM_ENTITIES.split(','), synchronize: process.env.TYPEORM_SYNCHRONIZE === 'true', };

这种配置方式使数据库连接信息与代码分离，更加安全和灵活。