如何在 package.json 中正确使用环境变量？

Question

**问题：如何在 package.json 中正确使用环境变量？** 在使用 Node.js 项目时，我们经常希望通过 `package.json` 中的脚本传递或使用环境变量。然而，许多开发者在实际操作中会遇到变量未生效、格式错误或跨平台兼容性问题。例如，如何在 `scripts` 字段中正确引用环境变量？如何在不同操作系统中设置和使用这些变量？以及如何通过 `.env` 文件管理环境变量？本文将详解在 `package.json` 中定义和使用环境变量的最佳实践，帮助你避免常见误区，实现高效、可维护的脚本配置。

Answer 1

如何在 package.json 中正确使用环境变量？

1. 理解 package.json 中的脚本与环境变量

在 Node.js 项目中，package.json 的 scripts 字段用于定义命令行脚本。我们可以通过在脚本中引用环境变量来实现灵活配置。

例如：

{
  "scripts": {
    "start": "node app.js",
    "dev": "NODE_ENV=development node app.js"
  }
}

在这个例子中，NODE_ENV=development 是在运行 npm run dev 时设置的环境变量。

2. 跨平台环境变量设置问题

不同操作系统（如 Windows 和 Unix 系统）在设置环境变量时语法不同：

• Unix（Linux/macOS）：使用 = 分隔变量名和值
• Windows：使用 = 也可以，但通常使用 SET 命令

为了解决跨平台兼容性问题，可以使用 cross-env 工具：

{
  "scripts": {
    "dev": "cross-env NODE_ENV=development node app.js"
  }
}

安装依赖：

npm install cross-env --save-dev

3. 使用 .env 文件管理环境变量

为了便于管理环境变量，推荐使用 .env 文件配合 dotenv 模块。

示例 .env 文件内容：

NODE_ENV=development
PORT=3000
DATABASE_URL=mongodb://localhost:27017/mydb

在项目入口文件中加载：

require('dotenv').config();
console.log(process.env.DATABASE_URL); // mongodb://localhost:27017/mydb

这样可以避免将敏感信息硬编码在代码或脚本中。

4. 在 package.json 中引用环境变量的多种方式

可以在脚本中直接使用环境变量，也可以通过命令行传递：

方式	示例	说明
内联变量	NODE_ENV=production node app.js	适合临时使用
cross-env	cross-env NODE_ENV=production node app.js	跨平台兼容性好
dotenv	require('dotenv').config()	从 .env 文件读取变量

5. 常见误区与解决方案

以下是一些常见的误区和对应的解决办法：

• 变量未生效：确保变量在命令执行前设置，或使用 cross-env
• Windows 下语法错误：避免直接使用 NODE_ENV=development，改用 cross-env
• 环境变量暴露问题：不要将敏感信息提交到版本控制中，使用 .env 并添加到 .gitignore

6. 使用流程图展示环境变量加载流程

graph TD
    A[package.json scripts] --> B{是否使用 cross-env?}
    B -->|是| C[设置环境变量]
    B -->|否| D[尝试直接设置]
    C --> E[启动 Node 应用]
    D --> F[检查操作系统]
    F -->|Unix| G[变量生效]
    F -->|Windows| H[变量可能失败]
    G --> E
    H --> I[建议使用 cross-env]