Webpack下多環(huán)境配置的思路

前言

由于前后端分離的前端應(yīng)用脫離了后端的支持,在單獨(dú)開發(fā)前端應(yīng)用時(shí),頁面調(diào)試時(shí)使用固定的開發(fā)環(huán)境地址還好,如果出現(xiàn)在本地開發(fā)時(shí)需要調(diào)試不同環(huán)境的遠(yuǎn)端API明也,或者需要將應(yīng)用部署到不同環(huán)境的服務(wù)器上時(shí)宣虾,如果不將這些環(huán)境對(duì)應(yīng)的服務(wù)器地址、環(huán)境專屬變量等單獨(dú)配置温数,也許每次切換環(huán)境都需要修改大量代碼绣硝。網(wǎng)上關(guān)于這部分的資料較少,所以下面將以用vue-cli init命令生成的Vue/Webpack項(xiàng)目作為例子撑刺,介紹一下我當(dāng)前正在使用的簡(jiǎn)單的多環(huán)境配置的思路鹉胖。

1、理想中的多環(huán)境配置

在后端開發(fā)中够傍,項(xiàng)目中不同環(huán)境對(duì)應(yīng)的參數(shù)配置在不同的配置文件中甫菠。當(dāng)需要打包基于MavenJava項(xiàng)目時(shí),通常只需要在打包命令的后面加上-P參數(shù)指定Profile環(huán)境冕屯,即可打包出對(duì)應(yīng)環(huán)境的包寂诱,同理前端在使用webpack開發(fā)或者打包時(shí)如果也能這么做,就會(huì)方便很多安聘。

/* maven常用打包命令 */
mvn clean package -P prod

而在前端項(xiàng)目中痰洒,調(diào)試與打包命令vue-cli init已經(jīng)為我們?cè)?code>package.json中生成好了。

/* /package.json */
"scripts": {
    "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
    "start": "npm run dev",
    "lint": "eslint --ext .js,.vue src",
    "build": "node build/build.js"
  }

如果可以將這些命令改造成后端中類似的打包命令浴韭,就很方便了丘喻,例如:

/* 改造后的命令,只是打個(gè)比方念颈,實(shí)際并不一定是這樣 */
"scripts": {
    "start:dev": "npm run dev -P dev",
    "build:test": "node build/build.js -P test"
  }

/* 命令行 */
$ npm run start:dev  //本地調(diào)試泉粉,開發(fā)環(huán)境
$ npm run build:test  //打包,測(cè)試環(huán)境

所以首先需要解決的是如何把參數(shù)傳遞到調(diào)試/打包的腳本中榴芳。

注意:這里想特別說明一下的是嗡靡,vue-cli腳手架幫我們生成好了整個(gè)項(xiàng)目,而且也有對(duì)應(yīng)webpack.dev.conf.jswebpack.prod.conf.js兩個(gè)分離的webpack配置文件翠语,但由于文件的命名問題(dev.conf.js/prod.conf.js),很容易讓人誤以為這兩個(gè)文件就是webpack針對(duì)不同環(huán)境的配置财边。但實(shí)際上這兩個(gè)文件一個(gè)是用于本地調(diào)試時(shí)的配置文件肌括,另一個(gè)是用于打包部署的配置文件。調(diào)試/打包兩種模式 與 環(huán)境(dev/test/pre/prod等)是可以相互組合的酣难。理論上來講這兩個(gè)webpack的配置文件我覺得應(yīng)該叫webpack.debug.conf.jswebpack.build.conf.js會(huì)更貼切一點(diǎn)谍夭。

2、腳本參數(shù)化

node.js中傳遞參數(shù)到腳本中憨募,有多種方法紧索,例如使用process.argv

/* hello.js */
console.log('hello ', process.argv[2]);

/* 命令行 */
$ node ./hello.js tidus
//process.argv = ['node', './hello.js', 'tidus']
hello tidus

雖然process.argv很方便,但可配置性不高菜谣,所以這里用的是yargs珠漂,它是node.js中的一個(gè)組件晚缩,可以通過npm直接安裝。
===>戳我查看yargs的api文檔

$ npm install yargs --dev --save

/* hello.js */
const argv = require('yargs').argv;
console.log('hello ', argv.env);

/* 命令行 */
$ node ./hello.js --env test
hello test

通過yargs可以方便的獲取指定名稱的命令行參數(shù)媳危,接下來就要看看如何利用這個(gè)參數(shù)實(shí)現(xiàn)多文件配置荞彼。

3、引入環(huán)境變量

首先在Webpack的官網(wǎng)中已經(jīng)有過簡(jiǎn)單介紹如何配置環(huán)境變量的文檔待笑,具體參考Webpack Production鸣皂。簡(jiǎn)單的來說就是DefinePlugin插件會(huì)將我們?cè)创a中所有出現(xiàn)的指定字符串替換為我們提供的對(duì)象/字符串,不同環(huán)境的配置文件則放在/config目錄下暮蹂。

/* /build/webpack.dev.conf.js: */
plugins: [
    new webpack.DefinePlugin({
      // 源碼中所有 process.env 都會(huì)被替換為
      // '../config/dev.env'這個(gè)module export出來的東西
      '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"'
})

顯然我們可以直接用這個(gè)插件為我們的多環(huán)境變量服務(wù)寞缝。
我們可以通過上面?zhèn)魅氲侥_本中的環(huán)境參數(shù),動(dòng)態(tài)加載不同環(huán)境的配置文件仰泻,以達(dá)到切換環(huán)境的目的荆陆。動(dòng)態(tài)加載不同配置環(huán)境的代碼:

/* /build/webpack.env.conf.js */
// 定義參數(shù)配置
const argv = require('yargs').argv;

// 獲取環(huán)境變量
const env = argv.e;
process.stdout.write('the env is '+ env +'\n');

// require指定的環(huán)境配置文件
const envConfigFile = "../config/" + env + ".env.js";
process.stdout.write('the env config file is '+ envConfigFile +'\n');

// 將require的配置文件原封不動(dòng)export回出去
module.exports = require(envConfigFile);

接下來要將動(dòng)態(tài)加載的環(huán)境文件丟到webpack的配置文件中,由于webpack.dev.conf.jswebpack.prod.conf.js都是繼承自webpack.base.conf.js我纪,所以我們直接改寫wepack.base.conf.js的插件配置部分慎宾,直接添加DefinePlugin插件的配置,并去掉原配置文件該插件的配置:

/* /build/webpack.base.conf.js */

// 引入上面的webpack.env.conf模塊
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
    })
  ],
  ...
}

然后調(diào)試/打包的命令還是用回默認(rèn)生成的命令浅悉,只不過在命令后面?zhèn)魅氕h(huán)境參數(shù):

/* /package.json */
"scripts": {
    "start:dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js --e dev",
    "start:test": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js --e test",
    "start:pre": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js --e pre",
    "start:prod": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js --e prod",
    "build:dev": "node build/build.js --e dev",
    "build:test": "node build/build.js --e test",
    "build:pre": "node build/build.js --e pre",
    "build:prod": "node build/build.js --e prod",
  }

我們的環(huán)境配置文件中的內(nèi)容可以是這樣的:

/* /config/test.env.js */
'use strict'
const merge = require('webpack-merge')
const prodEnv = require('./prod.env')

module.exports = merge(prodEnv, {
  NODE_ENV: '"test"',
  API_HOST: '"http://test.xx.com:8080"'
})

然后我們就可以在源碼中使用process.env.NODE_ENV來獲取我們配置的環(huán)境變量的值趟据,甚至可以單獨(dú)抽離一個(gè)api模塊:

/* /src/api/index.js */
const API_HOST = process.env.API_HOST;

export default {
  api1: `${API_HOST}/path/to/api1`,
  api2: `${API_HOST}/path/to/api2`
}

最后,在我們的Vue組件中就可以很方便的使用這些環(huán)境配置了:

/* /src/components/HelloWorld.vue */
  import api from '@/api';
  data () {
      return {
        msg: 'Welcome to Your Vue.js App',
        env: process.env.NODE_ENV,
        api1: api.api1,
        api2: api.api2
      }
    }

4术健、總結(jié)

整個(gè)流程下來汹碱,我們添加了一個(gè)webpack.env.conf.js模塊,稍微小修改了一下vue-cli生成的3個(gè)webpack配置文件荞估,并在config目錄下添加了各個(gè)環(huán)境的配置文件咳促,項(xiàng)目的結(jié)構(gòu)是這樣子的:

目錄結(jié)構(gòu)

最終在頁面上看到的是這樣子的:
輸出環(huán)境參數(shù)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市勘伺,隨后出現(xiàn)的幾起案子跪腹,更是在濱河造成了極大的恐慌,老刑警劉巖飞醉,帶你破解...
    沈念sama閱讀 212,222評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件冲茸,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡缅帘,警方通過查閱死者的電腦和手機(jī)轴术,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,455評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來钦无,“玉大人逗栽,你說我怎么就攤上這事∈г荩” “怎么了彼宠?”我有些...
    開封第一講書人閱讀 157,720評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵鳄虱,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我兵志,道長(zhǎng)醇蝴,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,568評(píng)論 1 284
  • 正文 為了忘掉前任想罕,我火速辦了婚禮悠栓,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘按价。我一直安慰自己惭适,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,696評(píng)論 6 386
  • 文/花漫 我一把揭開白布楼镐。 她就那樣靜靜地躺著癞志,像睡著了一般。 火紅的嫁衣襯著肌膚如雪框产。 梳的紋絲不亂的頭發(fā)上凄杯,一...
    開封第一講書人閱讀 49,879評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音秉宿,去河邊找鬼戒突。 笑死,一個(gè)胖子當(dāng)著我的面吹牛描睦,可吹牛的內(nèi)容都是我干的膊存。 我是一名探鬼主播,決...
    沈念sama閱讀 39,028評(píng)論 3 409
  • 文/蒼蘭香墨 我猛地睜開眼忱叭,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼隔崎!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起韵丑,我...
    開封第一講書人閱讀 37,773評(píng)論 0 268
  • 序言:老撾萬榮一對(duì)情侶失蹤爵卒,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后撵彻,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體钓株,經(jīng)...
    沈念sama閱讀 44,220評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,550評(píng)論 2 327
  • 正文 我和宋清朗相戀三年千康,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了享幽。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片铲掐。...
    茶點(diǎn)故事閱讀 38,697評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡拾弃,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出摆霉,到底是詐尸還是另有隱情豪椿,我是刑警寧澤奔坟,帶...
    沈念sama閱讀 34,360評(píng)論 4 332
  • 正文 年R本政府宣布,位于F島的核電站搭盾,受9級(jí)特大地震影響咳秉,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜鸯隅,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,002評(píng)論 3 315
  • 文/蒙蒙 一澜建、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧蝌以,春花似錦炕舵、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,782評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至徊件,卻和暖如春奸攻,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背虱痕。 一陣腳步聲響...
    開封第一講書人閱讀 32,010評(píng)論 1 266
  • 我被黑心中介騙來泰國(guó)打工睹耐, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人皆疹。 一個(gè)月前我還...
    沈念sama閱讀 46,433評(píng)論 2 360
  • 正文 我出身青樓疏橄,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親略就。 傳聞我的和親對(duì)象是個(gè)殘疾皇子捎迫,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,587評(píng)論 2 350

推薦閱讀更多精彩內(nèi)容