建站
咨詢
售后
建站咨詢
新聞中心
這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
vue-cli中webpack配置文件的示例分析
這篇文章主要為大家展示了“vue-cli中webpack配置文件的示例分析”，內容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“vue-cli中webpack配置文件的示例分析”這篇文章吧。
創(chuàng)新互聯(lián)堅持“要么做到，要么別承諾”的工作理念，服務領域包括：做網(wǎng)站、成都網(wǎng)站建設、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣等服務，滿足客戶于互聯(lián)網(wǎng)時代的保亭黎族網(wǎng)站設計、移動媒體設計的需求，幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡建設合作伙伴！
說明
此倉庫為vue-cli webpack的配置分析，其實只是在源碼中加上注釋而已。大家查看詳細分析，可以從后面提到的入口文件開始查看。
分析不包括check-versions.js文件，因為check-versions.js是檢測npm和node版本，不涉及webpack，所以就沒有對check-versions.js進行分析。同時，也不包括測試部分的代碼，該分析只是針對開發(fā)和生產環(huán)境的webpack配置進行分析。
vue-cli 版本
2.8.1
入口
從package.json可以看到開發(fā)和生產環(huán)境的入口。
"scripts": {
"dev": "node build/dev-server.js",
"build": "node build/build.js"
}開發(fā)環(huán)境
開發(fā)環(huán)境的入口文件是 build/dev-server.js。
dev-server.js
該文件中，使用express作為后端框架，結合一些關于webpack的中間件，搭建了一個開發(fā)環(huán)境。
// 配置文件
var config = require('../config')
// 如果 Node 的環(huán)境無法判斷當前是 dev / product 環(huán)境
// 使用 config.dev.env.NODE_ENV 作為當前的環(huán)境
if (!process.env.NODE_ENV) {
process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
}
// 可以強制打開瀏覽器并跳轉到指定 url 的插件
// https://github.com/sindresorhus/opn
var opn = require('opn')
// node自帶的文件路徑工具
var path = require('path')
// express框架
var express = require('express')
var webpack = require('webpack')
// 測試環(huán)境，使用的配置與生產環(huán)境的配置一樣
// 非測試環(huán)境，即為開發(fā)環(huán)境，因為此文件只有測試環(huán)境和開發(fā)環(huán)境使用
var proxyMiddleware = require('http-proxy-middleware')
var webpackConfig = process.env.NODE_ENV === 'testing'
// 生產環(huán)境配置文件
? require('./webpack.prod.conf')
// 開發(fā)環(huán)境配置文件
: require('./webpack.dev.conf')
// 端口號為命令行輸入的PORT參數(shù)或者配置文件中的默認值
var port = process.env.PORT || config.dev.port
// 配置文件中 是否自動打開瀏覽器
var autoOpenBrowser = !!config.dev.autoOpenBrowser
// 配置文件中 http代理配置
// https://github.com/chimurai/http-proxy-middleware
var proxyTable = config.dev.proxyTable
// 啟動 express 服務
var app = express()
// 啟動 webpack 編譯
var compiler = webpack(webpackConfig)
// 可以將編譯后的文件暫存到內存中的插件
// https://github.com/webpack/webpack-dev-middleware
var devMiddleware = require('webpack-dev-middleware')(compiler, {
// 公共路徑，與webpack的publicPath一樣
publicPath: webpackConfig.output.publicPath,
// 不打印
quiet: true
})
// Hot-reload 熱重載插件
// https://github.com/glenjamin/webpack-hot-middleware
var hotMiddleware = require('webpack-hot-middleware')(compiler, {
log: () => {}
})
// 當tml-webpack-plugin template更改之后，強制刷新瀏覽器
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的數(shù)據(jù)類型為string，則表示只設置了url，
// 所以需要將url設置為對象中的 target的值
if (typeof options === 'string') {
options = { target: options }
}
app.use(proxyMiddleware(options.filter || context, options))
})
// 使用 connect-history-api-fallback 匹配資源
// 如果不匹配就可以重定向到指定地址
// https://github.com/bripkens/connect-history-api-fallback
app.use(require('connect-history-api-fallback')())
// 將暫存到內存中的 webpack 編譯后的文件掛在到 express 服務上
app.use(devMiddleware)
// 將 Hot-reload 掛在到 express 服務上
app.use(hotMiddleware)
// 拼接 static 文件夾的靜態(tài)資源路徑
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 靜態(tài)文件服務
app.use(staticPath, express.static('./static'))
var uri = 'http://localhost:' + port
// 編譯成功后打印網(wǎng)址信息
devMiddleware.waitUntilValid(function () {
console.log('> Listening at ' + uri + '\n')
})
module.exports = app.listen(port, function (err) {
if (err) {
console.log(err)
return
}
// 如果配置了自動打開瀏覽器，且不是測試環(huán)境，則自動打開瀏覽器并跳到我們的開發(fā)地址
if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') {
opn(uri)
}
})webpack.dev.conf.js
dev-server.js中使用了webpack.dev.conf.js文件，該文件是開發(fā)環(huán)境中webpack的配置入口。
// 工具函數(shù)集合
var utils = require('./utils')
var webpack = require('webpack')
// 配置文件
var config = require('../config')
// webpack 配置合并插件
var merge = require('webpack-merge')
// webpac基本配置
var baseWebpackConfig = require('./webpack.base.conf')
// 自動生成 html 并且注入到 .html 文件中的插件
// https://github.com/ampedandwired/html-webpack-plugin
var HtmlWebpackPlugin = require('html-webpack-plugin')
// webpack錯誤信息提示插件
// https://github.com/geowarin/friendly-errors-webpack-plugin
var FriendlyErrorsPlugin = require('friendly-errors-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])
})
module.exports = merge(baseWebpackConfig, {
module: {
// styleLoaders
rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
},
// 最新的配置為 cheap-module-eval-source-map，雖然 cheap-module-eval-source-map更快，但它的定位不準確
// 所以，換成 eval-source-map
devtool: '#eval-source-map',
plugins: [
// definePlugin 接收字符串插入到代碼當中, 所以你需要的話可以寫上 JS 的字符串
// 此處，插入適當?shù)沫h(huán)境
// https://webpack.js.org/plugins/define-plugin/
new webpack.DefinePlugin({
'process.env': config.dev.env
}),
// HotModule 插件在頁面進行變更的時候只會重繪對應的頁面模塊，不會重繪整個 html 文件
// https://github.com/glenjamin/webpack-hot-middleware#installation--usage
new webpack.HotModuleReplacementPlugin(),
new webpack.NoEmitOnErrorsPlugin(),
// 將 index.html 作為入口，注入 html 代碼后生成 index.html文件
// https://github.com/ampedandwired/html-webpack-plugin
new HtmlWebpackPlugin({
filename: 'index.html',
template: 'index.html',
inject: true
}),
// webpack錯誤信息提示插件
new FriendlyErrorsPlugin()
]
})webpack.base.conf.js
在webpack.dev.conf.js中出現(xiàn)webpack.base.conf.js，這個文件是開發(fā)環(huán)境和生產環(huán)境，甚至測試環(huán)境，這些環(huán)境的公共webpack配置。可以說，這個文件相當重要。
// node自帶的文件路徑工具
var path = require('path')
// 工具函數(shù)集合
var utils = require('./utils')
// 配置文件
var config = require('../config')
// 工具函數(shù)集合
var vueLoaderConfig = require('./vue-loader.conf')
/**
* 獲得絕對路徑
* @method resolve
* @param {String} dir 相對于本文件的路徑
* @return {String} 絕對路徑
*/
function resolve(dir) {
return path.join(__dirname, '..', dir)
}
module.exports = {
entry: {
app: './src/main.js'
},
output: {
// 編譯輸出的靜態(tài)資源根路徑
path: config.build.assetsRoot,
// 編譯輸出的文件名
filename: '[name].js',
// 正式發(fā)布環(huán)境下編譯輸出的上線路徑的根路徑
publicPath: process.env.NODE_ENV === 'production' ?
config.build.assetsPublicPath : config.dev.assetsPublicPath
},
resolve: {
// 自動補全的擴展名
extensions: ['.js', '.vue', '.json'],
// 路徑別名
alias: {
// 例如 import Vue from 'vue'，會自動到 'vue/dist/vue.common.js'中尋找
'vue$': 'vue/dist/vue.esm.js',
'@': resolve('src'),
}
},
module: {
rules: [{
// 審查 js 和 vue 文件
// https://github.com/MoOx/eslint-loader
test: /\.(js|vue)$/,
loader: 'eslint-loader',
// 表示預先處理
enforce: "pre",
include: [resolve('src'), resolve('test')],
options: {
formatter: require('eslint-friendly-formatter')
}
},
{
// 處理 vue文件
// https://github.com/vuejs/vue-loader
test: /\.vue$/,
loader: 'vue-loader',
options: vueLoaderConfig
},
{
// 編譯 js
// https://github.com/babel/babel-loader
test: /\.js$/,
loader: 'babel-loader',
include: [resolve('src'), resolve('test')]
},
{
// 處理圖片文件
// https://github.com/webpack-contrib/url-loader
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
loader: 'url-loader',
query: {
limit: 10000,
name: utils.assetsPath('img/[name].[hash:7].[ext]')
}
},
{
// 處理字體文件
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
loader: 'url-loader',
query: {
limit: 10000,
name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
}
}
]
}
}config/index.js
該文件在很多文件中都用到，是主要的配置文件，包含靜態(tài)文件的路徑、是否開啟sourceMap等。其中，分為兩個部分dev（開發(fā)環(huán)境的配置）和build（生產環(huán)境的配置）。
// 詳情見文檔：https://vuejs-templates.github.io/webpack/env.html
var path = require('path')
module.exports = {
// production 生產環(huán)境
build: {
// 構建環(huán)境
env: require('./prod.env'),
// 構建輸出的index.html文件
index: path.resolve(__dirname, '../dist/index.html'),
// 構建輸出的靜態(tài)資源路徑
assetsRoot: path.resolve(__dirname, '../dist'),
// 構建輸出的二級目錄
assetsSubDirectory: 'static',
// 構建發(fā)布的根目錄，可配置為資源服務器域名或 cdn 域名
assetsPublicPath: '/',
// 是否開啟 cssSourceMap
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，因為很多流行的靜態(tài)資源主機，例如 Surge、Netlify，已經為所有靜態(tài)資源開啟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
// 運行“build”命令行時，加上一個參數(shù)，可以在構建完成后參看包分析報告
// true為開啟，false為關閉
bundleAnalyzerReport: process.env.npm_config_report
},
// dev 開發(fā)環(huán)境
dev: {
// 構建環(huán)境
env: require('./dev.env'),
// 端口號
port: 3333,
// 是否自動打開瀏覽器
autoOpenBrowser: true,
assetsSubDirectory: 'static',
// 編譯發(fā)布的根目錄，可配置為資源服務器域名或 CDN 域名
assetsPublicPath: '/',
// proxyTable 代理的接口（可跨域）
// 使用方法：https://vuejs-templates.github.io/webpack/proxy.html
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.
// 默認情況下，關閉 CSS Sourcemaps，因為使用相對路徑會報錯。
// CSS-Loader README：https://github.com/webpack/css-loader#sourcemaps
cssSourceMap: false
}
}utils.js
utils.js也是一個被使用頻率的文件，這個文件包含了三個工具函數(shù)：
生成靜態(tài)資源的路徑
生成 ExtractTextPlugin對象或loader字符串
生成 style-loader的配置
// node自帶的文件路徑工具
var path = require('path')
// 配置文件
var config = require('../config')
// 提取css的插件
// https://github.com/webpack-contrib/extract-text-webpack-plugin
var ExtractTextPlugin = require('extract-text-webpack-plugin')
/**
* 生成靜態(tài)資源的路徑
* @method assertsPath
* @param {String} _path 相對于靜態(tài)資源文件夾的文件路徑
* @return {String} 靜態(tài)資源完整路徑
*/
exports.assetsPath = function (_path) {
var assetsSubDirectory = process.env.NODE_ENV === 'production'
? config.build.assetsSubDirectory
: config.dev.assetsSubDirectory
// path.posix.join與path.join一樣，不過總是以 posix 兼容的方式交互
return path.posix.join(assetsSubDirectory, _path)
}
/**
* 生成處理css的loaders配置
* @method cssLoaders
* @param {Object} options 生成配置
* option = {
* // 是否開啟 sourceMap
* sourceMap: true,
* // 是否提取css
* extract: true
* }
* @return {Object} 處理css的loaders配置對象
*/
exports.cssLoaders = function (options) {
options = options || {}
var cssLoader = {
loader: 'css-loader',
options: {
minimize: process.env.NODE_ENV === 'production',
sourceMap: options.sourceMap
}
}
/**
* 生成 ExtractTextPlugin對象或loader字符串
* @method generateLoaders
* @param {Array} loaders loader名稱數(shù)組
* @return {String|Object} ExtractTextPlugin對象或loader字符串
*/
function generateLoaders (loader, loaderOptions) {
var loaders = [cssLoader]
if (loader) {
loaders.push({
// 例如，sass?indentedSyntax
// 在?號前加上“-loader”
loader: loader + '-loader',
options: Object.assign({}, loaderOptions, {
sourceMap: options.sourceMap
})
})
}
// extract為true時，提取css
// 生產環(huán)境中，默認為true
if (options.extract) {
return ExtractTextPlugin.extract({
use: loaders,
fallback: 'vue-style-loader'
})
} else {
return ['vue-style-loader'].concat(loaders)
}
}
// http://vuejs.github.io/vue-loader/en/configurations/extract-css.html
return {
css: generateLoaders(),
postcss: generateLoaders(),
less: generateLoaders('less'),
sass: generateLoaders('sass', { indentedSyntax: true }),
scss: generateLoaders('sass'),
stylus: generateLoaders('stylus'),
styl: generateLoaders('stylus')
}
}
/**
* 生成 style-loader的配置
* style-loader文檔：https://github.com/webpack/style-loader
* @method styleLoaders
* @param {Object} options 生成配置
* option = {
* // 是否開啟 sourceMap
* sourceMap: true,
* // 是否提取css
* extract: true
* }
* @return {Array} style-loader的配置
*/
exports.styleLoaders = function (options) {
var output = []
var loaders = exports.cssLoaders(options)
for (var extension in loaders) {
var loader = loaders[extension]
output.push({
test: new RegExp('\\.' + extension + '$'),
use: loader
})
}
return output
}生產環(huán)境
開發(fā)環(huán)境的入口文件是build/build.js 。
build.js
該文件，為構建打包文件，會將源碼進行構建（編譯、壓縮等）后打包。
// 設置當前環(huán)境為生產環(huán)境
process.env.NODE_ENV = 'production'
// loading 插件
// https://github.com/sindresorhus/ora
var ora = require('ora')
// 可以在 node 中執(zhí)行`rm -rf`的工具
// https://github.com/isaacs/rimraf
var rm = require('rimraf')
// node自帶的文件路徑工具
var path = require('path')
// 在終端輸出帶顏色的文字
// https://github.com/chalk/chalk
var chalk = require('chalk')
var webpack = require('webpack')
// 配置文件
var config = require('../config')
var webpackConfig = require('./webpack.prod.conf')
// 在終端顯示loading效果，并輸出提示
var spinner = ora('building for production...')
spinner.start()
// 刪除這個文件夾 （遞歸刪除）
rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => {
if (err) throw err
// 構建
webpack(webpackConfig, function (err, stats) {
// 構建成功
// 停止 loading動畫
spinner.stop()
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'
))
})
})webpack.prod.conf
該文件，為生產環(huán)境中webpack的配置入口。同時，它也依賴于前面提到的webpack.base.conf.js、utils.js和config/index.js。
// node自帶的文件路徑工具
var path = require('path')
// 工具函數(shù)集合
var utils = require('./utils')
var webpack = require('webpack')
// 配置文件
var config = require('../config')
// webpack 配置合并插件
var merge = require('webpack-merge')
// webpack 基本配置
var baseWebpackConfig = require('./webpack.base.conf')
// webpack 復制文件和文件夾的插件
// https://github.com/kevlened/copy-webpack-plugin
var CopyWebpackPlugin = require('copy-webpack-plugin')
// 自動生成 html 并且注入到 .html 文件中的插件
// https://github.com/ampedandwired/html-webpack-plugin
var HtmlWebpackPlugin = require('html-webpack-plugin')
// 提取css的插件
// https://github.com/webpack-contrib/extract-text-webpack-plugin
var ExtractTextPlugin = require('extract-text-webpack-plugin')
// webpack 優(yōu)化壓縮和優(yōu)化 css 的插件
// https://github.com/NMFR/optimize-css-assets-webpack-plugin
var OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin')
// 如果當前環(huán)境為測試環(huán)境，則使用測試環(huán)境
// 否則，使用生產環(huán)境
var env = process.env.NODE_ENV === 'testing'
? require('../config/test.env')
: config.build.env
var webpackConfig = merge(baseWebpackConfig, {
module: {
// styleLoaders
rules: utils.styleLoaders({
sourceMap: config.build.productionSourceMap,
extract: true
})
},
// 是否開啟 sourceMap
devtool: config.build.productionSourceMap ? '#source-map' : false,
output: {
// 編譯輸出的靜態(tài)資源根路徑
path: config.build.assetsRoot,
// 編譯輸出的文件名
filename: utils.assetsPath('js/[name].[chunkhash].js'),
// 沒有指定輸出名的文件輸出的文件名
chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')
},
plugins: [
// definePlugin 接收字符串插入到代碼當中, 所以你需要的話可以寫上 JS 的字符串
// 此處，插入適當?shù)沫h(huán)境
// http://vuejs.github.io/vue-loader/en/workflow/production.html
new webpack.DefinePlugin({
'process.env': env
}),
// 壓縮 js
new webpack.optimize.UglifyJsPlugin({
compress: {
warnings: false
},
sourceMap: true
}),
// 提取 css
new ExtractTextPlugin({
filename: utils.assetsPath('css/[name].[contenthash].css')
}),
// 壓縮提取出來的 css
// 可以刪除來自不同組件的冗余代碼
// Compress extracted CSS. We are using this plugin so that possible
// duplicated CSS from different components can be deduped.
new OptimizeCSSPlugin(),
// 將 index.html 作為入口，注入 html 代碼后生成 index.html文件
// 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
// 更多選項 https://github.com/kangax/html-minifier#options-quick-reference
},
// 必須通過 CommonsChunkPlugin一致地處理多個 chunks
chunksSortMode: 'dependency'
}),
// 分割公共 js 到獨立的文件
// https://webpack.js.org/guides/code-splitting-libraries/#commonschunkplugin
new 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
)
}
}),
// 將webpack runtime 和模塊清單 提取到獨立的文件，以防止當 app包更新時導致公共 jsd hash也更新
// 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']
}),
// 復制靜態(tài)資源
// https://github.com/kevlened/copy-webpack-plugin
new CopyWebpackPlugin([
{
from: path.resolve(__dirname, '../static'),
to: config.build.assetsSubDirectory,
ignore: ['.*']
}
])
]
})
// 開啟 gzip 的情況時，給 webpack plugins添加 compression-webpack-plugin 插件
if (config.build.productionGzip) {
// webpack 壓縮插件
// https://github.com/webpack-contrib/compression-webpack-plugin
var CompressionWebpackPlugin = require('compression-webpack-plugin')
// 向webpackconfig.plugins中加入下方的插件
webpackConfig.plugins.push(
new CompressionWebpackPlugin({
asset: '[path].gz[query]',
algorithm: 'gzip',
test: new RegExp(
'\\.(' +
config.build.productionGzipExtensions.join('|') +
')$'
),
threshold: 10240,
minRatio: 0.8
})
)
}
// 開啟包分析的情況時， 給 webpack plugins添加 webpack-bundle-analyzer 插件
if (config.build.bundleAnalyzerReport) {
// https://github.com/th0r/webpack-bundle-analyzer
var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin
webpackConfig.plugins.push(new BundleAnalyzerPlugin())
}
module.exports = webpackConfig以上是“vue-cli中webpack配置文件的示例分析”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注創(chuàng)新互聯(lián)行業(yè)資訊頻道！
網(wǎng)站題目：vue-cli中webpack配置文件的示例分析
網(wǎng)站鏈接：http://www.ef60e0e.cn/article/pjdjci.html
