寫在前面：作為 Vue 的使用者我們對于 vue-cli 都很熟悉，但是對它的 webpack 配置我們可能關注甚少，今天我們為大家帶來 vue-cli#2.0 的 webpack 配置分析
vue-cli 的簡介、安裝我們不在這里贅述，對它還不熟悉的同學可以直接訪問 vue-cli 查看
目錄結構：
?
.
├── README.md
├── build
│ ├── build.js
│ ├── check-versions.js
│ ├── dev-client.js
│ ├── dev-server.js
│ ├── utils.js
│ ├── webpack.base.conf.js
│ ├── webpack.dev.conf.js
│ └── webpack.prod.conf.js
├── config
│ ├── dev.env.js
│ ├── index.js
│ └── prod.env.js
├── index.html
├── package.json
├── src
│ ├── App.vue
│ ├── assets
│ │ └── logo.png
│ ├── components
│ │ └── Hello.vue
│ └── main.js
└── static
本篇文章的主要關注點在
- build – 編譯任務的代碼
- config – webpack 的配置文件
- package.json – 項目的基本信息
入口
從 package.json 中我們可以看到
"scripts": {"dev": "node build/dev-server.js","build": "node build/build.js","lint": "eslint --ext .js,.vue src"
}
當我們執行 npm run dev / npm run build 時運行的是 node build/dev-server.js 或 node build/build.js
dev-server.js
讓我們先從 build/dev-server.js 入手
require('./check-versions')() // 檢查 Node 和 npm 版本
var config = require('../config') // 獲取 config/index.js 的默認配置/*
** 如果 Node 的環境無法判斷當前是 dev / product 環境
** 使用 config.dev.env.NODE_ENV 作為當前的環境
*/if (!process.env.NODE_ENV) process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
var path = require('path') // 使用 NodeJS 自帶的文件路徑工具
var express = require('express') // 使用 express
var webpack = require('webpack') // 使用 webpack
var opn = require('opn') // 一個可以強制打開瀏覽器并跳轉到指定 url 的插件
var proxyMiddleware = require('http-proxy-middleware') // 使用 proxyTable
var webpackConfig = require('./webpack.dev.conf') // 使用 dev 環境的 webpack 配置/* 如果沒有指定運行端口，使用 config.dev.port 作為運行端口 */
var port = process.env.PORT || config.dev.port/* 使用 config.dev.proxyTable 的配置作為 proxyTable 的代理配置 */
/* 項目參考 https://github.com/chimurai/http-proxy-middleware */
var proxyTable = config.dev.proxyTable/* 使用 express 啟動一個服務 */
var app = express()
var compiler = webpack(webpackConfig) // 啟動 webpack 進行編譯/* 啟動 webpack-dev-middleware，將 編譯后的文件暫存到內存中 */
var devMiddleware = require('webpack-dev-middleware')(compiler, {publicPath: webpackConfig.output.publicPath,stats: {colors: true,chunks: false}
})/* 啟動 webpack-hot-middleware，也就是我們常說的 Hot-reload */
var hotMiddleware = require('webpack-hot-middleware')(compiler)/* 當 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]if (typeof options === 'string') {options = { target: options }}app.use(proxyMiddleware(context, options))
})// 使用 connect-history-api-fallback 匹配資源，如果不匹配就可以重定向到指定地址
app.use(require('connect-history-api-fallback')())// 將暫存到內存中的 webpack 編譯后的文件掛在到 express 服務上
app.use(devMiddleware)// 將 Hot-reload 掛在到 express 服務上并且輸出相關的狀態、錯誤
app.use(hotMiddleware)// 拼接 static 文件夾的靜態資源路徑
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 為靜態資源提供響應服務
app.use(staticPath, express.static('./static'))// 讓我們這個 express 服務監聽 port 的請求，并且將此服務作為 dev-server.js 的接口暴露
module.exports = app.listen(port, function (err) {if (err) {console.log(err)return}var uri = 'http://localhost:' + portconsole.log('Listening at ' + uri + '\n')// 如果不是測試環境，自動打開瀏覽器并跳到我們的開發地址if (process.env.NODE_ENV !== 'testing') {opn(uri)}
})
webpack.dev.conf.js
剛剛我們在 dev-server.js 中用到了 webpack.dev.conf.js 和 index.js，我們先來看一下 webpack.dev.conf.js
var config = require('../config') // 同樣的使用了 config/index.js
var webpack = require('webpack') // 使用 webpack
var merge = require('webpack-merge') // 使用 webpack 配置合并插件
var utils = require('./utils') // 使用一些小工具
var baseWebpackConfig = require('./webpack.base.conf') // 加載 webpack.base.conf
/* 使用 html-webpack-plugin 插件，這個插件可以幫我們自動生成 html 并且注入到 .html 文件中 */
var HtmlWebpackPlugin = require('html-webpack-plugin') // 將 Hol-reload 相對路徑添加到 webpack.base.conf 的 對應 entry 前
Object.keys(baseWebpackConfig.entry).forEach(function (name) {baseWebpackConfig.entry[name] = ['./build/dev-client'].concat(baseWebpackConfig.entry[name])
})/* 將我們 webpack.dev.conf.js 的配置和 webpack.base.conf.js 的配置合并 */
module.exports = merge(baseWebpackConfig, {module: {// 使用 styleLoadersloaders: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })},// 使用 #eval-source-map 模式作為開發工具，此配置可參考 DDFE 往期文章詳細了解devtool: '#eval-source-map',plugins: [/* definePlugin 接收字符串插入到代碼當中, 所以你需要的話可以寫上 JS 的字符串 */new webpack.DefinePlugin({'process.env': config.dev.env}),// 參考項目 https://github.com/glenjamin/webpack-hot-middleware#installation--usagenew webpack.optimize.OccurenceOrderPlugin(),/* HotModule 插件在頁面進行變更的時候只會重回對應的頁面模塊，不會重繪整個 html 文件 */new webpack.HotModuleReplacementPlugin(),/* 使用了 NoErrorsPlugin 后頁面中的報錯不會阻塞，但是會在編譯結束后報錯 */new webpack.NoErrorsPlugin(),// 參考項目 https://github.com/ampedandwired/html-webpack-plugin/* 將 index.html 作為入口，注入 html 代碼后生成 index.html文件 */new HtmlWebpackPlugin({filename: 'index.html',template: 'index.html',inject: true})]
})
webpack.base.conf.js
我們看到在 webpack.dev.conf.js 中又引入了 webpack.base.conf.js， 它看起來很重要的樣子，所以我們只能在下一章來看看 config/index.js 了?
var path = require('path') // 使用 NodeJS 自帶的文件路徑插件
var config = require('../config') // 引入 config/index.js
var utils = require('./utils') // 引入一些小工具
var projectRoot = path.resolve(__dirname, '../') // 拼接我們的工作區路徑為一個絕對路徑/* 將 NodeJS 環境作為我們的編譯環境 */
var env = process.env.NODE_ENV
/* 是否在 dev 環境下開啟 cssSourceMap ，在 config/index.js 中可配置 */
var cssSourceMapDev = (env === 'development' && config.dev.cssSourceMap)
/* 是否在 production 環境下開啟 cssSourceMap ，在 config/index.js 中可配置 */
var cssSourceMapProd = (env === 'production' && config.build.productionSourceMap)
/* 最終是否使用 cssSourceMap */
var useCssSourceMap = cssSourceMapDev || cssSourceMapProdmodule.exports = {entry: {app: './src/main.js' // 編譯文件入口},output: {path: config.build.assetsRoot, // 編譯輸出的靜態資源根路徑publicPath: process.env.NODE_ENV === 'production' ? config.build.assetsPublicPath : config.dev.assetsPublicPath, // 正式發布環境下編譯輸出的上線路徑的根路徑filename: '[name].js' // 編譯輸出的文件名},resolve: {// 自動補全的擴展名extensions: ['', '.js', '.vue'],// 不進行自動補全或處理的文件或者文件夾fallback: [path.join(__dirname, '../node_modules')],alias: {// 默認路徑代理，例如 import Vue from 'vue'，會自動到 'vue/dist/vue.common.js'中尋找'vue$': 'vue/dist/vue.common.js','src': path.resolve(__dirname, '../src'),'assets': path.resolve(__dirname, '../src/assets'),'components': path.resolve(__dirname, '../src/components')}},resolveLoader: {fallback: [path.join(__dirname, '../node_modules')]},module: {preLoaders: [// 預處理的文件及使用的 loader{test: /\.vue$/,loader: 'eslint',include: projectRoot,exclude: /node_modules/},{test: /\.js$/,loader: 'eslint',include: projectRoot,exclude: /node_modules/}],loaders: [// 需要處理的文件及使用的 loader{test: /\.vue$/,loader: 'vue'},{test: /\.js$/,loader: 'babel',include: projectRoot,exclude: /node_modules/},{test: /\.json$/,loader: 'json'},{test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,loader: 'url',query: {limit: 10000,name: utils.assetsPath('img/[name].[hash:7].[ext]')}},{test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,loader: 'url',query: {limit: 10000,name: utils.assetsPath('fonts/[name].[hash:7].[ext]')}}]},eslint: {// eslint 代碼檢查配置工具formatter: require('eslint-friendly-formatter')},vue: {// .vue 文件配置 loader 及工具 (autoprefixer)loaders: utils.cssLoaders({ sourceMap: useCssSourceMap }),postcss: [require('autoprefixer')({browsers: ['last 2 versions']})]}
}
config/index.js
終于分析完了 webpack.base.conf.js，來讓我們看一下 config/index.js
index.js 中有 dev 和 production 兩種環境的配置
var path = require('path')module.exports = {build: { // production 環境env: require('./prod.env'), // 使用 config/prod.env.js 中定義的編譯環境index: path.resolve(__dirname, '../dist/index.html'), // 編譯輸入的 index.html 文件assetsRoot: path.resolve(__dirname, '../dist'), // 編譯輸出的靜態資源路徑assetsSubDirectory: 'static', // 編譯輸出的二級目錄assetsPublicPath: '/', // 編譯發布的根目錄，可配置為資源服務器域名或 CDN 域名productionSourceMap: true, // 是否開啟 cssSourceMap// 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-pluginproductionGzip: false, // 是否開啟 gzipproductionGzipExtensions: ['js', 'css'] // 需要使用 gzip 壓縮的文件擴展名},dev: { // dev 環境env: require('./dev.env'), // 使用 config/dev.env.js 中定義的編譯環境port: 8080, // 運行測試頁面的端口assetsSubDirectory: 'static', // 編譯輸出的二級目錄assetsPublicPath: '/', // 編譯發布的根目錄，可配置為資源服務器域名或 CDN 域名proxyTable: {}, // 需要 proxyTable 代理的接口（可跨域）cssSourceMap: false // 是否開啟 cssSourceMap(因為一些 bug 此選項默認關閉，詳情可參考 https://github.com/webpack/css-loader#sourcemaps)}
}
至此，我們的 npm run dev 命令就講解完畢，下面讓我們來看一看執行 npm run build 命令時發生了什么 ～
build.js
require('./check-versions')() // 檢查 Node 和 npm 版本
require('shelljs/global') // 使用了 shelljs 插件，可以讓我們在 node 環境的 js 中使用 shell
env.NODE_ENV = 'production'var path = require('path') // 不再贅述
var config = require('../config') // 加載 config.js
var ora = require('ora') // 一個很好看的 loading 插件
var webpack = require('webpack') // 加載 webpack
var webpackConfig = require('./webpack.prod.conf') // 加載 webpack.prod.confconsole.log( // 輸出提示信息 ～ 提示用戶請在 http 服務下查看本頁面，否則為空白頁' Tip:\n' +' Built files are meant to be served over an HTTP server.\n' +' Opening index.html over file:// won\'t work.\n'
)var spinner = ora('building for production...') // 使用 ora 打印出 loading + log
spinner.start() // 開始 loading 動畫/* 拼接編譯輸出文件路徑 */
var assetsPath = path.join(config.build.assetsRoot, config.build.assetsSubDirectory)
/* 刪除這個文件夾 （遞歸刪除） */
rm('-rf', assetsPath)
/* 創建此文件夾 */
mkdir('-p', assetsPath)
/* 復制 static 文件夾到我們的編譯輸出目錄 */
cp('-R', 'static/*', assetsPath)// 開始 webpack 的編譯
webpack(webpackConfig, function (err, stats) {// 編譯成功的回調函數spinner.stop()if (err) throw errprocess.stdout.write(stats.toString({colors: true,modules: false,children: false,chunks: false,chunkModules: false}) + '\n')
})
webpack.prod.conf.js
var path = require('path')
var config = require('../config') // 加載 confi.index.js
var utils = require('./utils') // 使用一些小工具
var webpack = require('webpack') // 加載 webpack
var merge = require('webpack-merge') // 加載 webpack 配置合并工具
var baseWebpackConfig = require('./webpack.base.conf') // 加載 webpack.base.conf.js
/* 一個 webpack 擴展，可以提取一些代碼并且將它們和文件分離開 */
/* 如果我們想將 webpack 打包成一個文件 css js 分離開，那我們需要這個插件 */
var ExtractTextPlugin = require('extract-text-webpack-plugin')
/* 一個可以插入 html 并且創建新的 .html 文件的插件 */
var HtmlWebpackPlugin = require('html-webpack-plugin')
var env = config.build.env/* 合并 webpack.base.conf.js */
var webpackConfig = merge(baseWebpackConfig, {module: {/* 使用的 loader */loaders: utils.styleLoaders({ sourceMap: config.build.productionSourceMap, extract: true })},/* 是否使用 #source-map 開發工具，更多信息可以查看 DDFE 往期文章 */devtool: config.build.productionSourceMap ? '#source-map' : false,output: {/* 編譯輸出目錄 */path: config.build.assetsRoot,/* 編譯輸出文件名 */filename: utils.assetsPath('js/[name].[chunkhash].js'), // 我們可以在 hash 后加 :6 決定使用幾位 hash 值// 沒有指定輸出名的文件輸出的文件名chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')},vue: {/* 編譯 .vue 文件時使用的 loader */loaders: utils.cssLoaders({sourceMap: config.build.productionSourceMap,extract: true})},plugins: [/* 使用的插件 *//* definePlugin 接收字符串插入到代碼當中, 所以你需要的話可以寫上 JS 的字符串 */new webpack.DefinePlugin({'process.env': env}),/* 壓縮 js (同樣可以壓縮 css) */new webpack.optimize.UglifyJsPlugin({compress: {warnings: false}}),new webpack.optimize.OccurrenceOrderPlugin(),/* 將 css 文件分離出來 */new ExtractTextPlugin(utils.assetsPath('css/[name].[contenthash].css')),/* 構建要輸出的 index.html 文件， HtmlWebpackPlugin 可以生成一個 html 并且在其中插入你構建生成的資源 */new HtmlWebpackPlugin({filename: config.build.index, // 生成的 html 文件名template: 'index.html', // 使用的模板inject: true, // 是否注入 html (有多重注入方式，可以選擇注入的位置)minify: { // 壓縮的方式removeComments: true,collapseWhitespace: true,removeAttributeQuotes: true// 更多參數可查看 https://github.com/kangax/html-minifier#options-quick-reference},chunksSortMode: 'dependency'}),// 此處增加 @OYsun 童鞋補充// CommonsChunkPlugin用于生成在入口點之間共享的公共模塊（比如jquery，vue）的塊并將它們分成獨立的包。而為什么要new兩次這個插件，這是一個很經典的bug的解決方案，在webpack的一個issues有過深入的討論webpack/webpack#1315 .----為了將項目中的第三方依賴代碼抽離出來，官方文檔上推薦使用這個插件，當我們在項目里實際使用之后，發現一旦更改了 app.js 內的代碼，vendor.js 的 hash 也會改變，那么下次上線時，用戶仍然需要重新下載 vendor.js 與 app.jsnew webpack.optimize.CommonsChunkPlugin({name: 'vendor',minChunks: function (module, count) {// 依賴的 node_modules 文件會被提取到 vendor 中return (module.resource &&/\.js$/.test(module.resource) &&module.resource.indexOf(path.join(__dirname, '../node_modules')) === 0)}}),new webpack.optimize.CommonsChunkPlugin({name: 'manifest',chunks: ['vendor']})]
})/* 開啟 gzip 的情況下使用下方的配置 */
if (config.build.productionGzip) {/* 加載 compression-webpack-plugin 插件 */var CompressionWebpackPlugin = require('compression-webpack-plugin')/* 向webpackconfig.plugins中加入下方的插件 */webpackConfig.plugins.push(/* 使用 compression-webpack-plugin 插件進行壓縮 */new CompressionWebpackPlugin({asset: '[path].gz[query]',algorithm: 'gzip',test: new RegExp('\\.(' +config.build.productionGzipExtensions.join('|') +')$'),threshold: 10240,minRatio: 0.8}))
}module.exports = webpackConfig
總結
至此 ～ 我們的 vue-cli#2.0 webpack 配置分析文件就講解完畢 ～
對于一些插件的詳細 options 我們沒有進行講解，感興趣的同學可以去 npm 商店搜索對應插件查看 options ~
原文鏈接
https://github.com/DDFE/DDFE-blog/issues/10
?
