Nestjs框架: @nestjs/config 配置模块详解与实践

NestJS模块化架构与依赖注入实战指南 模块化架构是现代软件开发的核心设计模式,通过将系统拆分为高内聚、低耦合的功能单元,显著提升代码的可维护性和可扩展性。NestJS作为渐进式Node.js框架,创新性地将前端领域成熟的装饰器语法和依赖注入(DI)模式引入后端开发,大幅降低了全栈开发的学习曲线。其模块系统支持显式声明依赖关系,配合TypeScript的强类型特性,为构建企业级应用提供了坚实基础。在实际工程实践中,这种架构特别适合电商平台、SaaS系统等复杂业务场景,能有效管理随着业务增长带来的复杂度。通过合理运用NestJS的模块化设计和DI容 阅读详情

配置模块基础使用

在 NestJS 中,我们通常使用 @nestjs/config 模块来管理应用的配置信息。该模块基于 dotenv,可以轻松地从 .env 或 .env.development、.env.production 等文件中加载环境变量。

  1. 安装模块
pnpm install @nestjs/config
  1. 导入并全局注册

在根模块 AppModule 中导入并注册配置模块:

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
 
@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,  // 全局注册,跨模块可用
    }),
  ],
})
export class AppModule {}

isGlobal: true 是关键配置项,表示该模块为全局模块,所有其他模块均可直接使用其中的服务
这样,我们就可以在任意控制器或服务中通过 ConfigService 获取配置值
注意:如果不设置 isGlobal: true,则需要在每个使用配置的模块中手动导入 ConfigModule

配置文件的加载机制


1 ) 基础 .env 文件

.env 文件采用键值对方式定义环境变量:

DB=mysql
DB_HOST=127.0.0.1
DB_PORT=3306

2 ) 多环境配置文件

可以为不同环境创建对应的 .env 文件:

  • .env.development
  • .env.production
ConfigModule.forRoot({
  envFilePath: `.env.${process.env.NODE_ENV || 'development'}`,
});

这样可以根据 NODE_ENV 自动加载对应环境的配置文件

跨模块使用配置服务

配置服务 ConfigService 通常在根模块中注册后使用。跨模块使用时需确保:

  • 使用 isGlobal: true(推荐)
  • 或手动在子模块中导入 ConfigModule
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { UserController } from './user.controller';
 
@Module({
  imports: [ConfigModule],  // 手动导入
  controllers: [UserController],
})
export class UserModule {}

配置读取与使用

1 ) 在控制器中使用

import { Controller, Get } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
 
@Controller('user')
export class UserController {
  constructor(private configService: ConfigService) {}
 
  @Get()
  getUsers() {
    const db = this.configService.get('DB');
    console.log('DB:', db);
    return { db };
  }
}

2 ) 使用枚举封装键名(推荐)

// config.enum.ts
export enum ConfigEnum {
  DB = 'DB',
  DB_HOST = 'DB_HOST',
}
 
// user.controller.ts
import { ConfigEnum } from './config.enum';
 
const db = this.configService.get(ConfigEnum.DB);

进阶用法:多文件加载与共享配置

可以通过 load 方法加载多个配置文件,实现配置共享:

import * as dotenv from 'dotenv';
import * as fs from 'fs';
 
ConfigModule.forRoot({
  envFilePath: `.env.${process.env.NODE_ENV  || 'development'}`,
  load: [
    () => {
      const config = dotenv.parse(fs.readFileSync('.env'));
      return config;
    },
  ],
});

也可以结合 .env.development 和 .env.production 使用:

ConfigModule.forRoot({
  envFilePath: [
    `.env.${process.env.NODE_ENV}`,
    '.env'
  ],
});

这样优先读取 .env.[NODE_ENV],再读取 .env。

在 package.json 中定义启动脚本以指定环境:

"scripts": {
  "start:dev": "cross-env NODE_ENV=development nest start --watch",
  "start:prod": "cross-env NODE_ENV=production nest start"
}

使用 cross-env 可以在不同操作系统中统一设置 NODE_ENV,从而加载对应的 .env 文件

配置校验(Validation)

为了防止错误配置,我们可以使用 Joi 库对配置进行校验

1 ) 安装 Joi

pnpm install joi

2 ) 定义验证规则

import * as Joi from 'joi';
 
const validationSchema = Joi.object({
  DB: Joi.string().required(),
  DB_HOST: Joi.string().ip().required(), 
  DB_PORT: Joi.number().default(3306).valid(3306, 3307),
  NODE_ENV: Joi.string().valid('development', 'production').default('development'),
});

3 ) 启用校验

ConfigModule.forRoot({
  validationSchema,
});

4 ) 示例验证失败

如果 .env.development 中设置了错误值:

DB_PORT=abc 

启动时将抛出错误:"DB_PORT" must be a number
Joi 提供了强大且直观的校验规则,包括类型校验、IP校验、枚举校验、默认值设定等

高级技巧:自定义校验规则与正则表达式


1 ) 使用正则匹配
DB_URL: Joi.string().pattern(/https:\/\/.*\.example\.com/)

2 ) 自定义校验函数

myField: Joi.any().custom((value, helpers) => {
  if (value !== 'validValue') {
    throw new Error('Invalid value');
  }
  return value;
});

常见问题与解决方案

  1. 配置未生效
  • 检查 .env 文件路径是否正确
  • 检查 process.env.NODE_ENV 是否设置
  • 确保 ConfigModule 已正确导入
  1. 校验失败但未抛出错误
  • 确保 validationSchema 正确绑定
  • 检查是否在 load 方法中覆盖了配置导致校验失效
  1. 全局配置未生效
  • 确保 isGlobal: true 设置正确
  • 检查模块是否被正确导入

完整配置示例代码

// app.module.ts
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import * as Joi from 'joi';
import * as dotenv from 'dotenv';
import * as fs from 'fs';
 
@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: `.env.${process.env.NODE_ENV || 'development'}`,
      validationSchema: Joi.object({
        DB: Joi.string().required(),
        DB_HOST: Joi.string().ip(),
        DB_PORT: Joi.number().default(3306),
        NODE_ENV: Joi.string().valid('development', 'production'),
      }),
      load: [
        () => {
          const config = dotenv.parse(fs.readFileSync('.env'));
          return config;
        },
      ],
    }),
  ],
})
export class AppModule {}

总结

  • 使用 @nestjs/config 模块,可以统一管理环境变量,提升项目可维护性。
  • 跨模块使用时建议开启 isGlobal: true,避免重复导入。
  • 通过 envFilePath 指定多环境配置文件,灵活应对开发、测试、生产环境。
  • 使用 Joi 进行配置校验,可有效防止错误配置导致的运行时异常。
  • 合理使用 load 方法加载共享配置,避免冗余配置。

建议:将配置项集中管理,如使用枚举、配置校验、统一路径等方式,提升代码的可读性与健壮性。

如需进一步了解配置模块与 Joi 的详细用法,可参考如下官方文档:

Image Sensor常见分辨率下HTS,VTS设置 image sensor,HTS,VTS 阅读详情

相关推荐

【博弈论】势博弈(potential game)、EPG以及最佳响应、Nash均衡和帕累托(pareto)最优的理解

文章目录前言一、Potential game二、Nash均衡和Pareto-optimal(帕累托最优)1.Nash 均衡2.Pareto最优三、Best response(最佳响应)四、Exact potential game(EPG)1.合作-傀儡博弈2.合作博弈3.傀儡博弈4.自激博弈5.双边对称交互博弈使用理解 前言 本文主要详细讲解potential game的概念以及Exact potential game 的定义和分类,以及这么博弈方法是如何在论文中引入并使用的,本文仅是对自己在该模块

weixin_44535200的博客 2万+

Nestjs 集成 config module 与 nacos 实现配置化统一

nestjs nacos config

fwzzzzz的博客 3210

lighttools用透镜旋转手动创建菲尼尔透镜

学过很多软件,都没有留下痕迹,很多年之后只记得学过的软件常用的一些功能,稍微难一些的再次用起需要重新学,但如果留下点痕迹,重新再用就会很快。lighttools无意之中接触了,记一点点笔记吧。...

kingsai2012的博客 4334

NESTJS环境配置

实际开发过程中需要对项目环境进行配置,基本环境通常会有测试环境和开发环境。 nest 提供了@nestjs/config包方便我们对环境进行配置 废话不多说,实操步骤如下。 本设置基于文章NESTJS 服务化架构设计和项目搭建中的结构进行设计和实现 安装依赖 npm i --save @nestjs/config 添加配置 为了使配置文件能够进行共享和避免反复配置,将config配置在lib目录下 目录结构如下 ├── apps │ ├── dm │ ├── ge │ └── jsf ├──

kaqiinono的技术小窝 2644

OpenWebUI外部模型配置异常排查与修复指南

本文详细解析了OpenWebUI外部模型配置异常的常见问题及解决方案,包括隐藏字符、数据库锁死等典型现象。通过错误日志分析和数据库修复实战指南,帮助开发者快速定位并解决配置问题,确保OpenWebUI与第三方大模型的稳定连接。

weixin_29205061的博客 316

AMD显卡跑MiniMax H3提速30%:SageAttention ROCm适配全记录

在Transformer架构的视频生成模型中,注意力计算往往是性能瓶颈,尤其当显存资源受限时,低精度量化与内核优化成为关键突破口。SageAttention通过将QK^T矩阵乘法量化为INT8,并以FP16/INT4表达注意力概率矩阵,在保证画质的前提下显著降低访存与计算开销,相比传统FlashAttention具备更高速度上限。这一技术价值在本地部署场景尤为突出——当用户使用非NVIDIA显卡运行大型视频模型时,通用优化库常因依赖CUDA而失效。本文聚焦AMD ROCm平台下的MiniMax H3视频生成

weixin_32238157的博客 291

一文带你搞定Nestjs项目中的配置文件(四种方案)!

应用程序通常在不同的环境中运行,根据环境的不同,应该使用不同的配置设置。例如,通常本地环境依赖于特定的数据库凭据,仅对本地 DB 实例有效,生产环境将使用一组单独的 DB 凭据。由于配置变量会更改,所以最佳实践是将配置变量存储在环境中。应用程序通常在不同的环境中运行,根据环境(Development,Production)的不同,应该使用不同的配置设置。使用第三方的包config,可以方便的读取配置信息,但是校验却需要在读取的位置来加,对于不需要验证,而需要全局使用的配置项可以使用这种方式;官方的。

而世之奇伟、瑰怪,非常之观,常在于险远,而人之所罕至焉,故非有志者不能至也! 4686

hMailServer安装配置

hMailServer安装配置 使用宝塔面板上的宝塔邮件服务器2.1版本,进行安装hMailServer。 宝塔在安装hMailServer是有做了一些配置,如果是手工安装需要注意一下配置点: 1、\hMailServer\Bin 目录下增加mysql连接文件libmysql.dll,要去下载32位的。 libmysql.dll下载 链接:https://pan.baidu.com/s/1YGJXzjowlJ9n_MiqB4xiqw 提取码:wz90 2、 需要提前安装mysql,并创建hM.

王者的博客 5872

一篇文章掌握如何在 NestJS 中安全高效的管理 Config 全局配置文件

应用程序通常需要在多种环境中运行,比如本地开发环境、测试环境和生产环境。在不同的环境中,我们通常需要采用不同的配置设置。举个例子,本地环境可能需要一个特定的数据库凭据,而生产环境则使用另一组完全不同的数据库凭据。由于这些配置变量频繁地改变,因此最佳实践是将它们存在环境变量中。在Node.js中,外部定义的环境变量可以通过全局变量来访问。一种可能的做法是在每个环境中设置不同的环境变量,然而这样做在管理上变得越来越复杂,特别是在需要频繁模拟或更改这些值的开发和测试环境中。一个常见的做法是使用.env。

乐闻世界 1453

Type-C转DP1.4转C双向互传转接线方案

Type-C转DP双向互转方案的核心在于利用Type-C接口中的Alt Mode(交替模式)功能。通过利用Type-C接口的Alt Mode功能,该方案实现了Type-C接口与DP接口之间的双向互传,极大地丰富了用户的视觉体验。在选择Type-C转DP双向互转方案时,用户需要关注兼容性、性能需求、线缆长度和品牌等因素,以确保获得最佳的传输质量和使用体验。因此,Type-C转DP双向互转方案应运而生,旨在实现Type-C接口与DP接口之间的无缝连接,满足用户对高效能和高清晰度视频传输的需求。

m0_70875024的博客 4979

180.在 Vue3 中使用 OpenLayers 实现多个多边形的绘制、编辑、删除与清空

【摘要】本文介绍如何在Vue3+TypeScript环境下使用OpenLayers实现多边形地图交互功能。通过Composition API封装核心逻辑,实现了多边形绘制、编辑、删除及清空等操作。关键技术包括:使用VectorLayer管理图形数据,Draw/Modify/Select交互控制,以及通过ref()管理交互状态。文中提供了完整代码示例,并解决了交互对象叠加问题,为开发GIS应用提供了基础模块。该方案支持扩展为数据库存储、后端交互等高级功能。

小彭的博客 772

【NestJS】环境变量的配置与使用

# @nestjs/config NestJS 内置了 dotenv,并将其封装到 @nestjs/config 里面了 1. `npm i @nestjs/config` 2. 在 .env 文件中编写环境变量: ```typescript TOKEN_SECRET = 'superman' DB = 'mysql' DB_HOST = '127.0.0.1' ``` 3. 在 app.module.ts 文件中全局配置 `ConfigModule`: ```typescript import

Superman_H的博客 3105

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

NestJS——多环境配置方案(dotenv、config、@nestjs/config、joi配置校验)

本篇文章我们学习NestJS的多环境配置方案。

HuoZhiyan 的博客 1645

温度PID控制PLC程序

温度PID稳定控制程序,适用于欧姆龙PLC,对其他PLC也具有很大参考价值

RU DOS版、EFI版32bit/64bit BIOS常用工具

DOS版、EFI版的RU工具,可用来查看IO、MEM、PCI、SMBIOS等资源。亲测在EFI SHELL下可用。

nestjs配置@nestjs/config 入门教程

创建创建});

742

nestjs整合@nestjs-modules-mailer和@nestjs-config以及@nestjs-config和nestjs-config的坑

nestjs整合@nestjs-modules-mailer和@nestjs-config以及@nestjs-config和nestjs-config的坑 注意:@nestjs/config和nestjs/config看起来像一个库,实际上是两个库,用法也不同 @nestjs/config是官方的:(GitHub地址)https://github.com/nestjs/config nestjs/config更像是第三方插件:(GitHub地址)https://github.com/nestjsx/nes

qq_45593068的博客 1830

cross-env 与 @nestjs/config 的对比分析

【代码】cross-env 与 @nestjs/config 的对比分析。

855

nginx中配置angular项目_使用@nestjs/config在NestJs中实现项目配置

1.Nodejs项目配置与dotenv项目可能会运行在不同的环境下。不同的项目可能需要配置不同的端口、数据库等参数以保证项目运行,同一个项目在开发和测试阶段,也可能需要通过修改配置项来模拟接口条件。在生产环境中,一般通过将配置文件写入环境变量的方式来保证项目运行的安全性和可靠性。但在项目开发阶段,频繁修改环境变量则可能带来很多不必要的麻烦,因此,通过配置文件来实现每个项目的独立配置,既有利于前期开...

weixin_39623805的博客 534

NestJS 入门(8):环境变量与配置——密钥不要写死在代码里

这篇文章介绍了在 NestJS 项目中管理环境变量的最佳实践,主要解决配置管理的三个核心问题:不同环境使用不同值、避免密钥泄露到代码仓库、启动时检测缺失配置。文章对比了直接读取 process.env 的简单方案与使用 @nestjs/config 模块的更优方案,指出了硬编码弱密钥兜底、配置重复书写等常见陷阱,并提供了 JWT 模块异步加载配置的正确方式。最后强调了通过启动时校验确保关键变量缺失时直接终止应用,而非带着隐患运行。

weixin_43160044的博客 749

Nestjs配置

应用程序通常在不同的中运行,根据环境的不同,应该使用不同的配置设置。例如,通常本地环境依赖于特定的数据库凭据,仅对本地 DB 实例有效,生产环境将使用一组单独的 DB 凭据。由于配置变量会更改,所以最佳实践是将配置变量存储在环境中。应用程序通常在不同的中运行,根据环境(Development,Production)的不同,应该使用不同的配置设置。

而世之奇伟、瑰怪,非常之观,常在于险远,而人之所罕至焉,故非有志者不能至也! 1778

nest-winston生态系统:与其他Nest.js模块的兼容性分析

nest-winston是一个专为Nest.js框架设计的日志模块包装器,它将强大的winston日志功能无缝集成到Nest.js应用中。作为Nest.js生态系统的重要组成部分,nest-winston与各种核心模块和第三方模块都保持着良好的兼容性,为开发者提供了一致且灵活的日志解决方案。 ## 与Nest.js核心模块的兼容性 ### @nestjs/common模块 nest-wins

gitblog_00526的博客 678

NestJS Config环境变量配置技巧:.env文件使用与多环境管理

NestJS Config是一个专为NestJS框架设计的环境变量配置模块,它利用dotenv实现高效的配置管理。本文将分享NestJS Config的实用技巧,帮助开发者轻松掌握.env文件使用与多环境管理,提升项目配置的灵活性和安全性。 ## 为什么选择NestJS Config? 在现代应用开发中,环境变量管理至关重要。NestJS Config模块通过简洁的API和强大的功能,解决了传

gitblog_00331的博客 433

NestJS + Prisma 多环境配置指南

NestJS多环境配置方案 本方案采用@nestjs/config模块实现多环境配置管理,核心依赖包括: 生产依赖:@nestjs/config(配置管理)、@nestjs/core(核心模块) 开发依赖:cross-env(跨平台环境变量工具) 实现原理 通过NODE_ENV环境变量自动加载对应.env文件 在app.module.ts中配置ConfigModule实现自动加载 package.json中定义各类环境启动脚本 文件结构 包含.env基础文件和.env.development/.env.te

gxy03的博客 1023

Nestjs开发环境和生产环境的配置

这篇是Nest微服务训练营基础篇一小节,训练营大概会有100多篇关于Nest实操的文字,本小节讲述开发过程中环境变量的区分,更多精彩文章关注我,有需要可以加我微信:332904234,备注好来源。

水痕 3678

nestjs 多环境配置

6、根目录找到nest-cli.json文件,主要新增了assets,将yml文件复制到打包dist文件中。js-yaml、@types/js-yaml 主要用来读取yaml文件以及指定类型使用。主要修改点:cross-env NODE_ENV=自定义环境。在package.json中指定不同命令对应不同的变量。5、编写index.ts,主要用来读取配置文件。这里使用yaml进行多环境配置,需要安装。3、新建文件夹config,目录如下。7、配置configModule。

qq_37061571的博客 499

实时消息推送利器:NestJS RedisX Pub/Sub与@Subscribe装饰器详解

在微服务与前后端分离架构大行其道的今天,**实时消息推送**已经成为在线聊天、订单通知、库存变动、缓存刷新等场景的刚需。**NestJS RedisX** 是一套专为 NestJS 打造的模块化 Redis 工具集,其中 **Pub/Sub 插件**基于 Redis 发布/订阅机制,配合强大的 **@Subscribe 装饰器**,让你只需几行代码就能实现跨实例的实时消息推送与事件广播。本文面向新

gitblog_00472的博客 836

NestJS:前端开发者快速上手的后端框架

依赖注入(DI)和模块化是现代软件开发的核心概念,它们通过解耦组件依赖关系来提高代码的可维护性和可测试性。在Node.js生态中,NestJS框架将这些原理与TypeScript深度结合,为开发者提供了类似Angular的开发体验。其装饰器语法和模块系统特别适合有前端背景的开发者快速构建企业级后端应用,在REST API开发、微服务架构等场景展现出色表现。通过内置的依赖注入容器和AOP支持,NestJS有效解决了传统Node.js项目在复杂度增长时的架构难题,成为连接前后端开发范式的重要桥梁。

weixin_33672400的博客 503
上一篇: Nestjs框架: Node.js 多环境配置策略与 dotenv 与 config 库详解
下一篇: Nestjs框架: 用户登录注册模块开发流程解析
Wang's Blog
博客等级 码龄12年 7440粉丝 2427原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值