Webpack下多环境配置的思路

前言

因为先后端分离的前端应用脱离了后端的支持，在单独开发前端应用时，页面调试时使用固定的开发环境地址还好，若是出如今本地开发时须要调试不一样环境的远端API，或者须要将应用部署到不一样环境的服务器上时，若是不将这些环境对应的服务器地址、环境专属变量等单独配置，也许每次切换环境都须要修改大量代码。网上关于这部分的资料较少，因此下面将以用vue-cli init命令生成的Vue/Webpack项目做为例子，介绍一下我当前正在使用的简单的多环境配置的思路。

一、理想中的多环境配置

在后端开发中，项目中不一样环境对应的参数配置在不一样的配置文件中。当须要打包基于Maven的Java项目时，一般只须要在打包命令的后面加上-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.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会更贴切一点。

二、脚本参数化

在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能够方便的获取指定名称的命令行参数，接下来就要看看如何利用这个参数实现多文件配置。

三、引入环境变量

首先在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.js和webpack.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
      }
    }
复制代码

四、总结

整个流程下来，咱们添加了一个webpack.env.conf.js模块，稍微小修改了一下vue-cli生成的3个webpack配置文件，并在config目录下添加了各个环境的配置文件，项目的结构是这样子的：

最终在页面上看到的是这样子的：