最近在vue-cli生成的webpack模板專案的基礎上開發了一些專案，開發過程中遇到很多坑，並且需要改動build和config裡面一些相關的配置，查閱，學習，總結，分享。

一、配置檔案結構

本文主要分析開發（dev）和構建（build）兩個過程涉及到的檔案，以下是有關的配置檔案

├─build
│   ├─build.js
│   ├─check-versions.js
│   ├─dev-client.js
│   ├─dev-server.js
│   ├─utils.js
│   ├─vue-loader.conf.js
│   ├─webpack.base.conf.js
│   ├─webpack.dev.conf.js
│   ├─webpack.prod.conf.js
│   └─webpack.test.conf.js
├─config
│   ├─dev.env.js
│   ├─index.js
│   ├─prod.env.js
│   └─test.env.js
├─...
└─package.json
 

二、指令

首先看package.json裡面的scripts欄位，

"scripts": {
  "dev": "node build/dev-server.js",
  "build": "node build/build.js",
  "unit": "cross-env BABEL_ENV=test karma start test/unit/karma.conf.js --single-run",
  "lint": "eslint --ext .js,.vue src test/unit/specs test/e2e/specs"
 }

執行”npm run dev”的時候執行的是build/dev-server.js檔案，執行”npm run build”的時候執行的是build/build.js檔案，我們可以從這兩個檔案開始進行程式碼閱讀分析。

三、build資料夾

build/dev-server.js

執行”npm run dev”時候最先執行的build/dev-server.js檔案。該檔案主要完成下面幾件事情：

1. 檢查node和npm的版本
2. 引入相關外掛和配置
3. 建立express伺服器和webpack編譯器
4. 配置開發中間件（webpack-dev-middleware）和熱過載中介軟體（webpack-hot-middleware）
5. 掛載代理服務和中介軟體
6. 配置靜態資源
7. 啟動伺服器監聽特定埠（8080）
8. 自動開啟瀏覽器並開啟特定網址（localhost:8080）

說明： express伺服器提供靜態檔案服務，不過它還使用了http-proxy-middleware，一個http請求代理的中介軟體。前端開發過程中需要使用到後臺的API的話，可以通過配置proxyTable來將相應的後臺請求代理到專用的API伺服器。

詳情請看程式碼註釋：

// 檢查NodeJS和npm的版本
require('./check-versions')()

// 獲取配置
var config = require('../config')
// 如果Node的環境變數中沒有設定當前的環境（NODE_ENV），則使用config中的配置作為當前的環境
if (!process.env.NODE_ENV) {
  process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
}

// 一個可以呼叫預設軟體開啟網址、圖片、檔案等內容的外掛
// 這裡用它來呼叫預設瀏覽器開啟dev-server監聽的埠，例如：localhost:8080
var opn = require('opn')
var path = require('path')
var express = require('express')
var webpack = require('webpack')

// 一個express中介軟體，用於將http請求代理到其他伺服器
// 例：localhost:8080/api/xxx  -->  localhost:3000/api/xxx
// 這裡使用該外掛可以將前端開發中涉及到的請求代理到API伺服器上，方便與伺服器對接
var proxyMiddleware = require('http-proxy-middleware')

// 根據 Node 環境來引入相應的 webpack 配置
var webpackConfig = process.env.NODE_ENV === 'testing'
  ? require('./webpack.prod.conf')
  : require('./webpack.dev.conf')

// dev-server 監聽的埠，預設為config.dev.port設定的埠，即8080
var port = process.env.PORT || config.dev.port

// 用於判斷是否要自動開啟瀏覽器的布林變數，當配置檔案中沒有設定自動開啟瀏覽器的時候其值為 false
var autoOpenBrowser = !!config.dev.autoOpenBrowser

// 定義 HTTP 代理表，代理到 API 伺服器
var proxyTable = config.dev.proxyTable

// 建立1個 express 例項
var app = express()

// 根據webpack配置檔案建立Compiler物件
var compiler = webpack(webpackConfig)

// webpack-dev-middleware使用compiler物件來對相應的檔案進行編譯和繫結
// 編譯繫結後將得到的產物存放在記憶體中而沒有寫進磁碟
// 將這個中介軟體交給express使用之後即可訪問這些編譯後的產品檔案
var devMiddleware = require('webpack-dev-middleware')(compiler, {
  publicPath: webpackConfig.output.publicPath,
  quiet: true
})

// webpack-hot-middleware，用於實現熱過載功能的中介軟體
var hotMiddleware = require('webpack-hot-middleware')(compiler, {
  log: () => {}
})

// 當html-webpack-plugin提交之後通過熱過載中介軟體釋出過載動作使得頁面過載
compiler.plugin('compilation', function (compilation) {
  compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) {
    hotMiddleware.publish({ action: 'reload' })
    cb()
  })
})

// 將 proxyTable 中的代理請求配置掛在到express伺服器上
Object.keys(proxyTable).forEach(function (context) {
  var options = proxyTable[context]
  // 格式化options，例如將'www.example.com'變成{ target: 'www.example.com' }
  if (typeof options === 'string') {
    options = { target: options }
  }
  app.use(proxyMiddleware(options.filter || context, options))
})

// handle fallback for HTML5 history API
// 重定向不存在的URL，常用於SPA
app.use(require('connect-history-api-fallback')())

// serve webpack bundle output
// 使用webpack開發中間件
// 即將webpack編譯後輸出到記憶體中的檔案資源掛到express伺服器上
app.use(devMiddleware)

// enable hot-reload and state-preserving
// compilation error display
// 將熱過載中介軟體掛在到express伺服器上
app.use(hotMiddleware)

// serve pure static assets
// 靜態資源的路徑
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)

// 將靜態資源掛到express伺服器上
app.use(staticPath, express.static('./static'))

// 應用的地址資訊，例如：http://localhost:8080
var uri = 'http://localhost:' + port

// webpack開發中間件合法（valid）之後輸出提示語到控制檯，表明伺服器已啟動
devMiddleware.waitUntilValid(function () {
  console.log('> Listening at ' + uri + '\n')
})

// 啟動express伺服器並監聽相應的埠（8080）
module.exports = app.listen(port, function (err) {
  if (err) {
    console.log(err)
    return
  }

  // when env is testing, don't need open it
  // 如果符合自動開啟瀏覽器的條件，則通過opn外掛呼叫系統預設瀏覽器開啟對應的地址uri
  if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') {
    opn(uri)
  }
})

build/webpack.base.conf.js

從程式碼中看到，dev-server使用的webpack配置來自build/webpack.dev.conf.js檔案（測試環境下使用的是build/webpack.prod.conf.js，這裡暫時不考慮測試環境）。而build/webpack.dev.conf.js中又引用了webpack.base.conf.js，所以這裡我先分析webpack.base.conf.js。

webpack.base.conf.js主要完成了下面這些事情：

1. 配置webpack編譯入口
2. 配置webpack輸出路徑和命名規則
3. 配置模組resolve規則
4. 配置不同型別模組的處理規則

說明： 這個配置裡面只配置了.js、.vue、圖片、字型等幾類檔案的處理規則，如果需要處理其他檔案可以在module.rules裡面配置。

具體請看程式碼註釋：

var path = require('path')
var utils = require('./utils')
var config = require('../config')
var vueLoaderConfig = require('./vue-loader.conf')

// 給出正確的絕對路徑
function resolve (dir) {
  return path.join(__dirname, '..', dir)
}

module.exports = {
  // 配置webpack編譯入口
  entry: {
    app: './src/main.js'
  },

  // 配置webpack輸出路徑和命名規則
  output: {
    // webpack輸出的目標資料夾路徑（例如：/dist）
    path: config.build.assetsRoot,
    // webpack輸出bundle檔案命名格式
    filename: '[name].js',
    // webpack編譯輸出的釋出路徑
    publicPath: process.env.NODE_ENV === 'production'
      ? config.build.assetsPublicPath
      : config.dev.assetsPublicPath
  },

  // 配置模組resolve的規則
  resolve: {
    // 自動resolve的副檔名
    extensions: ['.js', '.vue', '.json'],
    // resolve模組的時候要搜尋的資料夾
    modules: [
      resolve('src'),
      resolve('node_modules')
    ],
    // 建立路徑別名，有了別名之後引用模組更方便，例如
    // import Vue from 'vue/dist/vue.common.js'可以寫成 import Vue from 'vue'
    alias: {
      'vue$': 'vue/dist/vue.common.js',
      'src': resolve('src'),
      'assets': resolve('src/assets'),
      'components': resolve('src/components')
    }
  },

  // 配置不同型別模組的處理規則
  module: {
    rules: [
      {// 對src和test資料夾下的.js和.vue檔案使用eslint-loader
        test: /\.(js|vue)$/,
        loader: 'eslint-loader',
        enforce: "pre",
        include: [resolve('src'), resolve('test')],
        options: {
          formatter: require('eslint-friendly-formatter')
        }
      },
      {// 對所有.vue檔案使用vue-loader
        test: /\.vue$/,
        loader: 'vue-loader',
        options: vueLoaderConfig
      },
      {// 對src和test資料夾下的.js檔案使用babel-loader
        test: /\.js$/,
        loader: 'babel-loader',
        include: [resolve('src'), resolve('test')]
      },
      {// 對圖片資原始檔使用url-loader，query.name指明瞭輸出的命名規則
        test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
        loader: 'url-loader',
        query: {
          limit: 10000,
          name: utils.assetsPath('img/[name].[hash:7].[ext]')
        }
      },
      {// 對字型資原始檔使用url-loader，query.name指明瞭輸出的命名規則
        test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
        loader: 'url-loader',
        query: {
          limit: 10000,
          name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
        }
      }
    ]
  }
}

build/webpack.dev.conf.js

接下來看webpack.dev.conf.js，這裡面在webpack.base.conf的基礎上增加完善了開發環境下面的配置，主要包括下面幾件事情：

1. 將hot-reload相關的程式碼新增到entry chunks
2. 合併基礎的webpack配置
3. 使用styleLoaders
4. 配置Source Maps
5. 配置webpack外掛

詳情請看程式碼註釋：

var utils = require('./utils')
var webpack = require('webpack')
var config = require('../config')

// 一個可以合併陣列和物件的外掛
var merge = require('webpack-merge')
var baseWebpackConfig = require('./webpack.base.conf')

// 一個用於生成HTML檔案並自動注入依賴檔案（link/script）的webpack外掛
var HtmlWebpackPlugin = require('html-webpack-plugin')

// 用於更友好地輸出webpack的警告、錯誤等資訊
var FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin')

// add hot-reload related code to entry chunks
Object.keys(baseWebpackConfig.entry).forEach(function (name) {
  baseWebpackConfig.entry[name] = ['./build/dev-client'].concat(baseWebpackConfig.entry[name])
})

// 合併基礎的webpack配置
module.exports = merge(baseWebpackConfig, {
  // 配置樣式檔案的處理規則，使用styleLoaders
  module: {
    rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
  },

  // 配置Source Maps。在開發中使用cheap-module-eval-source-map更快
  devtool: '#cheap-module-eval-source-map',

  // 配置webpack外掛
  plugins: [
    new webpack.DefinePlugin({
      'process.env': config.dev.env
    }),
    // https://github.com/glenjamin/webpack-hot-middleware#installation--usage
    new webpack.HotModuleReplacementPlugin(),
    // 後頁面中的報錯不會阻塞，但是會在編譯結束後報錯
    new webpack.NoEmitOnErrorsPlugin(),
    // https://github.com/ampedandwired/html-webpack-plugin
    new HtmlWebpackPlugin({
      filename: 'index.html',
      template: 'index.html',
      inject: true
    }),
    new FriendlyErrorsPlugin()
  ]
})

build/utils.js和build/vue-loader.conf.js

前面的webpack配置檔案中使用到了utils.js和vue-loader.conf.js這兩個檔案，utils主要完成下面3件事：

1. 配置靜態資源路徑
2. 生成cssLoaders用於載入.vue檔案中的樣式
3. 生成styleLoaders用於載入不在.vue檔案中的單獨存在的樣式檔案

vue-loader.conf則只配置了css載入器以及編譯css之後自動新增字首。詳情請看程式碼註釋（下面是vue-loader.conf的程式碼，utils程式碼裡面原有的註釋已經有相應說明這裡就不貼出來了）：

var utils = require('./utils')
var config = require('../config')
var isProduction = process.env.NODE_ENV === 'production'

module.exports = {
  // css載入器
  loaders: utils.cssLoaders({
    sourceMap: isProduction
      ? config.build.productionSourceMap
      : config.dev.cssSourceMap,
    extract: isProduction
  }),
  // 編譯css之後自動新增字首
  postcss: [
    require('autoprefixer')({
      browsers: ['last 2 versions']
    })
  ]
}

build/build.js

講完了開發環境下的配置，下面開始來看構建環境下的配置。執行”npm run build”的時候首先執行的是build/build.js檔案，build.js主要完成下面幾件事：

1. loading動畫
2. 刪除建立目標資料夾
3. webpack編譯
4. 輸出資訊

說明： webpack編譯之後會輸出到配置裡面指定的目標資料夾；刪除目標資料夾之後再建立是為了去除舊的內容，以免產生不可預測的影響。

詳情請看程式碼註釋：

// https://github.com/shelljs/shelljs
// 檢查NodeJS和npm的版本
require('./check-versions')()

process.env.NODE_ENV = 'production'

// Elegant terminal spinner
var ora = require('ora')
var path = require('path')

// 用於在控制檯輸出帶顏色字型的外掛
var chalk = require('chalk')

// 執行Unix命令列的外掛
var shell = require('shelljs')
var webpack = require('webpack')
var config = require('../config')
var webpackConfig = require('./webpack.prod.conf')

var spinner = ora('building for production...')
spinner.start() // 開啟loading動畫

// 輸出檔案的目標資料夾
var assetsPath = path.join(config.build.assetsRoot, config.build.assetsSubDirectory)

// 遞迴刪除舊的目標資料夾
shell.rm('-rf', assetsPath)

// 重新建立資料夾 
shell.mkdir('-p', assetsPath)
shell.config.silent = true
// 將static資料夾複製到輸出的目標資料夾
shell.cp('-R', 'static/*', assetsPath)
shell.config.silent = false

// webpack編譯
webpack(webpackConfig, function (err, stats) {
  spinner.stop() // 停止loading動畫
  if (err) throw err
  // 沒有出錯則輸出相關資訊
  process.stdout.write(stats.toString({
    colors: true,
    modules: false,
    children: false,
    chunks: false,
    chunkModules: false
  }) + '\n\n')

  console.log(chalk.cyan('  Build complete.\n'))
  console.log(chalk.yellow(
    '  Tip: built files are meant to be served over an HTTP server.\n' +
    '  Opening index.html over file:// won\'t work.\n'
  ))
})

build/webpack.prod.conf.js

構建的時候用到的webpack配置來自webpack.prod.conf.js，該配置同樣是在webpack.base.conf基礎上的進一步完善。主要完成下面幾件事情：

1. 合併基礎的webpack配置
2. 使用styleLoaders
3. 配置webpack的輸出
4. 配置webpack外掛
5. gzip模式下的webpack外掛配置
6. webpack-bundle分析

說明： webpack外掛裡面多了醜化壓縮程式碼以及抽離css檔案等外掛。

詳情請看程式碼：

var path = require('path')
var utils = require('./utils')
var webpack = require('webpack')
var config = require('../config')
var merge = require('webpack-merge')
var baseWebpackConfig = require('./webpack.base.conf')
var HtmlWebpackPlugin = require('html-webpack-plugin')

// 用於從webpack生成的bundle中提取文字到特定檔案中的外掛
// 可以抽取出css，js檔案將其與webpack輸出的bundle分離
var ExtractTextPlugin = require('extract-text-webpack-plugin')

var env = process.env.NODE_ENV === 'testing'
  ? require('../config/test.env')
  : config.build.env

// 合併基礎的webpack配置
var webpackConfig = merge(baseWebpackConfig, {
  module: {
    rules: utils.styleLoaders({
      sourceMap: config.build.productionSourceMap,
      extract: true
    })
  },
  devtool: config.build.productionSourceMap ? '#source-map' : false,
  // 配置webpack的輸出
  output: {
    // 編譯輸出目錄
    path: config.build.assetsRoot,
    // 編譯輸出檔名格式
    filename: utils.assetsPath('js/[name].[chunkhash].js'),
    // 沒有指定輸出名的檔案輸出的檔名格式
    chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')
  },

  // 配置webpack外掛
  plugins: [
    // http://vuejs.github.io/vue-loader/en/workflow/production.html
    new webpack.DefinePlugin({
      'process.env': env
    }),

    // 醜化壓縮程式碼
    new webpack.optimize.UglifyJsPlugin({
      compress: {
        warnings: false
      },
      sourceMap: true
    }),

    // 抽離css檔案
    new ExtractTextPlugin({
      filename: utils.assetsPath('css/[name].[contenthash].css')
    }),

    // generate dist index.html with correct asset hash for caching.
    // you can customize output by editing /index.html
    // see https://github.com/ampedandwired/html-webpack-plugin
    new HtmlWebpackPlugin({
      filename: process.env.NODE_ENV === 'testing'
        ? 'index.html'
        : config.build.index,
      template: 'index.html',
      inject: true,
      minify: {
        removeComments: true,
        collapseWhitespace: true,
        removeAttributeQuotes: true
        // more options:
        // https://github.com/kangax/html-minifier#options-quick-reference
      },
      // necessary to consistently work with multiple chunks via CommonsChunkPlugin
      chunksSortMode: 'dependency'
    }),

    // split vendor js into its own file
    new webpack.optimize.CommonsChunkPlugin({
      name: 'vendor',
      minChunks: function (module, count) {
        // any required modules inside node_modules are extracted to vendor
        return (
          module.resource &&
          /\.js$/.test(module.resource) &&
          module.resource.indexOf(
            path.join(__dirname, '../node_modules')
          ) === 0
        )
      }
    }),
    // extract webpack runtime and module manifest to its own file in order to
    // prevent vendor hash from being updated whenever app bundle is updated
    new webpack.optimize.CommonsChunkPlugin({
      name: 'manifest',
      chunks: ['vendor']
    })
  ]
})

// gzip模式下需要引入compression外掛進行壓縮
if (config.build.productionGzip) {
  var CompressionWebpackPlugin = require('compression-webpack-plugin')
  webpackConfig.plugins.push(
    new CompressionWebpackPlugin({
      asset: '[path].gz[query]',
      algorithm: 'gzip',
      test: new RegExp(
        '\\.(' +
        config.build.productionGzipExtensions.join('|') +
        ')$'
      ),
      threshold: 10240,
      minRatio: 0.8
    })
  )
}

if (config.build.bundleAnalyzerReport) {
  var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin
  webpackConfig.plugins.push(new BundleAnalyzerPlugin())
}

module.exports = webpackConfig

build/check-versions.js和build/dev-client.js

最後是build資料夾下面兩個比較簡單的檔案，dev-client.js似乎沒有使用到，程式碼也比較簡單，這裡不多講。check-version.js完成對node和npm的版本檢測，下面是其程式碼註釋：

// 用於在控制檯輸出帶顏色字型的外掛
var chalk = require('chalk')

// 語義化版本檢查外掛（The semantic version parser used by npm）
var semver = require('semver')

// 引入package.json
var packageConfig = require('../package.json')

// 開闢子程序執行指令cmd並返回結果
function exec (cmd) {
  return require('child_process').execSync(cmd).toString().trim()
}

// node和npm版本需求
var versionRequirements = [
  {
    name: 'node',
    currentVersion: semver.clean(process.version),
    versionRequirement: packageConfig.engines.node
  },
  {
    name: 'npm',
    currentVersion: exec('npm --version'),
    versionRequirement: packageConfig.engines.npm
  }
]

module.exports = function () {
  var warnings = []
  // 依次判斷版本是否符合要求
  for (var i = 0; i < versionRequirements.length; i++) {
    var mod = versionRequirements[i]
    if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {
      warnings.push(mod.name + ': ' +
        chalk.red(mod.currentVersion) + ' should be ' +
        chalk.green(mod.versionRequirement)
      )
    }
  }

  // 如果有警告則將其輸出到控制檯
  if (warnings.length) {
    console.log('')
    console.log(chalk.yellow('To use this template, you must update following to modules:'))
    console.log()
    for (var i = 0; i < warnings.length; i++) {
      var warning = warnings[i]
      console.log('  ' + warning)
    }
    console.log()
    process.exit(1)
  }
}

四、config資料夾

config/index.js

config資料夾下最主要的檔案就是index.js了，在這裡面描述了開發和構建兩種環境下的配置，前面的build資料夾下也有不少檔案引用了index.js裡面的配置。下面是程式碼註釋：

// see http://vuejs-templates.github.io/webpack for documentation.
var path = require('path')

module.exports = {
  // 構建產品時使用的配置
  build: {
    // webpack的編譯環境
    env: require('./prod.env'),
    // 編譯輸入的index.html檔案
    index: path.resolve(__dirname, '../dist/index.html'),
    // webpack輸出的目標資料夾路徑
    assetsRoot: path.resolve(__dirname, '../dist'),
    // webpack編譯輸出的二級資料夾
    assetsSubDirectory: 'static',
    // webpack編譯輸出的釋出路徑
    assetsPublicPath: '/',
    // 使用SourceMap
    productionSourceMap: true,
    // Gzip off by default as many popular static hosts such as
    // Surge or Netlify already gzip all static assets for you.
    // Before setting to `true`, make sure to:
    // npm install --save-dev compression-webpack-plugin
    // 預設不開啟開啟gzip模式
    productionGzip: false,
    // gzip模式下需要壓縮的檔案的副檔名
    productionGzipExtensions: ['js', 'css'],
    // Run the build command with an extra argument to
    // View the bundle analyzer report after build finishes:
    // `npm run build --report`
    // Set to `true` or `false` to always turn it on or off
    bundleAnalyzerReport: process.env.npm_config_report
  },
  // 開發過程中使用的配置
  dev: {
    // webpack的編譯環境
    env: require('./dev.env'),
    // dev-server監聽的埠
    port: 8080,
    // 啟動dev-server之後自動開啟瀏覽器
    autoOpenBrowser: true,
    // webpack編譯輸出的二級資料夾
    assetsSubDirectory: 'static',
    // webpack編譯輸出的釋出路徑
    assetsPublicPath: '/',
    // 請求代理表，在這裡可以配置特定的請求代理到對應的API介面
    // 例如將'/api/xxx'代理到'www.example.com/api/xxx'
    proxyTable: {},
    // CSS Sourcemaps off by default because relative paths are "buggy"
    // with this option, according to the CSS-Loader README
    // (https://github.com/webpack/css-loader#sourcemaps)
    // In our experience, they generally work as expected,
    // just be aware of this issue when enabling this option.
    // 是否開啟 cssSourceMap
    cssSourceMap: false
  }
}

config/dev.env.js、config/prod.env.js

簡單設定了環境變數

五、總結

所有的配置都是為高效開發服務的，瞭解了每一個配置，並且要對開發生態的每一個技術不斷學習，開發起來才能得心應手。