前言
由于前后端分离的前端应用脱离了后端的支持,在单独开发前端应用时,页面调试时使用固定的开发环境地址还好,如果出现在本地开发时需要调试不同环境的远端API,或者需要将应用部署到不同环境的服务器上时,如果不将这些环境对应的服务器地址、环境专属变量等单独配置,也许每次切换环境都需要修改大量代码。网上关于这部分的资料较少,所以下面将以用vue-cli init
命令生成的Vue/Webpack
项目作为例子,介绍一下我当前正在使用的简单的多环境配置的思路。
1、理想中的多环境配置
在后端开发中,项目中不同环境对应的参数配置在不同的配置文件中。当需要打包基于Maven的Java项目时,通常只需要在打包命令的后面加上-P参数指定Profile环境,即可打包出对应环境的包,同理前端在使用webpack开发或者打包时如果也能这么做,就会方便很多。
而在前端项目中,调试与打包命令vue-cli init
已经为我们在package.json
中生成好了。
如果可以将这些命令改造成后端中类似的打包命令,就很方便了,例如:
$ npm run start:dev //本地调试,开发环境
$ npm run build:test //打包,测试环境
所以首先需要解决的是如何把参数传递到调试/打包的脚本中。
注意:
这里想特别说明一下的是,vue-cli
脚手架帮我们生成好了整个项目,而且也有对应webpack.dev.conf.js
和webpack.prod.conf.js
两个分离的webpack配置文件,但由于文件的命名问题(dev.conf.js/prod.conf.js
),很容易让人误以为这两个文件就是webpack针对不同环境的配置。但实际上这两个文件一个是用于本地调试时的配置文件,另一个是用于打包部署的配置文件。调试/打包两种模式 与 环境(dev/test/pre/prod
等)是可以相互组合的。理论上来讲这两个webpack的配置文件我觉得应该叫webpack.debug.conf.js
和webpack.build.conf.js
会更贴切一点。
2、脚本参数化
在node.js
中传递参数到脚本中,有多种方法,例如使用process.argv
:
$ node ./hello.js tidus
//process.argv = ['node','./hello.js','tidus']
hello tidus
虽然process.argv很方便,但可配置性不高,所以这里用的是yargs,它是node.js中的一个组件,可以通过npm直接安装。 ===>戳我查看yargs的api文档
const argv = require('yargs').argv;
console.log('hello ',argv.env);
/ 命令行 /
$ node ./hello.js --env test
hello test
通过yargs可以方便的获取指定名称的命令行参数,接下来就要看看如何利用这个参数实现多文件配置。
3、引入环境变量
首先在Webpack
的官网中已经有过简单介绍如何配置环境变量的文档,具体参考Webpack Production。简单的来说就是DefinePlugin
插件会将我们源码中所有出现的指定字符串替换为我们提供的对象/字符串,不同环境的配置文件则放在/config
目录下。
'use strict'
const merge = require('webpack-merge')
const prodEnv = require('./prod.env')
module.exports = merge(prodEnv,{
NODE_ENV: '"development"'
})
显然我们可以直接用这个插件为我们的多环境变量服务。
我们可以通过上面传入到脚本中的环境参数,动态加载不同环境的配置文件,以达到切换环境的目的。动态加载不同配置环境的代码:
const env = argv.e;
process.stdout.write('the env is '+ env +'\n');
// require指定的环境配置文件
const envConfigFile = "../config/" + env + ".env.js";
process.stdout.write('the env config file is '+ envConfigFile +'\n');
// 将require的配置文件原封不动export回出去
module.exports = require(envConfigFile);
接下来要将动态加载的环境文件丢到webpack的配置文件中,由于webpack.dev.conf.js
和webpack.prod.conf.js
都是继承自webpack.base.conf.js
,所以我们直接改写wepack.base.conf.js
的插件配置部分,直接添加DefinePlugin
插件的配置,并去掉原配置文件该插件的配置:
const envConfig = require('./webpack.env.conf')
module.exports = {
...,// 配置DefinePlugin插件
plugins: [
// http://vuejs.github.io/vue-loader/en/workflow/production.html
new webpack.DefinePlugin({
'process.env': envConfig
})
],...
}
然后调试/打包的命令还是用回默认生成的命令,只不过在命令后面传入环境参数:
然后我们就可以在源码中使用process.env.NODE_ENV来获取我们配置的环境变量的值,甚至可以单独抽离一个api模块:
api1:
${API_HOST}/path/to/api1
,api2: ${API_HOST}/path/to/api2
}
最后,在我们的Vue组件中就可以很方便的使用这些环境配置了:
4、总结
整个流程下来,我们添加了一个webpack.env.conf.js模块,稍微小修改了一下vue-cli生成的3个webpack配置文件,并在config目录下添加了各个环境的配置文件,项目的结构是这样子的:
最终在页面上看到的是这样子的:
输出环境参数