对Nodejs配置文件详解

最新推荐文章于 2024-06-29 15:31:10 发布
最新推荐文章于 2024-06-29 15:31:10 发布
阅读量496 收藏
点赞数
分类专栏： Nodejs
原文链接：https://segmentfault.com/a/1190000017576880
版权
原文链接： https://segmentfault.com/a/1190000017576880 
<div class="article fmt article__content">

前言

一般来说：一个好的项目配置应该满足以下条件：

  1. 依赖环境：配置根据具体运行环境从相应的文件读取
  2. 代码分离：配置项不仅可以从配置文件读取， 也可以从环境变量读取，使得安全隐秘的配置项与代码分离
  3. 易于使用：配置项应该是分层配置的，有助于查找条目和维护庞大的配置文件的，应该是容易组织和容易获取的，比如json结构

在多人开发 nodejs 项目的时候，没有规划好配置方案，配置文件的问题就很容易暴露出来。

痛点

在开发 nodejs 的工程中，遇到过三个痛点

  1. 部署环境不同： 开发、测试、生产环境的不同，导致配置的不同
  2. 开发环境不同： 开发者的开发环境配置不同，会存在同一个配置文件配置项不同，同一文件不同内容提交，容易引起 git 冲突，影响 git 提交更新
  3. 安全地配置： 一些配置不应该明文保存在项目代码里面，比如数据库密码

解决方案

部署环境不同

对于部署环境不同，相对容易解决，建立相应环境的配置文件，比如：

  1. 开发环境配置：developmentConfig.js
  2. 测试环境配置：testConfig.js
  3. 生产环境配置：productionConfig.js

再建一个config.js配置文件作为入口获取配置，如下：

module.exports = require(`./${process.env.NODE_ENV}Config.js`)

引用配置的时候，只要引用 config.js 即可。
运行命令如下：

NODE_ENV=development node index.js

开发环境不同

对于开发环境不同，导致每个人的developmentConfig.js不同，这个不能要求别人的配置和你的一样，这样项目就太硬了。
我们可以把developmentConfig.js添加到.gitignore，从而从项目分离出来，再在readme.md说明如何配置developmentConfig.js。
最好是建立一个developmentConfig.example.js，并在文档说明复制成developmentConfig.js后修改配置项符合自己的开发配置。

安全地配置

对于项目一些安全性要求高的配置项，我们应该从配置文件脱离出来，只能在当前的运行进程可以获取， 配置文件的配置项再读取进程的配置项值，比如数据库密码， 一般做法如下：
productionConfig.js


 
 
  1. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     module.
     
     exports = {
    
    
    
   
   
  2. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
         database: {
    
    
    
   
   
  3. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
             user: process.env.user || 
     
     'root',
    
    
    
   
   
  4. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
             password: process.env.password || 
     
     'yfwzx2019'
    
    
    
   
   
  5. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
         }
    
    
    
   
   
  6. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     }

而更隐秘的办法是，你根本不知道我用环境变量覆盖了配置项值，比如：

productionConfig.js


 
 
  1. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     module.
     
     exports = {
    
    
    
   
   
  2. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
         database: {
    
    
    
   
   
  3. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
             user: 
     
     'root',
    
    
    
   
   
  4. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
             password: 
     
     'yfwzx2019'
    
    
    
   
   
  5. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
         }
    
    
    
   
   
  6. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     }

一般人拿到了这个配置，就会以为数据库的账号密码就是root、yfwzx2019，其实最后会被环境变量的值覆盖，运行如下：

node index.js --database.user=combine --database.password=tencent2019

当然，是要做了一些处理才可以这样配置。

实操

方案有了，我们先来介绍以下 nodejs 的配置模块 rc模块

rc 模块

使用rc模块需要定义一个appname，选择rc模块是因为它会尽可能多的从appname命名相关的地方读取配置。
使用也很简单，先实例一个 rc 配置：

var conf = require('rc')(appname, defaultConfigObject)

然后它会从下面列表合并配置，优先级按顺序合并：

  1. 命令行参数：--user=root 或者对象形式赋值 --database.user=root
  2. 环境变量： 环境变量前缀为${appname}_的变量 appname_user=root 对象形式 appname_database__user=root
  3. 指定文件： node index.js --config file
  4. 默认配置文件： 从 ./ ../ ../../ ../../../等目录查找.${appname}rc文件
  5. $HOME/.${appname}rc
  6. $HOME/.${appname}/config
  7. $HOME/.config/${appname}
  8. $HOME/.config/${appname}/config
  9. /etc/${appname}rc
  10. /etc/${appname}/config

做了个 demo， 直观一点


 
 
  1. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     var conf = 
     
     require(
     
     'rc')(
     
     'development', {
    
    
    
   
   
  2. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
       port: 
     
     3000,
    
    
    
   
   
  3. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     })
    
    
    
   
   
  4. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     console.log(JSON.stringify(conf))
    
    
    
   
   
  5. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  6. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 
     
     1、直接运行
    
    
    
   
   
  7. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // node index.js
    
    
    
   
   
  8. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // { port: 
     
     3000, 
     
     _: [] }
    
    
    
   
   
  9. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  10. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 
     
     2、加上命令行参数
    
    
    
   
   
  11. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // node index.js --port=
     
     4000 --database.user=root
    
    
    
   
   
  12. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // { port: 
     
     4000, 
     
     _: [], database: { user: 
     
     'root' } }
    
    
    
   
   
  13. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  14. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 
     
     3、加上环境变量
    
    
    
   
   
  15. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // development_port=
     
     5000 development_database__password=yfwzx2019 node index.js 
    
    
    
   
   
  16. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // {
     
     "port":
     
     "5000",
     
     "database":{
     
     "password":
     
     "yfwzx2019"},
     
     "_":[]}
    
    
    
   
   
  17. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  18. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 
     
     4、指定配置文件：根目录建一个配置文件 config.json， 内容如下
    
    
    
   
   
  19. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // {
    
    
    
   
   
  20. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     //   
     
     "port": 
     
     "6000"
    
    
    
   
   
  21. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // }
    
    
    
   
   
  22. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // node index.js --config=config.json
    
    
    
   
   
  23. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // {
     
     "port":
     
     "6000",
     
     "_":[],
     
     "config":
     
     "config.json",
     
     "configs":[
     
     "config.json"]}
    
    
    
   
   
  24. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  25. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 
     
     5、默认读取 ${appname}rc 文件：根目录见一个配置文件 .developmentrc 内容如下：
    
    
    
   
   
  26. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // {
    
    
    
   
   
  27. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     //   
     
     "port": 
     
     7000  
    
    
    
   
   
  28. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // }
    
    
    
   
   
  29. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // node index.js
    
    
    
   
   
  30. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // {
     
     "port":
     
     7000,
     
     "_":[],
     
     "configs":[
     
     ".developmentrc"],
     
     "config":
     
     ".developmentrc"}
    
    
    
   
   
  31. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  32. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 
     
     6、 
     
     5 和
     
     4 一起运行
    
    
    
   
   
  33. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // node index.js --config=config.json
    
    
    
   
   
  34. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // {
     
     "port":
     
     "6000",
     
     "_":[],
     
     "config":
     
     "config.json",
     
     "configs":[
     
     ".developmentrc",
     
     "config.json"]}

具体操作

看了 rc 模块，可以满足我们的需求，我们可以配置公共的配置项，也可以隐秘的覆盖我们的配置项。

  1. 创建配置文件目录，添加配置文件

 
 
  1. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     ├── 
     
     config
    
    
    
   
   
  2. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     │   ├── 
     
     .developmentrc
     
     .example
    
    
    
   
   
  3. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     │   ├── 
     
     .productionrc
    
    
    
   
   
  4. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     │   ├── 
     
     .testrc
    
    
    
   
   
  5. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     │   └── 
     
     index
     
     .js

其中 .developmentrc.example 是开发环境的例子，然后开发人员参考建 .developmentrc 文件， index.js 是配置入口文件，内容如下:


 
 
  1. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     let rc = 
     
     require(
     
     'rc')
    
    
    
   
   
  2. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  3. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     // 因为 rc 是从 process.cwd() 向上查找 .appnamerc 文件的，我们在根目录 config 文件夹里面的是找不到的，要改变工作路径到当前，再改回去
    
    
    
   
   
  4. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     var originCwd = process.cwd()
    
    
    
   
   
  5. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     process.chdir(__dirname)
    
    
    
   
   
  6. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     var conf = rc(process.env.NODE_ENV || 
     
     'production', {
    
    
    
   
   
  7. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
      
     
     // 默认的共同配置
    
    
    
   
   
  8. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
       origin: 
     
     'default',
    
    
    
   
   
  9. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
      
     
     baseUrl: 
     
     'http://google.com/api',
    
    
    
   
   
  10. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
      
     
     enableProxy: 
     
     true,
    
    
    
   
   
  11. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
      
     
     port: 
     
     3000,
    
    
    
   
   
  12. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
      
     
     database: {
    
    
    
   
   
  13. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
        
     
     user: 
     
     'root',
    
    
    
   
   
  14. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
        
     
     password: 
     
     'yfwzx2019'
    
    
    
   
   
  15. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
       }
    
    
    
   
   
  16. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     })
    
    
    
   
   
  17. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  18. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     process.chdir(originCwd)
    
    
    
   
   
  19. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
     
    
    
    
   
   
  20. 
   
   
    
    
    
    
   
   
    
   
   
    
    
    
    
     
     module.exports = conf
  1. 关于部署环境的不同，获取配置通过设置环境变量NODE_ENV来适配
  2. 关于开发环境的不同，在.gitignore添加config/.developmentrc，项目代码去掉开发环境配置.developmentrc，开发人员根据.developmentrc.example建直接的开发配置.developmentrc
  3. 关于安全地配置，通过添加环境变量覆盖默认值，可以安全隐秘地覆盖配置项，比如：
NODE_ENV=production node index.js --database.password=tencent2019

谢谢大家

            </div>
                                  </div>
                </div>
JiangXiaoBaiFa
关注
专栏目录
node.js - 安装、配置、基本使用、案例
LawssssCat的博客
02-07 825
https://www.bilibili.com/video/av86253852?p=3 文章目录whatwhyapi 接口js 运行环境nvm （node版本管理 bin）配置 npm 源 作用： 运行 js 文件操作 数据库操作 可以 但没必要，还是 交给 java把 what 基于 chrome V8 引擎 的 runtime 事件驱动 非阻塞的i/o npm 是全球最大.............................................
详解nodejs 配置文件处理方案
10-17
在Node.js项目开发中，配置文件的处理是一个重要的环节，它涉及到项目的部署、运行环境、安全性等多个方面。本篇文章将详细介绍Node.js配置文件处理的方案，包括配置文件的依赖环境、代码分离、易于使用等原则，并...
nodejs 配置文件处理方案
weixin_34255793的博客
01-01 1647
前言 一般来说：一个好的项目配置应该满足以下条件： 依赖环境：配置根据具体运行环境从相应的文件读取 代码分离：配置项不仅可以从配置文件读取， 也可以从环境变量读取，使得安全隐秘的配置项与代码分离 易于使用：配置项应该是分层配置的，有助于查找条目和维护庞大的配置文件的，应该是容易组织和容易获取的，比如json结构 在多人开发 no...
[nodejs] nodejs开发个人博客（二）入口文件
程序员老狼专注开发aigc或客服系统应用
03-06 209
错误处理中间件 定义错误处理中间件必须使用4个参数，否则会被作为普通中间件 /*错误处理器*/ application.use(function(err,req,res,next){ console.error(err.stack); res.status(500).send("代码出错了,错误信息:<br/>"+err.stack); }); /*...
nodejs用config库实现配置文件读取(详解)
最新发布
qq_43741689的博客
06-29 1031
比如我们在开发环境的时候，想要用develop.json来作为配置文件 在生产环境的时候，想要用product.json来作为配置文件 开发和生产环境所用的数据库可能是不同的配置，所以用到的配置信息不同，用不同的配置文件可以分开来配置 但是，如果想要让config库准确调用这些配置的话，需要在运行项目的时候，加上项目环境的命令 NODE_ENV=[envConfigName](envConfigName指的是我们自定义的配置文件的名字)
node.js的node_modules文件和文件夹中设置入口文件
dancheng1的博客
09-06 6223
如果在require命令中，这么写: //没有写./， 所以不是一个相对路径。是一个特殊的路径 var foo = require("foo.js"); 那么Node.js将该文件视为node_modules目录下的一个文件 node.js设置入口文件方法：在文件夹中新建一个package.json文件 { "name": "bar", "version": "0.
详解Windows下安装Nodejs步骤
10-19
下载完成后，打开安装文件，选择“Next”继续。 2. 安装Node.js：在安装向导中选择安装路径，推荐安装在C:\nodejs目录下。之后，继续点击“Next”直至安装完成。 3. 配置npm全局目录：npm是Node.js的包管理工具，...
vue-cli脚手架build目录下utils.js工具配置文件详解
12-12
此文章用来解释vue-cli脚手架build目录中的utils.js配置文件 1.此配置文件是vue开发环境的wepack相关配置文件，主要用来处理css-loader和vue-style-loader 2.关于注释 •当涉及到较复杂的解释我将通过标识的方式...
搭建简单的nodejs http服务器详解
10-20
如果服务器配置了相应的路由处理，也可以返回其他文件或内容。 服务器还可以配置一些特殊的URL用于测试或其他目的，比如'/test/delay'路径用于模拟缓慢的网络连接，服务器在返回响应前会先等待一段时间。在'/test/...
6.node中的配置文件
m0_46538873的博客
06-11 466
package.json 每一个项目都要有一个package.json 文件（包括描述文件，就像产品说明书一样） 这个文件可以通过npm init 自动初始化出来 D:\code\node中的模块系统>npm init This utility will walk you through creating a package.json file. It only covers the most common items, and tries to guess sensible defaults. S
前端（Electron Nodejs）如何读取本地配置文件
jmszl1991的博客
07-25 3895
electron\nodejs实现了一下读取本地文件的需求。
Vue中.env|.env.development|.env.production文件说明
Amelian的博客
04-17 3万+
0.介绍 模式是Vue CLI项目中一个重要的概念，默认情况下，一个Vue CLI项目有三种模式： developemt 模式用于vue-cli-service serve test 模式用于vue-cli-service test:unit production 模式用于vue-cli-service build 和vue-cli-service test:e2e 当运行vue-cli-service命令时，所有的环境变量都从对应的环境文件中载入。如果文件内部不包含NODE_ENV变量，它的值取决
Node.js中fs模块实现配置文件的读写
丶虎子oc
04-24 326
在Node.js中，`fs`模块提供了对文件系统的访问功能，我们可以利用它来实现配置文件的读取和写入操作。正好用到，就记录一下。
vite基本配置教程
夏天的博客
10-14 2万+
最近做项目要求将webpack打包方式换成vite，下面将详细讲解一下配置vite需要改动的东西，以及踩的坑。vite官网：https://vitejs.cn。
Node.js包之读取ini配置文件
二木成林
12-05 5084
node.js读取ini格式的文件
最新Node.js安装详细教程及node.js配置
热门推荐
Python基础详解教程，让编程变得简单！
08-21 13万+
文中主要讲述编译器、运行环境、开发环境的区别，Node.js与JavaScript、TypeScript，Node.js与浏览器，Windows、Linux、Mac的Node.js版本类型，VS Code安装程序的安装及安装选项设置，修改npm的包的全局的安装路径和缓存路径、配置镜像源(镜像站)、配置包管理工具，node.js的运行。
node安装及环境配置
qq_42249532的博客
02-18 1127
1)、找到刚才node的安装目录，并在该目录下新建两个文件夹，文件夹名称分别为：node_global和node_cache；在用户变量中点击新建，变量名为NODE_PATH，变量值为C:\Program Files\nodejs（node的路径）编辑用户变量中的path，将默认的AppData\Roaming\npm路径改为现在的node_global的路径。查看node的安装目录下的node_global中是否有node_modules文件夹，如果没有就手动新建一个。1、进入node官网下载安装包，
Node 中的 Process 的理解及常用方法
Silvia
06-03 1万+
一、是什么 process 对象是一个全局变量，提供了有关当前 Node.js进程的信息并对其进行控制，作为一个全局变量 我们都知道，进程计算机系统进行资源分配和调度的基本单位，是操作系统结构的基础，是线程的容器 当我们启动一个js文件，实际就是开启了一个服务进程，每个进程都拥有自己的独立空间地址、数据栈，像另一个进程无法访问当前进程的变量、数据结构，只有数据通信后，进程之间才可以数据共享 由于JavaScript是一个单线程语言，所以通过node xxx启动一个文件后，只有一条主线程 二、属性与方法 关.
NodeJS实现银联网关支付DEMO详解
"NodeJS整合银联网关支付DEMO，包括配置文件config.js和银联支付模块unionPay.js，涉及非对称加密、商户信息、证书路径等关键要素。" 在本文中，我们将深入探讨如何使用NodeJS整合银联网关支付。银联网关支付允许...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值