Nestjs框架: 多环境参数配置-Toy模板网

这篇具有很好参考价值的文章主要介绍了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.1
    name: mysql-dev
    port: 3306
  mysql2:
    host: 127.0.0.1
    name: mysql-dev1
    port: 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文章来源地址https://www.toymoban.com/news/detail-836556.html

到了这里，关于Nestjs框架: 多环境参数配置的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！

Nestjs框架: 多环境参数配置

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

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

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

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏

支付宝扫一扫领取红包，优惠每天领

二维码1

二维码2