Vue 学习笔记(二十六):Vue CLI 环境变量和模式

Modes and Environment Variables
环境变量和模式

环境变量

项目根目录中的下列文件,被载入的变量将会对 vue-cli-service 的所有命令、插件和依赖可用

1
2
3
4
.env # 在所有的环境中被载入
.env.local # 在所有的环境中被载入,但会被 git 忽略
.env.[mode] # 只在指定的模式中被载入
.env.[mode].local # 只在指定的模式中被载入,但会被 git 忽略

为一个特定模式准备的环境文件 (例如 .env.production) 将会比一般的环境文件 (例如 .env) 拥有更高的优先级。

此外,Vue CLI 启动时已经存在的环境变量拥有最高优先级,并不会被 .env 文件覆写。

NODE_ENV

如果在环境中有默认的 NODE_ENV,你应该移除它或在运行 vue-cli-service 命令的时候明确地设置 NODE_ENV。

模式

Vue CLI 项目有三个模式:

  • development 模式:用于 vue-cli-service serve
  • production 模式:用于 vue-cli-service build 和 vue-cli-service test:e2e
  • test 模式:用于 vue-cli-service test:unit

模式不同于 NODE_ENV,一个模式可以包含多个环境变量。也就是说,每个模式都会将 NODE_ENV 的值设置为模式的名称——比如在 development 模式下 NODE_ENV 的值会被设置为 “development”。

可以通过为 .env 文件增加后缀来设置某个模式下特有的环境变量。
如在项目根目录创建一个 .env.development 文件,那么它声明的变量就只会在 development 模式下被载入。

可以通过传递 –mode 选项参数为命令行覆写默认的模式。例如在构建命令中使用开发环境变量,需要 package.json 脚本中加入:

1
"dev-build": "vue-cli-service build --mode development",

示例 Staging 模式

假设应用包含 .env 文件:

1
VUE_APP_TITLE=My App

包含 .env.staging 文件:

1
2
NODE_ENV=production
VUE_APP_TITLE=My App (staging)
  • vue-cli-service build 会加载可能存在的 .env.env.production.env.production.local 文件然后构建出生产环境应用;

  • vue-cli-service build --mode staging 会在 staging 模式下加载可能存在的 .env.env.staging.env.staging.local 文件然后构建出生产环境应用。

这两种情况下,根据 NODE_ENV,构建出的应用都是生产环境应用,但是在 staging 版本中,process.env.VUE_APP_TITLE 被覆写成了另一个值。

在客户端侧代码中使用环境变量

只有以 VUE_APP_ 开头的变量会被 webpack.DefinePlugin 静态嵌入到客户端侧的包中。应用的代码中可以这样访问它们:

1
console.log(process.env.VUE_APP_SECRET)

构建过程中,process.env.VUE_APP_SECRET 将会被相应的值所取代。在 VUE_APP_SECRET=secret 的情况下,它会被替换为 "secret"

除 VUEAPP* 变量之外,代码中始终可用的还有两个特殊的变量:

  • NODE_ENV - "development""production""test" 中的一个。具体的值取决于应用运行的模式。
  • BASE_URL - 和 vue.config.js 中的 publicPath 选项相符,即应用部署到的基础路径。

所有解析出来的环境变量都可以在 public/index.html 中使用。

可以在 vue.config.js 文件中计算环境变量。它们仍然需要以 VUE_APP_ 前缀开头。这可以用于版本信息:

1
2
3
4
5
process.env.VUE_APP_VERSION = require('./package.json').version
module.exports = {
// config
}

只在本地有效的变量

有的时候你可能有一些不应该提交到代码仓库中的变量,尤其是当你的项目托管在公共仓库时。这种情况下你应该使用一个 .env.local 文件取而代之。本地环境文件默认会被忽略,且出现在 .gitignore 中。

.local 也可以加在指定模式的环境文件上,比如 .env.development.local 将会在 development 模式下被载入,且被 git 忽略。