在 PM2 中使用环境变量及其优化-JavaScript中文网-JavaScript教程资源分享门户

什么是 PM2？

PM2 是一个带有负载均衡功能的 Node.js 应用程序的进程管理器。它可以管理 Node.js 的应用程序，常常用于实现进程的守护、自动重启、监控等功能，是 Node.js 生态圈中非常流行的一个工具。

为什么要使用环境变量？

在实际的开发过程中，为了提高代码的可维护性和扩展性，我们通常会将一些配置信息抽离到配置文件中，例如数据库连接信息、API 接口地址、密钥等。但是，这样的做法有个缺点：当我们需要将应用程序部署到不同的环境中（如开发环境、测试环境、生产环境）时，每次都需要修改配置文件。

使用环境变量可以解决这个问题。通过在环境变量中设置对应的配置信息，我们可以在不同的环境中轻松切换，而无需修改配置文件。

如何在 PM2 中使用环境变量？

在 PM2 中使用环境变量非常简单，我们只需要在启动应用程序时，将环境变量传入即可。以下是具体的操作步骤：

1. 安装 dotenv

首先我们需要安装 dotenv，dotenv 可以帮助我们从 .env 文件中加载环境变量。在应用程序中使用 process.env 来读取环境变量时，dotenv 可以自动将 .env 文件中的变量注入到 process.env 中。

npm install dotenv

2. 创建 `.env` 文件

在应用程序根目录下创建一个 .env 文件，并在其中指定需要使用的环境变量。例如：

PORT=3000
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=password

3. 读取环境变量

在应用程序中使用 process.env 来读取环境变量。例如：

const port = process.env.PORT || 3000;
const db_host = process.env.DB_HOST || 'localhost';
const db_user = process.env.DB_USER || 'root';
const db_password = process.env.DB_PASSWORD || 'password';

注意：process.env 中的变量必须以大写字母命名，否则 dotenv 不能正确地加载变量。

4. 使用 PM2 启动应用程序

使用 PM2 启动应用程序时，将环境变量传入即可。例如：

pm2 start index.js --env production

--env production 会将环境变量 NODE_ENV 设置为 production，从而告诉应用程序当前运行的是生产环境。

优化环境变量

使用环境变量可以轻松切换不同的环境，但是在实际的开发过程中，可能会遇到一些问题，例如：

环境变量较多，难以管理
环境变量敏感信息难以保护

为了解决这些问题，我们可以对环境变量进行优化。

使用 `dotenv-safe` 对环境变量进行校验

dotenv-safe 是一个 dotenv 的扩展，可以帮助我们对环境变量进行校验，确保必须的环境变量存在，并且类型正确。例如：

const dotenv = require('dotenv-safe').config();

const port = process.env.PORT || 3000;
const db_host = process.env.DB_HOST || 'localhost';
const db_user = process.env.DB_USER || 'root';
const db_password = process.env.DB_PASSWORD || 'password';

假设我们的应用程序需要使用 PORT、DB_HOST、DB_USER、DB_PASSWORD 四个环境变量，那么使用 dotenv-safe 可以保证这四个环境变量都存在，并且类型正确（例如 PORT 必须是数字类型）。

使用 `config` 模块管理环境变量

config 是一个专门用于管理配置文件的模块，可以将配置信息抽象成一个 JavaScript 对象，通过修改配置文件来轻松地管理环境变量，而无需在应用程序中硬编码。

步骤如下：

1. 安装 `config` 模块和 `dotenv` 模块

npm install config dotenv

2. 创建 `config` 文件

在项目的根目录下创建一个名为 config 的文件夹，并在文件夹中创建三个文件：default.json、development.json 和 production.json。其中 default.json 是默认配置文件，development.json 和 production.json 是分别对应开发环境和生产环境的配置文件。

以 default.json 为例：

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "user": "root",
    "password": "password"
  }
}

3. 根据环境变量加载对应的配置文件

修改应用程序的 config/index.js 文件，根据 NODE_ENV 的值加载不同的配置文件，例如：

const config = require('config');

const port = config.get('port');
const db_host = config.get('db.host');
const db_user = config.get('db.user');
const db_password = config.get('db.password');

在生产环境中，可以通过 NODE_ENV 环境变量来指定当前的环境，例如：

NODE_ENV=production pm2 start index.js

通过使用 config 模块，我们可以轻松地管理环境变量，而无需在应用程序中硬编码。

总结

在实际的开发过程中，使用环境变量可以轻松地切换不同的环境，提高代码的可维护性和扩展性。而通过使用 dotenv-safe、config 等工具，我们可以更好地管理环境变量，提高代码的安全性和可靠性，值得开发者们深入学习和实践。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/651c0c7195b1f8cacd39fc20

在 PM2 中使用环境变量及其优化