On this page

环境变量

History

环境变量是与 Node.js 进程运行环境相关联的变量。

有一组环境变量可以定义以自定义 Node.js 的行为， 更多详情请参阅 CLI 环境变量文档。

与环境变量交互的基本 API 是 process.env，它由一个对象组成 该对象预填充了用户环境变量，可以进行修改和扩展。

更多详情请参阅 process.env 文档。

稳定性：2 - 稳定

用于处理在 .env 文件中定义的额外环境变量的一组实用工具。

.env 文件（也称为 dotenv 文件）是定义环境变量的文件， Node.js 应用程序可以与这些变量交互（由 dotenv 包普及）。

以下是一个基本 .env 文件内容的示例：

MY_VAR_A = "my variable A"
MY_VAR_B = "my variable B"
text

这种类型的文件用于各种不同的编程语言和平台，但是 没有正式的规范，因此 Node.js 定义了自己的规范，如下所述。

.env 文件是包含键值对的文件，每对由一个变量名表示 后跟等号（=），再后跟一个变量值。

此类文件的名称通常是 .env 或以 .env 开头（例如 .env.dev，其中 dev 表示特定的目标环境）。这是推荐的命名方案，但不是 强制性的，dotenv 文件可以使用任何任意文件名。

有效的变量名必须仅包含字母（大写或小写）、数字和下划线 （_），并且不能以数字开头。

更具体地说，有效的变量名必须匹配以下正则表达式：

^[a-zA-Z_]+[a-zA-Z0-9_]*$

推荐的约定是使用大写字母，必要时使用下划线和数字， 但任何符合上述定义的变量名都可以正常工作。

例如，以下是一些有效的变量名：MY_VAR、MY_VAR_1、my_var、my_var_1、 myVar、My_Var123，而这些是无效的：1_VAR、'my-var'、"my var"、VAR_#1。

变量值由任意文本组成，可以选择包裹在 单引号（'）或双引号（"）内。

带引号的变量可以跨越多行，而不带引号的变量限制为单行。

注意，当被 Node.js 解析时，所有值都被解释为文本，这意味着任何值都将 在 Node.js 内部产生一个 JavaScript 字符串。例如，以下值：0、true 和 { "hello": "world" } 将产生字面字符串 '0'、'true' 和 '{ "hello": "world" }' 而不是数字零、布尔值 true 和分别具有 hello 属性的对象。

有效变量示例：

MY_SIMPLE_VAR = a simple single line variable
MY_EQUALS_VAR = "this variable contains an = sign!"
MY_HASH_VAR = 'this variable contains a # symbol!'
MY_MULTILINE_VAR = '
this is a multiline variable containing
two separate lines\nSorry, I meant three lines'
text

变量键和值周围的前导和尾随空白字符将被忽略，除非它们 被包裹在引号内。

例如：

   MY_VAR_A   =    my variable a
    MY_VAR_B   =    '   my variable b   '
text

将被视为与以下内容相同：

MY_VAR_A = my variable a
MY_VAR_B = '   my variable b   '
text

井号（#）字符表示注释的开始，意味着该行的其余部分 将被完全忽略。

然而，在引号内发现的井号被视为任何其他标准字符。

例如：

# 这是一条注释
MY_VAR = my variable # 这也是一条注释
MY_VAR_A = "# this is NOT a comment"
text

可以选择在变量声明前添加 export 关键字，该关键字将被完全忽略 由对该文件执行的所有处理。

这很有用，因此该文件可以在 shell 终端中无需修改即可被 source。

示例：

export MY_VAR = my variable

可以通过以下任一 CLI 选项使用 .env 文件填充 process.env 对象：

以下两个函数允许你直接与 .env 文件交互：