vue-cli3.0 环境变量与模式

vue-cli3.0移除了配置文件目录: config和build文件夹。可以说是非常的精简了,那移除了配置文件目录后如何自定义配置环境变量和模式呢?

为什么需要配置环境变量和模式呢?

所有方法肯定是来源于现实的需求。在一个产品的前端开发过程中,一般来说会经历本地开发、测试脚本、开发自测、测试环境、预上线环境,然后才能正式的发布。对应每一个环境可能都会有所差异,比如说服务器地址、接口地址、websorket地址…… 等等。在各个环境切换的时候,就需要不同的配置参数,所以就可以用环境变量和模式,来方便我们管理。

环境变量

cli-3.0总共提供了四种方式来制定环境变量:
  1. 在根目录添加.env文件,配置所有情况下都会用到的配置(不知道这个存在的意义,所有的都需要的也就不需要配置了吧)。
  2. 在根目录添加.env.local文件,配置所有情况下都会用到的配置,与.env的区别是只会在本地,该文件不会被git跟踪。
  3. 在根目录添加.env.[mode]文件,配置对应某个模式下的配置,比如:.env.development来配置开发环境的配置。
  4. 在根目录添加.env.[mode].local文件,配置对应某个模式下的配置,与.env.[mode]的区别也只是会在本地生效,该文件不会被git跟踪。
    环境变量文件(env.develoment文件)只包含环境变量的“键=值”对:
    例如:
FOO=bar
VUE_APP_SECRET=secret
环境变量的使用

除了 自定义的VUE_APP_* 变量之外,在你的应用代码中始终可用的还有两个特殊的变量:
NODE_ENV - 会是 “development”、“production” 或 “test”
中的一个。具体的值取决于应用运行的模式。
VUE_APP_BASEURL- 会和 vue.config.js 中的 publicPath 选项相符,即你的应用会部署到的基础路径。

设置完环境变量之后就可以在我们的项目中使用这这些变量了。不过还需要注意的是在项目的不同地方使用,限制也不一样。

1.在项目中,也就是src中使用环境变量的话,必须以VUE_APP_开头。例如我们可以在main.js中直接输出:console.log(process.env.VUE_APP_SECRET)
2.在webpack配置中使用,没什么限制,可以直接通过process.env.XXX来使用
3.特定模式准备的环境文件的 (例如 .env.production) 将会比一般的环境文件 (例如 .env) 拥有更高的优先级。
模式
模式是Vue CLI项目中的一个重要概念。默认情况下(就创建脚手架默认的情况),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”。
另外,如果你想要修改模式下默认的环境变量的话可以通过--mode来实现,可以通过为 .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经常能看见以下这样的指令


image.png

在一个 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模式 , 如果还想了解其他指令 , 可以访问: https://cli.vuejs.org/zh/guide/cli-service.html#cli-服务 CLI 服务

例如:

"dev": "webpack-dev-server --inline --progress --host 192.168.0.127 --config build/webpack.dev.conf.js ",

说完了概念,可能还是比较模糊,可以试着添加一个stage环境,用来模拟预上线。

结合实际应用1

首先在package.json添加一种类型,并修改默认环境变量为stage环境变量


微信图片_20210228113326.png

在根目录下创建.env.stage文件,来声明变量:


image.png
NODE.ENV = "production"
VUE_APP_CURRENTMODE = 'stage'// 表明生产环境模式信息
outputDir  = 'stage'//可以不设置
VUE_APP_BASEURL='http://***.****.com:8000' // 测试服务器地址

这里声明的NODE_ENV = ‘production’用来表示这是生产环境。VUE_APP_CURRENTMODE为 表明生产环境模式信息,outputDir为除数打包后文件的地址(默认cnpm run build 打包后的文件为dist)。

在vue.config.js中使用环境变量,制定输出文件为环境变量配置的文件:


image.png

最后执行命令yarn stage(yarn stage=== yarn run stage=== npm run stage)能看到根目录下生成了stage文件:


image.png

结合实际应用2

针对我们公司的项目来说,每个项目都设置了三种模式,分别为development、production和permission。我们都知道前两个是vue-cli项目中默认有的模式,那么permission模式便是我们在项目上自定义的,为什么要自定义这个模式呢?

作为非产品设计和开发人员,我们或许并不是很清楚这个模式产生的根本原因,那么我们先来看看项目上是怎么配置和应用这个模式,从而来了解它的作用。

首先在package.json添加一种类型,并修改默认环境变量为permission环境变量:

image.png

在根目录下创建.env.permission文件,来定义变量和值:


image.png

如上图所示,定义了一个.env.permission文件,并在该文件中设置VUE_APP_PERMISSION变量,并为其复制为true。( 在src文件夹下的任意文件中都可以关联到process.env.NODE_ENV环境变量)

然后找到该变量引用的地方,如下所示:


image.png

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


let baseUrl = '';
if (process.env.NODE_ENV == 'development') {
  baseUrl = "" 
} else if (process.env.NODE_ENV == 'production') {
  baseUrl = process.env.VUE_APP_BASEURL
} else {
  baseUrl = "" 

const service = axios.create({
  baseURL: process.env.VUE_APP_BASE_API,  // api的_url
  timeout: 50000, // request timeout
});
运用3开始创建一个用于打包测试环境的模式

修改package.json
添加一行命令

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

添加.env.test文件
在项目根路径创建.env.test文件,内容为

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

修改项目中的api接口文件
在我的项目中,一般会创建一个api.js 来管理所有的接口url
因为我们在本地开发环境中是通过代理来连接服务器的,所以将url写成这

`${baseUrl}/apis/v1/login`,

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

let baseUrl = '';
if (process.env.NODE_ENV == 'development') {
  baseUrl = "" 
} else if (process.env.NODE_ENV == 'production') {
  baseUrl = process.env.VUE_APP_BASEURL
} else {
  baseUrl = "" 
}

当需要为测试环境进行打包的时候 , 我们只需要运行下面指令进行打包

npm run test
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容