如何在Node.js中使用环境变量？

最新推荐文章于 2024-09-14 11:05:17 发布

JJCTO袁龙

最新推荐文章于 2024-09-14 11:05:17 发布

阅读量471

点赞数 5

分类专栏： Node.js 文章标签： node.js

本文链接：https://blog.csdn.net/yuanlong12178/article/details/140553803

版权

Node.js 专栏收录该内容

207 篇文章 5 订阅

订阅专栏

在现代Web开发中，我们常常需要使用环境变量来配置应用的行为，尤其是在Node.js应用中。环境变量的使用能够帮助我们在开发、测试和生产环境之间轻松切换配置，而不需要更改代码。本文将详细介绍如何在Node.js中使用环境变量，并通过示例代码帮助你更好地理解和应用这一技巧。

什么是环境变量？

环境变量是一种用于在操作系统和应用程序之间传递配置信息的方法。它们通常用于存储诸如数据库连接字符串、API密钥和配置标志等敏感或可变的信息。通过使用环境变量，我们可以轻松地在不同环境中管理配置，而不需要在代码中硬编码这些值。

在Node.js中使用环境变量

Node.js提供了一个全局的 process.env 对象，该对象包含了系统中的所有环境变量。我们可以通过 process.env 访问并使用这些环境变量。

设置环境变量

在不同的操作系统中，设置环境变量的方式有所不同。以下是一些常见的操作系统中的设置方法：

Unix/Linux/macOS

export NODE_ENV=production
export DATABASE_URL=postgres://user:password@localhost:5432/dbname

Windows

set NODE_ENV=production
set DATABASE_URL=postgres://user:password@localhost:5432/dbname

使用 `dotenv` 模块

虽然我们可以手动设置环境变量，但这在大型项目中可能会变得繁琐。使用 dotenv 模块可以简化这个过程。dotenv 模块允许我们将所有的环境变量存储在一个名为 .env 的文件中，并在应用启动时加载这些变量。

首先，我们需要安装 dotenv 模块：

npm install dotenv

然后，在项目根目录下创建一个 .env 文件，并在其中定义环境变量：

NODE_ENV=production
DATABASE_URL=postgres://user:password@localhost:5432/dbname
API_KEY=your_api_key_here

接下来，在我们的应用程序中加载并使用这些环境变量：

// app.js
require('dotenv').config();

 express = require('express');
const app = express();

const port = process.env.PORT || 3000;
const environment = process.env.NODE_ENV;
const databaseUrl = process.env.DATABASE_URL;
const apiKey = process.env.API_KEY;

app.get('/', (req, res) => {
  res.send(`Environment: ${environment}<br>Database URL: ${databaseUrl}<br>API Key: ${apiKey}`);
});

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

在上面的示例中，我们使用 require('dotenv').config() 导入并配置 dotenv 模块。这样，我们可以通过 process.env 访问 .env 文件中定义的所有环境变量。

使用跨平台的 `cross-env` 模块

有时候我们可能需要在不同平台上运行命令，并且希望这些命令能够跨平台地设置环境变量。cross-env 模块可以帮助我们实现这一点。

首先，我们需要安装 cross-env 模块：

npm install cross-env

然后，我们可以使用 cross-env 在 package.json 文件中的 scripts 部分设置环境变量：

{
  "scripts": {
    "start": "cross-env NODE_ENV=production node app.js",
    "test": "cross-env NODE_ENV=test jest"
  }
}

通过这种方式，我们可以确保无论是在Windows还是Unix系统上，环境变量都能被正确设置并使用。

在测试中使用环境变量

在开发和测试过程中，我们可能需要为每个环境配置不同的变量值。以下是如何在测试中设置和使用环境变量的示例：

// test/config.test.js
const { execSync } = require('child_process');
const assert = require('assert');

describe('Environment Variables', () => {
  it('should load environment variables correctly', () => {
    // 设置环境变量
    execSync('cross-env NODE_ENV=test DATABASE_URL=postgres://test:password@localhost:5432/testdb node -e "console.log(process.env.NODE_ENV)"');

    // 断言环境变量
    const nodeEnv = process.env.NODE_ENV;
    const databaseUrl = process.env.DATABASE_URL;

    assert.strictEqual(nodeEnv, 'test');
    assert.strictEqual(databaseUrl, 'postgres://test:password@localhost:5432/testdb');
  });
});