如何在 Node.js 中设置环境变量

现代软件需要灵活性、可扩展性和强大的安全性。 环境变量在实现这种平衡方面发挥着至关重要的作用。本指南探讨了在 Node.js 应用程序中设置和管理环境变量的各种方法，强调安全性和可维护性的最佳实践。 我们将涵盖从启动验证到防止敏感数据泄露的所有内容。 无论您是经验丰富的开发人员还是 Node.js 新手，这些信息对于构建安全、适应性强的应用程序都是至关重要的。

什么是环境变量？

环境变量是存储在应用程序代码库外部的键值对，通常位于配置文件或系统设置中。 它们保存 API 密钥和数据库凭据等敏感数据，防止硬编码并提高安全性。 这种方法简化了不同环境（开发、测试、生产）的管理。

在 Node.js 中，环境变量无需修改代码即可实现动态应用程序配置。相同的代码库可以根据环境与不同的数据库或API交互，增强安全性，简化部署，提高适应性。

与标准 JavaScript 变量不同，环境变量不在代码中定义。它们通过 process.env 访问并独立存在，可能影响系统上的多个应用程序。

访问 Node.js 中的环境变量

Node.js 使用 process.env 对象来访问和管理环境变量。 要检索变量的值，请使用 process.env.VARIABLE_NAME。例如，process.env.API_KEY 检索与 API_KEY 关联的值。 虽然技术上可以在代码中设置环境变量，但通常不鼓励这样做；它首先否定了使用环境变量的好处。

以下是 API_KEY 在 Express API 中的使用方式：

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

// Access API key from environment variables
const apiKey = process.env.API_KEY;

if (!apiKey) {
  console.error('Error: API key is not defined.');
  process.exit(1);
}

app.get('/', (req, res) => {
  res.send('API key successfully loaded.');
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

在 Node.js 中设置环境变量

现在，让我们探索设置环境变量的不同方法：

1. 使用 dotenv: dotenv 包通过将环境变量与代码分离来简化管理。 在 .env 文件中定义键值对：

<code>PORT=3000
DB_USERNAME=dbuser</code>

像这样导入并使用它：

import * as dotenv from 'dotenv';
dotenv.config();

console.log(process.env.PORT); // Output: 3000
console.log(process.env.DB_USERNAME); // Output: dbuser

您可以使用 .env 指定备用 dotenv.config({ path: './path/to/another.env' }) 文件路径。 虽然对开发有用，但请考虑其他生产方法。

2. 系统级设置： 在类 Unix 系统（Linux、macOS）上，将变量添加到 shell 配置文件（例如 ~/.bashrc、~/.zshrc）。 这会影响该 shell 会话中的所有进程。 例如：

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

// Access API key from environment variables
const apiKey = process.env.API_KEY;

if (!apiKey) {
  console.error('Error: API key is not defined.');
  process.exit(1);
}

app.get('/', (req, res) => {
  res.send('API key successfully loaded.');
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

重新启动终端或运行 source ~/.bashrc 以应用更改。 对于系统范围的访问（系统进程），请使用 /etc/environment.

3. 启动脚本： 创建一个设置变量的脚本，然后运行 ​​Node.js 应用程序（例如 launch.sh）：

<code>PORT=3000
DB_USERNAME=dbuser</code>

使其可执行（chmod x launch.sh）并运行它（./launch.sh）。

4. PM2（进程管理器2）： PM2 允许在应用程序启动期间设置环境变量：

import * as dotenv from 'dotenv';
dotenv.config();

console.log(process.env.PORT); // Output: 3000
console.log(process.env.DB_USERNAME); // Output: dbuser

或者使用 ecosystem.config.js 文件进行特定于环境的配置。

5. Docker: 在 Docker 中，使用 Dockerfile:ENV 设置
中的变量

# ~/.bashrc
export PORT=3000
export DB_USERNAME=myuser

使用 -e PORT=5173 或在 docker-compose.yml 文件中运行容器时覆盖默认值。

使用环境变量的最佳实践

遵循以下最佳实践来实现安全且可维护的应用程序：

• 描述性名称和文档：使用清晰的描述性名称并在项目的自述文件中记录其用途。

• 启动验证：在应用程序启动时验证环境变量以确保它们设置正确。 优雅地处理缺失的变量（默认值或错误处理）。

• .env 文件排除： 使用 .env 从版本控制 (Git) 中排除 .gitignore 文件。

• 考虑使用 KMS（密钥管理系统）：为了增强安全性，特别是对于高度敏感的数据，请使用 KMS 来加密和存储您的环境变量。

• 默认值：为非关键环境变量提供默认值，以确保应用程序功能，即使变量丢失也是如此。

• 切勿在前端暴露：切勿将敏感环境变量直接暴露给客户端代码。

店员对环境变量的使用

Clerk SDK 利用环境变量在 Clerk 仪表板中进行配置和应用程序关联。 这可以使用 Express 实现安全的后端请求和前端验证。 例如：

#!/bin/bash
export PORT=3000
export DB_USERNAME=myuser
node app.js

结论

安全管理环境变量至关重要。 通过遵循这些最佳实践，您将显着增强 Node.js 应用程序的安全性和可维护性，确保它们为生产部署做好准备。

以上是如何在 Node.js 中设置环境变量的详细内容。更多信息请关注PHP中文网其他相关文章！