Node.js项目中关于env环境变量配置

桃扇骨 2023-01-15 08:10 390阅读 0赞

## 1、需求说明 ##

使用Node.js作为后端开发环境的话，无论是使用Express框架还是使用Koa框架，项目上线后，很多私密的信息都要使用生产环境的环境变量配置，例如数据库连接的用户名和密码等。

## 2、创建 .env文件 ##

.env文件是用来自定义配置的一个简单方法，可以将一些不能在代码中存储的敏感/账号数据从代码中剥离出来，作为环境变量存储在环境中。

在项目的根目录下创建 .env文件，在Windows系统中创建文件时会提示需要输入文件名，可以在此目录处启动命令行工具，输入下面的命令来创建：

type nul>.env

然后按回车，就可以创建一个 .env 的文件了。.env文件中编写项目中的敏感信息，例如数据库的连接信息，示例如下：

DB_HOST=127.0.0.1  
    DB_NAME=jd
    DB_PORT=27017
    DB_USER=admin
    DB_PWD=123456

DB\_HOST为数据库主机地址，DB\_NAME为数据库名称，DB\_PORT为数据库的端口号，DB\_USER为数据库用户名，DB\_PWD为数据库密码

## 3、安装 dotenv ##

在生产环境下安装 dotenv 插件，执行如下命令：

cnpm i dotenv --save

我们可以在写个测试文件，例如 text.js文件，来看一下 dotenv是否可以获取.env环境变量配置文件的内容，示例代码如下：

let dotenv =  require('dotenv');
    dotenv.config('./env');
    console.log(process.env);

使用 `node test.js` 命令运行测试文件，会在控制台打印下面的内容：

{
        DB_HOST:  '127.0.0.1',
        DB_NAME:  'jd',
        DB_PORT:  '27017',
        DB_USER:  'admin',
        DB_PWD:  '123456'
    }

## 4、在项目中配置 ##

在项目中创建 db.config.js 文件（文件名可以自定义），获取环境变量的配置信息，示例代码如下：

require('dotenv').config('./env')
    
    const {  DB_HOST, DB_NAME, DB_PORT, DB_USER, DB_PWD } = process.env
    
    module.exports = { 
    	host: DB_HOST,
    	database: DB_NAME,
    	username: DB_USER,
    	password: DB_PWD,
    	port: DB_PORT
    }

然后再创建用于连接MongoDB数据库的配置文件 dbconnect.js，示例代码如下：

然后将文件在app.js入口文件中引入，示例代码如下：

var dbConnect = require('./dbconnect');
    dbConnect()

到此，生产环境下的env环境变量配置就完成了。