详解vue-cli4环境变量与分环境打包方法

2,802

此篇文章会先讲具体操作步骤,后面会介绍原理,如时间紧急只看第一部分即可

具体步骤(以测试环境模式为例)

修改package.json

在scripts里添加一行命令

"test":"vue-cli-service build --mode test"

添加.env.test文件

在项目根据经创建.env.test文件,内容:

NODE_ENV='production'  // 表明这是生产环境(需要打包)
VUE_APP_CURRENTMODE='test'  // 表明生产环境模式信息
VUE_APP_BASEURL='http://localhost:8080'  // 测试服务器地址

修改项目中的api接口文件,或者在自己建的config文件夹里修改,或者直接在跨域代理部分修改,根据个人喜好而定。(以api为例)

项目中一般会创建一个api.js来管理所有的接口URL,因在本地开发中是通过代理来连接服务器的,所以可将url写成:

`${baseUrl}/api/getUserInfo`

文件开头通过环境变量改变baseUrl

let baseUrl = ''
if (process.env.NODE_ENV === 'development') { // 开发
  baseUrl = ''
} else if (process.env.NODE_ENV === 'production' && process.env.VUE_APP_CURRENTMODE === 'test') { // 测试
  baseUrl = process.env.VUE_APP_BASEURL
} else { // 生产
  baseUrl = ''
}

打包

当需要在测试环境下进行测试时,运行指令打包

npm run test
or
cnpm run test

基本原理介绍

了解环境变量概念

我们可以在根目录的下列文件中指定环境变量:

.env  // 在所有的环境中被载入
.env.local  // 在所有的环境中被载入,但会被git忽略
.env.[mode]  // 只在指定的模式中被载入,上述例子属于此类型
.env.[mode].local  // 只在指定的模式中被载入,但会被git忽略

环境变量文件中只包含环境变量的“键=值”对:

NODE_ENV='production'  
VUE_APP_CURRENTMODE='test'  // 只有VUE_APP开头的环境变量可以在项目代码中直接使用

除了自定义的VUE_APP_*变量之外,还有两个在应用中始终可用的变量:

  • NODE_ENV - 会是 "development"、"production" 或 "test"中的一个。具体的值取决于应用运行的模式。
  • BASE_URL - 会和 vue.config.js 中的 publicPath 选项相符,即你的应用会部署到的基础路径。 为一个特定模式准备的环境文件 (例如 .env.production) 将会比一般的环境文件 (例如 .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 脚本中加入:
"dev-build": "vue-cli-service build --mode development",

环境变量的使用

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

console.log(process.env.VUE_APP_SECRET)

理解指令,模式,环境变量之间的关系

我们在package.json中经常看到这样的指令:


  "scripts": {
    "serve": "vue-cli-service serve",
    "test": "vue-cli-service build --mode test",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint",
    "test:e2e": "vue-cli-service test:e2e",
    "test:unit": "vue-cli-service test:unit"
  },

在一个 Vue CLI 项目中,@vue/cli-service 安装了一个名为 vue-cli-service 的命令。你可以在 npm scripts 中以 vue-cli-service,或者从终端中以 ./node_modules/.bin/vue-cli-service 访问这个命令。

vue-cli-service serve 用法:vue-cli-service serve [options] [entry] 选项: --open 在服务器启动时打开浏览器 --copy 在服务器启动时将 URL 复制到剪切版 --mode 指定环境模式 (默认值:development) --host 指定 host (默认值:0.0.0.0) --port 指定 port (默认值:8080) --https 使用 https (默认值:false)

vue-cli-service build 用法:vue-cli-service build [options] [entry|pattern] 选项: --mode 指定环境模式 (默认值:production) --dest 指定输出目录 (默认值:dist) --modern 面向现代浏览器带自动回退地构建应用 --target app | lib | wc | wc-async (默认值:app) --name 库或 Web Components 模式下的名字 (默认值:package.json 中的 "name" 字段或入口文件名) --no-clean 在构建项目之前不清除目标目录 --report 生成 report.html 以帮助分析包内容 --report-json 生成 report.json 以帮助分析包内容 --watch 监听文件变化

以上是常用的cli指令,默认对应development和production模式,如需了解更多,请访问:Vue Cli 服务

你的赞是我前进的动力

求赞,求评论,求转发...