Nestjs框架: 多环境参数配置

2024-02-23 21:12

本文主要是介绍Nestjs框架: 多环境参数配置,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

多环境配置方案比较:dotenv vs config


1 )dotenv库

  • npmjs.com/package/dotenv
  • 应用广泛,前后端, 解析.env文件,挂载到 process.env 属性上去
  • 安装:$ npm i -S dotenv
  • 按照官方示例配置
  • 在.env文件上配置,对嵌套的数据不太友好,需要自行处理

2 )config库

  • npmjs.com/package/config

  • nodejs环境读取配置文件的包

  • 如果想要支持 .yaml 文件,则需要安装 js-yaml 库来进行支持

  • 对嵌套文件支持友好

  • 新建config/default.json文件, 支持嵌套结构

    {"x":1 ,"y": {"ss":"2"}
    }
    
  • 用法

    const config = require('config')
    const yConfig = config.get('y')
    
  • 进阶用法

    • 合并不同环境的配置
    • 新建 config/production.json
    • 如果在 production 环境下,它会自动合并 default.json 中的配置数据
  • 同样的,支持 yaml 格式, 这里是 defautl.yaml

    # default.yaml
    token: xxxx
    db: host: 'localhost'port: 2222
    
    • 下面是procuction.yaml
      db: host: 'yourdomain.com'port: 2222
      
    • 同样能够解析出来
  • 平时用的时候,也安装下 cross-env, 在package.json中的 scripts

    scripts: {'dev': 'cross-env NODE_ENV=development node index.js''prod': 'corss-env NODE_ENV=production ndoe index.js'
    }
    
    • 这样可以 根据环境来读取对应的yaml配置
  • 注意,以上不仅可以在Nodejs中使用,在前端框架中也可以使用

Nest官方方案:使用config设置配置模块


1 )@nestjs/config 这个模块内置的是 .dotenv

  • 安装:$ npm i -S @nestjs/config

  • 新建 .env文件,配置一些常用的配置

  • 在 app.module.ts 中配置,在这里配置后,相关 controllers 和 providers 都可以使用

    import { ConfigModule } from '@nestjs/config'@Module({// forRoot() 方法就是读取根目录下的 .env 文件imports: [ConfigModule.forRoot(isGlobal: true), UserModule]
    })
    
  • 注意,如果 import { ConfigService } from '@nestjs/config' 直接在UserModule之类的模块中使用,会报错

  • 需要作为一个 @Module 的部分,也就是新建一个user.module.ts文件在@Module中设置 imports 添加一个ConfigModule.forRoot()

  • 之后在user.conftroller.ts 中才能正常使用

  • 正常来说,如果不使用 isGlobal 配置,就会出现如上问题,所以可以在如上的代码示例中,也就是 app.module.ts 中使用

  • 全局配置是推荐的,不建议在每个模块中单独使用

  • 通常 .env 中配置的都是字符串,我们会单独定义一个 enum 枚举的文件来对应读取

  • 这样我们就不用在关键代码中修改字符串了

2 )嵌套 yaml 文件读取

  • 需要使用 js-yaml 库来支持

  • 新建 config/config.yaml

    db:mysql1:host: 127.0.0.1name: mysql-devport: 3306mysql2:host: 127.0.0.1name: mysql-dev1port: 3306
    
  • 新建 src/configuration.ts

    import { readFileSync } from 'fs'
    import * as yaml from 'js-yaml'
    import { join } from 'path'const YAML_CONFIG_FILENMAE = 'config.yaml'
    const filePath = join(__dirname, '../config', YAML_CONFIG_FILENMAE)// 使用函数来导出,因为 ConfigModule 中有一个load方法,需要导入一个函数
    export defualt () => {return yaml.load(readFileSync(filePath, 'utf8'))
    }
    
  • 使用,在 app.module.ts 中

    import { ConfigModule } from '@nestjs/config'
    import { Module } from '@nestjs/common'
    import { UserModule } from './user/user.module'
    import Configuration from './configuration'// const envFilePath = `.env.${process.env.NODE_ENV || 'development'}`@Module({imports: [ConfigModule.forRoot({isGlobal: true,// envFilePath,load: [Configuration]}),UserModule,]
    })
    
  • 这样,在user.controller.ts中 就可以读取到配置文件了

  • 有了这些东西,我们就可以扩展用法了

    • 新建 config/config.production.yml
    • 新建 config/config.development.yml
  • 这样,公共的配置,放在 config.yml 文件中,使用 _.merge 来合并两个配置

  • 分环境来分别配置,后续读取的时候,还是基于process.env.NODE_ENV 来读取对应的配置数据

第三方库config读取json文件配置


1 ) 安装

  • $ npm i -S config

2 ) 配置

  • $ mkdir config
  • $ vi config/default.json
  • $ vi config/development.json
  • $ vi config/production.json
    // default.json
    {"database": {"host": "localhost","port": 3306}
    }// development.json
    {"database": {"dbname": "dev","username": "root","password": "root"}
    }// ...
    

3 )使用

// app.module.ts
import * as config from 'config'console.log(config.get('database')) // 就可以使用了

再结合环境使用,npm i -D cross-env, 结合 package.json

scripts: {"start": "cross-env NODE_ENV=development node dist/index.js"
}

基本用法就是如上

进阶用法参考:github.com/node-config/node-config

还有一个库:github.com/nestjsx/nestjs-config

这篇关于Nestjs框架: 多环境参数配置的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/739939

相关文章

Jenkins分布式集群配置方式

《Jenkins分布式集群配置方式》:本文主要介绍Jenkins分布式集群配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装jenkins2.配置集群总结Jenkins是一个开源项目,它提供了一个容易使用的持续集成系统,并且提供了大量的plugin满

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

SQL Server配置管理器无法打开的四种解决方法

《SQLServer配置管理器无法打开的四种解决方法》本文总结了SQLServer配置管理器无法打开的四种解决方法,文中通过图文示例介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的... 目录方法一:桌面图标进入方法二:运行窗口进入检查版本号对照表php方法三:查找文件路径方法四:检查 S

Linux中SSH服务配置的全面指南

《Linux中SSH服务配置的全面指南》作为网络安全工程师,SSH(SecureShell)服务的安全配置是我们日常工作中不可忽视的重要环节,本文将从基础配置到高级安全加固,全面解析SSH服务的各项参... 目录概述基础配置详解端口与监听设置主机密钥配置认证机制强化禁用密码认证禁止root直接登录实现双因素

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置(1)、下载安装SQLite库(2)、解压下载的文件(3)、

Linux如何快速检查服务器的硬件配置和性能指标

《Linux如何快速检查服务器的硬件配置和性能指标》在运维和开发工作中,我们经常需要快速检查Linux服务器的硬件配置和性能指标,本文将以CentOS为例,介绍如何通过命令行快速获取这些关键信息,... 目录引言一、查询CPU核心数编程(几C?)1. 使用 nproc(最简单)2. 使用 lscpu(详细信

Python的端到端测试框架SeleniumBase使用解读

《Python的端到端测试框架SeleniumBase使用解读》:本文主要介绍Python的端到端测试框架SeleniumBase使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全... 目录SeleniumBase详细介绍及用法指南什么是 SeleniumBase?SeleniumBase

Nginx 重写与重定向配置方法

《Nginx重写与重定向配置方法》Nginx重写与重定向区别:重写修改路径(客户端无感知),重定向跳转新URL(客户端感知),try_files检查文件/目录存在性,return301直接返回永久重... 目录一.try_files指令二.return指令三.rewrite指令区分重写与重定向重写: 请求

Nginx 配置跨域的实现及常见问题解决

《Nginx配置跨域的实现及常见问题解决》本文主要介绍了Nginx配置跨域的实现及常见问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来... 目录1. 跨域1.1 同源策略1.2 跨域资源共享(CORS)2. Nginx 配置跨域的场景2.1