說明
本文代碼中的配置基于vue-cli2
需求
在實際開發中我們可能有測試環境一套請求API 和 正式環境一套API,尤其是兩個環境的域名不同時,就需要我們分環境打不同配置的包
了解 webpack.DefinePlugin 插件
DefinePlugin 此插件可以在打包時定義環境變量,在開發時我們也能在代碼中獲取定義的環境變量。
用法:
單獨配置
plugins: [
new webpack.DefinePlugin({
'process.env.mode': '"development"'
})
...
]
寫成對象
plugins: [
new webpack.DefinePlugin({
'process.env': {
NODE_ENV: '"development"',
EVN_CONFIG: '"dev"',
API_ROOT: '"dev API_ROOT"'
}
})
...
]
寫成配置文件
plugins: [
new webpack.DefinePlugin({
'process.env': require('../config/dev.env')
})
...
]
// /config/dev.env.js
'use strict'
const merge = require('webpack-merge')
const prodEnv = require('./prod.env')
module.exports = merge(prodEnv, {
NODE_ENV: '"development"',
EVN_CONFIG: '"dev"',
API_ROOT: '"dev API_ROOT"'
})
在vue-cli2 中/build/webpack.dev.conf.js
文件引用了 /config/dev.env.js
文件的配置作為環境變量,因此我們執行npm run dev
時(執行/build/webpack.dev.conf.js
)就可以在我們開發代碼中獲得環境變量(console.log(process.env)
試一試)
然后我們觀察/build/webpack.prod.conf.js
(npm run build時執行)
// /build/webpack.prod.conf.js
const env = require('../config/prod.env')
...
new webpack.DefinePlugin({
'process.env': env
}),
可見打包時使用的是/build/webpack.prod.conf.js
文件配置作為環境變量
安裝 cross-env
npm install --save-dev cross-env
cross-env 統一了不同操作系統設置環境變量的方式.
用法:
"scripts": {
"build": "node build/build.js",
"build:test": "cross-env NODE_ENV=production env_config=test node build/build.js", //設置了環境變量 NODE_ENV 和 env_config
"build:prod": "cross-env NODE_ENV=production env_config=prod node build/build.js", //設置了環境變量 NODE_ENV 和 env_config
}
開始配置
由上面分析,我們得到,要分環境打包,我們針對不同的環境去配置不同的環境變量就可以了。
我們先修改scripts腳本
// package.json
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",
"build": "node build/build.js",
"build:test": "cross-env NODE_ENV=production env_config=test node build/build.js",
"build:prod": "cross-env NODE_ENV=production env_config=prod node build/build.js"
},
我們設置了兩個環境變量 NODE_ENV
和 env_config
然后執行正常的打包。這里的環境變量設置是方便我們在webpack配置文件中使用
新建環境變量文件
新建 在/config
目錄下新建test.env.js
文件存放test的環境變量
// /config/test.env.js
'use strict'
module.exports = {
NODE_ENV: '"testing"',
EVN_CONFIG:'"test"',
API_ROOT:'"/test/apis/v1"'
}
修改 webpack.prod.config.js
我門注釋掉
//const env = require('../config/prod.env')
修改成
//const env = require('../config/prod.env')
const env_config = process.env.env_config || ''; //執行不同的打包腳本對應不同的env_config值
switch (env_config){
case 'test':
var env= require('../config/test.env');
break;
case 'prod':
var env= require('../config/prod.env');
break;
default:
var env= require('../config/prod.env');
}
...
在代碼中使用
// Home.vue
axios.get(process.env.API_ROOT) ...
在不同環境中使用CDN
webpack 提供一個非常有用的配置,該配置能幫助你為項目中的所有資源指定一個基礎路徑。它被稱為公共路徑(publicPath)
我們修改webpack中的 publicPath 來讓資源引用地址改為cdn
觀察vue-cli我門發現publicPath寫在了 /config/index.js
文件的build對象中,所以我們修改如下
...
const testCDN = 'https://testcdn.com';
const prodCDN = 'https://prodcdn.com';
build: {
assetsPublicPath: process.env.env_config=='test'?testCDN:prodCDN
}
也可以將cdn地址統一寫在上文中的環境配置文件中
var prodEnv = require('./prod.env');
var testEnv = require('./test.env');
...
build: {
assetsPublicPath: process.env.env_config=='test'?testEnv.FILE_CDN:prodEnv.FILE_CDN,
}
總結
整體思路就是建不同的打包腳本,然后根據不同的打包腳本,應用相應的環境變量配置文件