NODE_ENV 是使用 Node.js 常去设置的环境变量,不过它其实并不是 Node.js 本身会去使用到的环境变量,而是这个生态系约定俗成的用法。在 Linux、macOS 等 Unix-like 的操作系统环境下,要设置程序的环境变量的值,只要在运行指令的前面加上 变量=值 并用空格隔开即可,但在如 Windows 等其它操作系统,指令就不支持这样的语法。

例如我们要运行 Node.js 的应用程序,通常会透过 npm 的 npm start 指令来运行。在生产环境下(production),经常将指令写成 NODE_ENV=production npm start,来设置进程(process)的 NODE_ENV 环境变量的值为 production;在开发环境下(development),则是经常将指令写成 NODE_ENV=development npm run ...;同样地,在跑测试的时候,则是经常将指令写成 NODE_ENV=test npm test。不过每次下指令都要去设置 NODE_ENV 环境变量实属麻烦了点,所以 package.json 文件可能会写成像是以下这样:

{
    ...

    "scripts": {
        "start": "NODE_ENV=production node ...",
        "start:dev": "NODE_ENV=development node ...",
        "test": "NODE_ENV=test mocha ...",
    },

    ...
}

不过写成上面这样的 package.json 文件到 Windows 操作系统中使用就会出问题了。如下图:

在 Windows 运行 NODE_ENV 指令的错误

这是因为在 Windows 上,若要在指令中设置环境变量,要使用 set 指令来协助完成。像是以下这样:

set NODE_ENV=production && node index.js

在 Windows 以 set 设置 NODE_ENV

但是写成以上这样,反而会变成 Unix-like 的操作系统会有问题。如下图:

Unix-like 系统运行 set 指令的问题

实际上,这个问题有个流行的解法是使用 cross-env 这个套件,不过这个套件并不是专为设置 NODE_ENV 环境变量而设计。它基于 cross-spawn 套件,把指令的所有参数包含环境变量的设置都去做跨平台处理。如果只是拿来设置 NODE_ENV 环境变量,就有点大材小用的感觉,实在没必要加了一堆代码只为了要设置 NODE_ENV 环境变量。此外,这两个套件的作者(不同作者)都已经不更新了,还是少用为妙。

Run with NODE_ENV

「Run with NODE_ENV」是笔者开发的套件,可以用来在任意平台上设置 NODE_ENV 环境变量。

npmjs.com

npm 安装指令

npm install run-with-node-env

使用方法

用法非常简单,就像以下这样:

run-with-node-env production npm start          # NODE_ENV=production  npm start
run-with-node-env development npm run start:dev # NODE_ENV=development npm run start:dev

以上面的 package.json 文件作为例子,在使用 npm i run-with-node-env 安装套件后,将 package.json 文件改写成这样:

{
    ...

    "scripts": {
        "start": "run-with-node-env production node ...",
        "start:dev": "run-with-node-env development node ...",
        "test": "run-with-node-env test mocha ...",
    },

    ...
}