Webpack下多環境配置的思路

WilsonW發表於2018-06-26

Webpack

前言

由於前後端分離的前端應用脫離了後端的支援,在單獨開發前端應用時,頁面除錯時使用固定的開發環境地址還好,如果出現在本地開發時需要除錯不同環境的遠端API,或者需要將應用部署到不同環境的伺服器上時,如果不將這些環境對應的伺服器地址、環境專屬變數等單獨配置,也許每次切換環境都需要修改大量程式碼。網上關於這部分的資料較少,所以下面將以用vue-cli init命令生成的Vue/Webpack專案作為例子,介紹一下我當前正在使用的簡單的多環境配置的思路。

1、理想中的多環境配置

在後端開發中,專案中不同環境對應的引數配置在不同的配置檔案中。當需要打包基於MavenJava專案時,通常只需要在打包命令的後面加上-P引數指定Profile環境,即可打包出對應環境的包,同理前端在使用webpack開發或者打包時如果也能這麼做,就會方便很多。

/* maven常用打包命令 */
mvn clean package -P prod
複製程式碼

而在前端專案中,除錯與打包命令vue-cli init已經為我們在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"
  }
複製程式碼

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

/* 改造後的命令,只是打個比方,實際並不一定是這樣 */
"scripts": {
    "start:dev": "npm run dev -P dev",
    "build:test": "node build/build.js -P test"
  }

/* 命令列 */
$ npm run start:dev  //本地除錯,開發環境
$ npm run build:test  //打包,測試環境
複製程式碼

所以首先需要解決的是如何把引數傳遞到除錯/打包的指令碼中。

注意:這裡想特別說明一下的是,vue-cli腳手架幫我們生成好了整個專案,而且也有對應webpack.dev.conf.jswebpack.prod.conf.js兩個分離的webpack配置檔案,但由於檔案的命名問題(dev.conf.js/prod.conf.js),很容易讓人誤以為這兩個檔案就是webpack針對不同環境的配置。但實際上這兩個檔案一個是用於本地除錯時的配置檔案,另一個是用於打包部署的配置檔案。除錯/打包兩種模式 與 環境(dev/test/pre/prod等)是可以相互組合的。理論上來講這兩個webpack的配置檔案我覺得應該叫webpack.debug.conf.jswebpack.build.conf.js會更貼切一點。

2、指令碼引數化

node.js中傳遞引數到指令碼中,有多種方法,例如使用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中的一個元件,可以通過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可以方便的獲取指定名稱的命令列引數,接下來就要看看如何利用這個引數實現多檔案配置。

3、引入環境變數

首先在Webpack的官網中已經有過簡單介紹如何配置環境變數的文件,具體參考Webpack Production。簡單的來說就是DefinePlugin外掛會將我們原始碼中所有出現的指定字串替換為我們提供的物件/字串,不同環境的配置檔案則放在/config目錄下。

/* /build/webpack.dev.conf.js: */
plugins: [
    new webpack.DefinePlugin({
      // 原始碼中所有 process.env 都會被替換為
      // '../config/dev.env'這個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"'
})
複製程式碼

顯然我們可以直接用這個外掛為我們的多環境變數服務。 我們可以通過上面傳入到指令碼中的環境引數,動態載入不同環境的配置檔案,以達到切換環境的目的。動態載入不同配置環境的程式碼:

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

// 獲取環境變數
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.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
    })
  ],
  ...
}
複製程式碼

然後除錯/打包的命令還是用回預設生成的命令,只不過在命令後面傳入環境引數:

/* /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",
  }
複製程式碼

我們的環境配置檔案中的內容可以是這樣的:

/* /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來獲取我們配置的環境變數的值,甚至可以單獨抽離一個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元件中就可以很方便的使用這些環境配置了:

/* /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、總結

整個流程下來,我們新增了一個webpack.env.conf.js模組,稍微小修改了一下vue-cli生成的3個webpack配置檔案,並在config目錄下新增了各個環境的配置檔案,專案的結構是這樣子的:

目錄結構
最終在頁面上看到的是這樣子的:
輸出環境引數

相關文章