vue-cli中的webpack配置
编辑模式下显示正常,打开的时候不知道为啥排版有问题。
segementfalut 链接在这里
版本号
vue-cli
2.8.1 ( 终端通过vue -V
可查看 )
vue
2.2.2
webpack
2.2.1
目录结构
├── README.md
├── 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
├── 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
webpack 配置
主要对 build 目录下的 webpack 配置做详细分析
webpack.base.conf.js
入口文件entry
entry: {
app: '.src/main.js'
}
输出文件output
config
的配置在config/index.js
文件中
output: {
path: config.build.assetsRoot, // 导出目录的绝对路径
filename: '[name].js', // 导出文件的文件名
publicPath: process.env.NODE_ENV === 'production'? config.build.assetsPublicPath : config.dev.assetsPublicPath // 生产模式或开发模式下 html、js 等文件内部引用的公共路径
}
文件解析resolve
主要设置模块如何被解析。
resolve: {
extensions: ['.js', '.vue', '.json'], // 自动解析确定的拓展名, 使导入模块时不带拓展名
alias: { // 创建 import 或 require 的别名
'vue$': 'vue/dist/vue.esm.js',
'@': resolve('src')
}
}
模块解析module
如何处理项目不同类型的模块。
module: {
rules: [
{
test: /\.vue$/, // vue 文件后缀
loader: 'vue-loader', // 使用 vue-loader 处理
options: vueLoaderConfig //options 是对 vue-loader 做的额外选项配置
},
{
test: /\.js$/, // js 文件后缀
loader: 'babel-loader', // 使用 babel-loader 处理
include: [resolve('src'), resolve('test')] // 必须处理包含 src 和 test 文件夹
},
{
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, // 图片后缀
loader: 'url-loader', // 使用 url-loader 处理
query: { // query 是对 loader 做额外的选项配置
limit: 10000, // 图片小于 10000 字节时以 base64 的方式引用
name: utils.assetsPath('img/[name].[hash:7].[ext]') // 文件名为 name.7 位 hash 值. 拓展名
}
},
{
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, // 字体文件
loader: 'url-loader', // 使用 url-loader 处理
query: {
limit: 10000, // 字体文件小于 1000 字节的时候处理方式
name: utils.assetsPath('fonts/[name].[hash:7].[ext]') // 文件名为 name.7 位 hash 值. 拓展名
}
}
]
}
注: 关于query
仅由于兼容性原因而存在。请使用 options
代替。
webpack.dev.conf.js
开发环境下的webpack
配置,通过merge
方法合并webpack.base.conf.js
基础配置
var merge = require('webpack-merge')
var baseWebpackConfig = require('./webpack.base.conf')
module.exports = merge(baseWebpackConfig, {})
模块配置
module: {
// 通过传入一些配置来获取 rules 配置,此处传入了 sourceMap: false, 表示不生成 sourceMap
rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
}
在util.styleLoaders
中的配置如下
exports.styleLoaders = function (options) {
var output = [] // 定义返回的数组,数组中保存的是针对各类型的样式文件的处理方式
var loaders = exports.cssLoaders(options) // 调用 cssLoaders 方法返回各类型的样式对象 (css: loader)
for (var extension in loaders) { // 循环遍历 loaders
var loader = loaders[extension] // 根据遍历获得的 key(extension) 来得到 value(loader)
output.push({ //
test: new RegExp('\\.' + extension + '$'), // 处理的文件类型
use: loader // 用 loader 来处理,loader 来自 loaders[extension]
})
}
return output
}
上面的代码中调用了exports.cssLoaders(options)
, 用来返回针对各类型的样式文件的处理方式, 具体实现如下
exports.cssLoaders = function (options) {
options = options || {}
var cssLoader = {
loader: 'css-loader',
options: { //options 是 loader 的选项配置
minimize: process.env.NODE_ENV === 'production', // 生成环境下压缩文件
sourceMap: options.sourceMap // 根据参数是否生成 sourceMap 文件
}
}
function generateLoaders (loader, loaderOptions) { // 生成 loader
var loaders = [cssLoader] // 默认是 css-loader
if (loader) { // 如果参数 loader 存在
loaders.push({
loader: loader + '-loader',
options: Object.assign({}, loaderOptions, { // 将 loaderOptions 和 sourceMap 组成一个对象
sourceMap: options.sourceMap
})
})
}
if (options.extract) { // 如果传入的 options 存在 extract 且为 true
return ExtractTextPlugin.extract({ //ExtractTextPlugin 分离 js 中引入的 css 文件
use: loaders, // 处理的 loader
fallback: 'vue-style-loader' // 没有被提取分离时使用的 loader
})
} else {
return ['vue-style-loader'].concat(loaders)
}
}
return { // 返回 css 类型对应的 loader 组成的对象 generateLoaders() 来生成 loader
css: generateLoaders(),
postcss: generateLoaders(),
less: generateLoaders('less'),
sass: generateLoaders('sass', { indentedSyntax: true }),
scss: generateLoaders('sass'),
stylus: generateLoaders('stylus'),
styl: generateLoaders('stylus')
}
}
插件配置
plugins: [
new webpack.DefinePlugin({ // 编译时配置的全局变量
'process.env': config.dev.env // 当前环境为开发环境
}),
new webpack.HotModuleReplacementPlugin(), // 热更新插件
new webpack.NoEmitOnErrorPlugin(), // 不触发错误, 即编译后运行的包正常运行
new HtmlWebpackPlugin({ // 自动生成 html 文件, 比如编译后文件的引入
filename: 'index.html', // 生成的文件名
template: 'index.html', // 模板
inject: true
}),
new FriendlyErrorsPlugin() // 友好的错误提示
]
webpack.prod.conf.js
生产环境下的webpack
配置,通过merge
方法合并webpack.base.conf.js
基础配置
module
的处理, 主要是针对css
的处理
同样的此处调用了utils.styleLoaders
module: {
rules: utils.styleLoaders({
sourceMap: config.build.productionSourceMap,
extract: true
})
}
输出文件output
output: {
// 导出文件目录
path: config.build.assetsRoot,
// 导出的文件名
filename: utils.assetsPath('js/[name].[chunkhash].js'),
// 非入口文件的文件名,而又需要被打包出来的文件命名配置, 如按需加载的模块
chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')
}
插件plugins
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 CopyWebpackPlugin = require('copy-webpack-plugin')
var HtmlWebpackPlugin = require('html-webpack-plugin')
var ExtractTextPlugin = require('extract-text-webpack-plugin')
var OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin')
var env = config.build.env
plugins: [
new webpack.DefinePlugin({
'process.env': env // 配置全局环境为生产环境
}),
new webpack.optimize.UglifyJsPlugin({ //js 文件压缩插件
compress: { // 压缩配置
warnings: false // 不显示警告
},
sourceMap: true // 生成 sourceMap 文件
}),
new ExtractTextPlugin({ // 将 js 中引入的 css 分离的插件
filename: utils.assetsPath('css/[name].[contenthash].css') // 分离出的 css 文件名
}),
// 压缩提取出的 css,并解决 ExtractTextPlugin 分离出的 js 重复问题 (多个文件引入同一 css 文件)
new OptimizeCSSPlugin(),
// 生成 html 的插件, 引入 css 文件和 js 文件
new HtmlWebpackPlugin({
filename: config.build.index, // 生成的 html 的文件名
template: 'index.html', // 依据的模板
inject: true, // 注入的 js 文件将会被放在 body 标签中, 当值为 'head' 时,将被放在 head 标签中
minify: { // 压缩配置
removeComments: true, // 删除 html 中的注释代码
collapseWhitespace: true, // 删除 html 中的空白符
removeAttributeQuotes: true // 删除 html 元素中属性的引号
},
chunksSortMode: 'dependency' // 按 dependency 的顺序引入
}),
// 分离公共 js 到 vendor 中
new webpack.optimize.CommonsChunkPlugin({
name: 'vendor', // 文件名
minChunks: functions(module, count) { // 声明公共的模块来自 node_modules 文件夹
return (module.resource && /\.js$/.test(module.resource) && module,resource.indexOf(path.join(__dirname, '../node_modules')) === 0)
}
}),
// 上面虽然已经分离了第三方库, 每次修改编译都会改变 vendor 的 hash 值,导致浏览器缓存失效。原因是 vendor 包含了 webpack 在打包过程中会产生一些运行时代码,运行时代码中实际上保存了打包后的文件名。当修改业务代码时, 业务代码的 js 文件的 hash 值必然会改变。一旦改变必然会导致 vendor 变化。vendor 变化会导致其 hash 值变化。
// 下面主要是将运行时代码提取到单独的 manifest 文件中,防止其影响 vendor.js
new webpack.optimize.CommonsChunkPlugin({
name: 'mainifest',
chunks: ['vendor']
}),
// 复制静态资源, 将 static 文件内的内容复制到指定文件夹
new CopyWebpackPlugin([{
from: path.resolve(__dirname, '../static'),
to: config.build.assetsSubDirectory,
ignore: ['.*'] // 忽视.* 文件
}])
]
额外配置
if (config.build.productionGzip) { // 配置文件开启了 gzip 压缩
// 引入压缩文件的组件, 该插件会对生成的文件进行压缩,生成一个.gz 文件
var CompressionWebpackPlugin = require('compression-webpack-plugin')
webpackConfig.plugins.push(
new CompressionWebpackPlugin({
asset: '[path].gz[query]', // 目标文件名
algorithm: 'gzip', // 使用 gzip 压缩
test: new RegExp( // 满足正则表达式的文件会被压缩
'\.(' +
config.build.productionGzipExtensions.join('|') +
')$'
),
threshold: 10240, // 资源文件大于 10240B=10kB 时会被压缩
minRatio: 0.8 // 最小压缩比达到 0.8 时才会被压缩
})
)
}
npm run dev
有了上面的配置之后,下面看看运行命令npm run dev
发生了什么
在package.json
文件中定义了dev
运行的脚本
"scripts": {
"dev": "node build/dev-server.js",
"build": "node build/build.js"
},
当运行npm run dev
命令时,实际上会运行dev-server.js
文件
该文件以 express 作为后端框架
// nodejs 环境配置
var config = require('../config')
if (!process.env.NODE_ENV) {
process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
}
var opn = require('opn') // 强制打开浏览器
var path = require('path')
var express = require('express')
var webpack = require('webpack')
var proxyMiddleware = require('http-proxy-middleware') // 使用代理的中间件
var webpackConfig = require('./webpack.dev.conf') //webpack 的配置
var port = process.env.PORT || config.dev.port // 端口号
var autoOpenBrowser = !!config.dev.autoOpenBrowser // 是否自动打开浏览器
var proxyTable = config.dev.proxyTable //http 的代理 url
var app = express() // 启动 express
var compiler = webpack(webpackConfig) //webpack 编译
//webpack-dev-middleware 的作用
//1. 将编译后的生成的静态文件放在内存中, 所以在 npm run dev 后磁盘上不会生成文件
//2. 当文件改变时, 会自动编译。
//3. 当在编译过程中请求某个资源时,webpack-dev-server 不会让这个请求失败,而是会一直阻塞它,直到 webpack 编译完毕
var devMiddleware = require('webpack-dev-middleware')(compiler, {
publicPath: webpackConfig.output.publicPath,
quiet: true
})
//webpack-hot-middleware 的作用就是实现浏览器的无刷新更新
var hotMiddleware = require('webpack-hot-middleware')(compiler, {
log: () => {}
})
// 声明 hotMiddleware 无刷新更新的时机:html-webpack-plugin 的 template 更改之后
compiler.plugin('compilation', function (compilation) {
compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) {
hotMiddleware.publish({ action: 'reload' })
cb()
})
})
// 将代理请求的配置应用到 express 服务上
Object.keys(proxyTable).forEach(function (context) {
var options = proxyTable[context]
if (typeof options === 'string') {
options = { target: options }
}
app.use(proxyMiddleware(options.filter || context, options))
})
// 使用 connect-history-api-fallback 匹配资源
// 如果不匹配就可以重定向到指定地址
app.use(require('connect-history-api-fallback')())
// 应用 devMiddleware 中间件
app.use(devMiddleware)
// 应用 hotMiddleware 中间件
app.use(hotMiddleware)
// 配置 express 静态资源目录
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
app.use(staticPath, express.static('./static'))
var uri = 'http://localhost:' + port
// 编译成功后打印 uri
devMiddleware.waitUntilValid(function () {
console.log('> Listening at' + uri + '\n')
})
// 启动 express 服务
module.exports = app.listen(port, function (err) {
if (err) {
console.log(err)
return
}
// 满足条件则自动打开浏览器
if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') {
opn(uri)
}
})
npm run build
由于package.json
中的配置,运行此命令后会执行build.js
文件
process.env.NODE_ENV = 'production' // 设置当前环境为 production
var ora = require('ora') // 终端显示的转轮 loading
var rm = require('rimraf') //node 环境下 rm -rf 的命令库
var path = require('path') // 文件路径处理库
var chalk = require('chalk') // 终端显示带颜色的文字
var webpack = require('webpack')
var config = require('../config')
var webpackConfig = require('./webpack.prod.conf') // 生产环境下的 webpack 配置
// 在终端显示 ora 库的 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) {
spinner.stop() // 停止 loading
if (err) throw err
<span class="hljs-comment">// 在编译完成的回调函数中,在终端输出编译的文件</span>
process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">write</span>(stats.<span class="hljs-title function_">toString</span>({
<span class="hljs-attr">colors</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">modules</span>: <span class="hljs-literal">false</span>,
<span class="hljs-attr">children</span>: <span class="hljs-literal">false</span>,
<span class="hljs-attr">chunks</span>: <span class="hljs-literal">false</span>,
<span class="hljs-attr">chunkModules</span>: <span class="hljs-literal">false</span>
}) + <span class="hljs-string">'\n\n'</span>)
})
})