webpack 的构建原理
腾讯面试官:兄弟,你说你会Webpack,那说说他的原理?
webpack详解
核心概念
entry
:入口。webpack是基于模块的,使用webpack首先需要指定模块解析入口(entry),webpack从入口开始根据模块间依赖关系递归解析和处理所有资源文件。output
:输出。源代码经过webpack处理之后的最终产物。loader
:模块转换器。本质就是一个函数,在该函数中对接收到的内容进行转换,返回转换后的结果。因为 Webpack 只认识 JavaScript,所以 Loader 就成了翻译官,对其他类型的资源进行转译的预处理工作。plugin
:扩展插件。基于事件流框架Tapable
,插件可以扩展 Webpack 的功能,在 Webpack 运行的生命周期中会广播出许多事件,Plugin 可以监听这些事件,在合适的时机通过 Webpack 提供的 API 改变输出结果。module
:模块。除了js范畴内的es module、commonJs、AMD
等,css @import、url(...)
、图片、字体等在webpack中都被视为模块。
webpack 的打包思想可以简化为 3 点:
- 一切源代码文件均可通过各种
Loader
转换为 JS 模块 (module
),模块之间可以互相引用。 - webpack 通过入口点(
entry point
)递归处理各模块引用关系,最后输出为一个或多个产物包js(bundle)
文件。 - 每一个入口点都是一个块组(
chunk group
),在不考虑分包的情况下,一个chunk group
中只有一个chunk
,该 chunk 包含递归分析后的所有模块。每一个chunk
都有对应的一个打包后的输出文件(asset/bundle
)
打包流程
- 初始化参数:从配置文件和 Shell 语句中读取并合并参数,得出最终的配置参数。
- 开始编译:从上一步得到的参数初始化
Compiler
对象,加载所有配置的插件,执行对象的run
方法开始执行编译。 - 确定入口:根据配置中的
entry
找出所有的入口文件。 - 编译模块:从入口文件出发,调用所有配置的
loader
对模块进行翻译,再找出该模块依赖的模块,这个步骤是递归执行的,直至所有入口依赖的模块文件都经过本步骤的处理。 - 完成模块编译:经过第 4 步使用 loader 翻译完所有模块后,得到了每个模块被翻译后的最终内容以及它们之间的依赖关系。
- 输出资源:根据入口和模块之间的依赖关系,组装成一个个包含多个模块的
chunk
,再把每个chunk
转换成一个单独的文件加入到输出列表,这一步是可以修改输出内容的最后机会。 - 输出完成:在确定好输出内容后,根据配置确定输出的路径和文件名,把文件内容写入到文件系统。
简版
- Webpack CLI 启动打包流程;
- 载入 Webpack 核心模块,创建
Compiler
对象; - 使用
Compiler
对象开始编译整个项目; - 从入口文件开始,解析模块依赖,形成依赖关系树;
- 递归依赖树,将每个模块交给对应的 Loader 处理;
- 合并 Loader 处理完的结果,将打包结果输出到 dist 目录。
在以上过程中,Webpack 会在特定的时间点广播出特定的事件
,插件在监听到相关事件后会执行特定的逻辑,并且插件可以调用 Webpack 提供的 API 改变 Webpack 的运行结果
最终Webpack
打包出来的bundle
文件是一个IIFE
的执行函数。
// webpack 5 打包的bundle文件内容
(() => { // webpackBootstrap
var __webpack_modules__ = ({
'file-A-path': ((modules) => { // ... })
'index-file-path': ((__unused_webpack_module, __unused_webpack_exports, __webpack_require__) => { // ... })
})
// The module cache
var __webpack_module_cache__ = {};
// The require function
function __webpack_require__(moduleId) {
// Check if module is in cache
var cachedModule = __webpack_module_cache__[moduleId];
if (cachedModule !== undefined) {
return cachedModule.exports;
}
// Create a new module (and put it into the cache)
var module = __webpack_module_cache__[moduleId] = {
// no module.id needed
// no module.loaded needed
exports: {}
};
// Execute the module function
__webpack_modules__[moduleId](module, module.exports, __webpack_require__);
// Return the exports of the module
return module.exports;
}
// startup
// Load entry module and return exports
// This entry module can't be inlined because the eval devtool is used.
var __webpack_exports__ = __webpack_require__("./src/index.js");
})
事件流机制:
Webpack 事件流编程范式的核心是基础类 Tapable,是一种 观察者模式 的实现事件的订阅与广播:
const { SyncHook } = require("tapable")
const hook = new SyncHook(['arg'])
// 订阅
hook.tap('event', (arg) => {
// 'event-hook'
console.log(arg)
})
// 广播
hook.call('event-hook')
Webpack
中两个最重要的类 Compiler
与 Compilation
便是继承于 Tapable
,也拥有这样的事件流机制。
-
Compiler
: 可以简单的理解为 Webpack 实例,它包含了当前 Webpack 中的所有配置信息,如 options, loaders, plugins 等信息,全局唯一,只在启动时完成初始化创建,随着生命周期逐一传递; -
Compilation
: 可以称为 编译实例。当监听到文件发生改变时,Webpack 会创建一个新的 Compilation 对象,开始一次新的编译。它包含了当前的输入资源,输出资源,变化的文件等,同时通过它提供的 api,可以监听每次编译过程中触发的事件钩子; -
区别:
Compiler
全局唯一,且从启动生存到结束;Compilation
对应每次编译,每轮编译循环均会重新创建;
Tapabel
Tapabel
是一个类似于 Node.js
的 EventEmitter
的库,主要是控制钩子函数的发布与订阅,是Webpack
插件系统的大管家
Tapabel提供的钩子及示例
const {
SyncHook, // 同步钩子
SyncBailHook, // 同步熔断钩子
SyncWaterfallHook, // 同步流水钩子
SyncLoopHook, // 同步循环钩子
AsyncParalleHook, // 异步并发钩子
AsyncParallelBailHook, // 异步并发熔断钩子
AsyncSeriesHook, // 异步串行钩子
AsyncSeriesBailHook, // 异步串行熔断钩子
AsyncSeriesWaterfallHook // 异步串行流水钩子
} = require("tapable");
Tabpack
提供了同步&异步绑定钩子的方法,方法如下所示:
Async | Sync | |
---|---|---|
绑定:tapAsync/tapPromise/tap | 绑定:tap | |
执行:callAsync/promise | 执行:`call | ` |
Tabpack简单示例
const demohook = new SyncHook(["arg1", "arg2", "arg3"]);
// 绑定事件到webpack事件流
demohook.tap("hook1",(arg1, arg2, arg3) => console.log(arg1, arg2, arg3)) // 1 2 3
// 执行绑定的事件
demohook.call(1,2,3)
实现小型打包工具
该工具可以实现以下两个功能
- 将
ES6
转换为ES5
- 支持在
JS
文件中import CSS
文件
实现
因为涉及到 ES6
转 ES5
,所以我们首先需要安装一些 Babel
相关的工具
yarn add babylon babel-traverse babel-core babel-preset-env
接下来我们将这些工具引入文件中
const fs = require('fs')
const path = require('path')
const babylon = require('babylon')
const traverse = require('babel-traverse').default
const { transformFromAst } = require('babel-core')
首先,我们先来实现如何使用 Babel
转换代码
function readCode(filePath) {
// 读取文件内容
const content = fs.readFileSync(filePath, 'utf-8')
// 生成 AST
const ast = babylon.parse(content, {
sourceType: 'module'
})
// 寻找当前文件的依赖关系
const dependencies = []
traverse(ast, {
ImportDeclaration: ({ node }) => {
dependencies.push(node.source.value)
}
})
// 通过 AST 将代码转为 ES5
const { code } = transformFromAst(ast, null, {
presets: ['env']
})
return {
filePath,
dependencies,
code
}
}
- 首先我们传入一个文件路径参数,然后通过
fs
将文件中的内容读取出来 - 接下来我们通过
babylon
解析代码获取AST
,目的是为了分析代码中是否还引入了别的文件 - 通过
dependencies
来存储文件中的依赖,然后再将AST
转换为ES5
代码 - 最后函数返回了一个对象,对象中包含了当前文件路径、当前文件依赖和当前文件转换后的代码
接下来我们需要实现一个函数,这个函数的功能有以下几点
- 调用
readCode
函数,传入入口文件 - 分析入口文件的依赖
- 识别
JS
和CSS
文件
function getDependencies(entry) {
// 读取入口文件
const entryObject = readCode(entry)
const dependencies = [entryObject]
// 遍历所有文件依赖关系
for (const asset of dependencies) {
// 获得文件目录
const dirname = path.dirname(asset.filePath)
// 遍历当前文件依赖关系
asset.dependencies.forEach(relativePath => {
// 获得绝对路径
const absolutePath = path.join(dirname, relativePath)
// CSS 文件逻辑就是将代码插入到 `style` 标签中
if (/.css$/.test(absolutePath)) {
const content = fs.readFileSync(absolutePath, 'utf-8')
const code = `
const style = document.createElement('style')
style.innerText = ${JSON.stringify(content).replace(/\r\n/g, '')}
document.head.appendChild(style)
`
dependencies.push({
filePath: absolutePath,
relativePath,
dependencies: [],
code
})
} else {
// JS 代码需要继续查找是否有依赖关系
const child = readCode(absolutePath)
child.relativePath = relativePath
dependencies.push(child)
}
})
}
return dependencies
}
- 首先我们读取入口文件,然后创建一个数组,该数组的目的是存储代码中涉及到的所有文件
- 接下来我们遍历这个数组,一开始这个数组中只有入口文件,在遍历的过程中,如果入口文件有依赖其他的文件,那么就会被
push
到这个数组中 - 在遍历的过程中,我们先获得该文件对应的目录,然后遍历当前文件的依赖关系
- 在遍历当前文件依赖关系的过程中,首先生成依赖文件的绝对路径,然后判断当前文件是
CSS
文件还是JS
文件 - 如果是
CSS
文件的话,我们就不能用Babel
去编译了,只需要读取CSS
文件中的代码,然后创建一个style
标签,将代码插入进标签并且放入head
中即可 - 如果是
JS
文件的话,我们还需要分析JS
文件是否还有别的依赖关系 - 最后将读取文件后的对象
push
进数组中 - 现在我们已经获取到了所有的依赖文件,接下来就是实现打包的功能了
function bundle(dependencies, entry) {
let modules = ''
// 构建函数参数,生成的结构为
// { './entry.js': function(module, exports, require) { 代码 } }
dependencies.forEach(dep => {
const filePath = dep.relativePath || entry
modules += `'${filePath}': (
function (module, exports, require) { ${dep.code} }
),`
})
// 构建 require 函数,目的是为了获取模块暴露出来的内容
const result = `
(function(modules) {
function require(id) {
const module = { exports : {} }
modules[id](module, module.exports, require)
return module.exports
}
require('${entry}')
})({${modules}})
`
// 当生成的内容写入到文件中
fs.writeFileSync('./bundle.js', result)
}
这段代码需要结合着 Babel
转换后的代码来看,这样大家就能理解为什么需要这样写了
// entry.js
var _a = require('./a.js')
var _a2 = _interopRequireDefault(_a)
function _interopRequireDefault(obj) {
return obj && obj.__esModule ? obj : { default: obj }
}
console.log(_a2.default)
// a.js
Object.defineProperty(exports, '__esModule', {
value: true
})
var a = 1
exports.default = a
Babel
将我们 ES6
的模块化代码转换为了 CommonJS
的代码,但是浏览器是不支持 CommonJS
的,所以如果这段代码需要在浏览器环境下运行的话,我们需要自己实现 CommonJS
相关的代码,这就是 bundle
函数做的大部分事情。
接下来我们再来逐行解析 bundle 函数
-
首先遍历所有依赖文件,构建出一个函数参数对象
-
对象的属性就是当前文件的相对路径,属性值是一个函数,函数体是当前文件下的代码,函数接受三个参数
module
、exports
、require
module
参数对应CommonJS
中的module
exports
参数对应CommonJS
中的module.export
require
参数对应我们自己创建的require
函数
-
接下来就是构造一个使用参数的函数了,函数做的事情很简单,就是内部创建一个
require
函数,然后调用require(entry)
,也就是require('./entry.js')
,这样就会从函数参数中找到./entry.js
对应的函数并执行,最后将导出的内容通过module.export
的方式让外部获取到 -
最后再将打包出来的内容写入到单独的文件中
;(function(modules) {
function require(id) {
// 构造一个 CommonJS 导出代码
const module = { exports: {} }
// 去参数中获取文件对应的函数并执行
modules[id](module, module.exports, require)
return module.exports
}
require('./entry.js')
})({
'./entry.js': function(module, exports, require) {
// 这里继续通过构造的 require 去找到 a.js 文件对应的函数
var _a = require('./a.js')
console.log(_a2.default)
},
'./a.js': function(module, exports, require) {
var a = 1
// 将 require 函数中的变量 module 变成了这样的结构
// module.exports = 1
// 这样就能在外部取到导出的内容了
exports.default = a
}
// 省略
})
虽然实现这个工具只写了不到 100
行的代码,但是打包工具的核心原理就是这些了
- 找出入口文件所有的依赖关系
- 然后通过构建
CommonJS
代码来获取exports
导出的内容
介绍Loader
从上面的打包代码我们其实可以知道,Webpack
最后打包出来的成果是一份Javascript
代码,实际上在Webpack
内部默认也只能够处理JS
模块代码,在打包过程中,会默认把所有遇到的文件都当作 JavaScript
代码进行解析,因此当项目存在非JS
类型文件时,我们需要先对其进行必要的转换,才能继续执行打包任务,这也是Loader
机制存在的意义。
loader
是支持以数组的形式配置多个的,因此当Webpack
在转换该文件类型的时候,会按顺序链式调用每一个loader
,前一个loader
返回的内容会作为下一个loader
的入参。
介绍 plugin
如果说Loader
负责文件转换,那么Plugin
便是负责功能扩展。Loader
和Plugin
作为Webpack
的两个重要组成部分,承担着两部分不同的职责。
上文已经说过,webpack
基于发布订阅模式,在运行的生命周期中会广播出许多事件,插件通过监听这些事件,就可以在特定的阶段执行自己的插件任务,从而实现自己想要的功能。
既然基于发布订阅模式,那么知道Webpack
到底提供了哪些事件钩子供插件开发者使用是非常重要的,上文提到过compiler
和compilation
是Webpack
两个非常核心的对象,其中compiler
暴露了和 Webpack
整个生命周期相关的钩子(compiler-hooks),而compilation
则暴露了与模块和依赖有关的粒度更小的事件钩子(Compilation Hooks)。
一个最简单的 plugin 是这样的:
class Plugin{
// 注册插件时,会调用 apply 方法
// apply 方法接收 compiler 对象
// 通过 compiler 上提供的 Api,可以对事件进行监听,执行相应的操作
apply(compiler){
// compilation 是监听每次编译循环
// 每次文件变化,都会生成新的 compilation 对象并触发该事件
compiler.plugin('compilation',function(compilation) {})
}
}
注册插件:
// webpack.config.js
module.export = {
plugins:[
new Plugin(options),
]
}
-
常用 Plugin:
- UglifyJsPlugin: 压缩、混淆代码;
- CommonsChunkPlugin: 代码分割;
- ProvidePlugin: 自动加载模块;
- html-webpack-plugin: 加载 html 文件,并引入 css / js 文件;
- extract-text-webpack-plugin / mini-css-extract-plugin: 抽离样式,生成 css 文件; DefinePlugin: 定义全局变量;
- optimize-css-assets-webpack-plugin: CSS 代码去重;
- webpack-bundle-analyzer: 代码分析;
- compression-webpack-plugin: 使用 gzip 压缩 js 和 css;
- happypack: 使用多进程,加速代码构建;
- EnvironmentPlugin: 定义环境变量;
-
调用插件
apply
函数传入compiler
对象 -
通过
compiler
对象监听事件
loader和plugin有什么区别?
webapck默认只能打包JS和JOSN模块,要打包其它模块,需要借助loader,loader就可以让模块中的内容转化成webpack或其它laoder可以识别的内容。
loader
就是模块转换化,或叫加载器。不同的文件,需要不同的loader
来处理。plugin
是插件,可以参与到整个webpack打包的流程中,不同的插件,在合适的时机,可以做不同的事件。
Webpack 性能优化
- 使用
高版本
的 Webpack 和 Node.js 多进程/多实例构建
:thread-loader压缩代码
- 多进程并行压缩
- webpack-paralle-uglify-plugin
- uglifyjs-webpack-plugin 开启 parallel 参数 (不支持ES6)
- terser-webpack-plugin 开启 parallel 参数
- 通过 mini-css-extract-plugin 提取 Chunk 中的 CSS 代码到单独文件,通过 css-loader 的 minimize 选项开启 cssnano 压缩 CSS。
- 多进程并行压缩
const UglifyJsPlugin = require("uglifyjs-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin");
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
cache: true,
parallel: true,
sourceMap: true
}),
new OptimizeCSSAssetsPlugin({}) // use OptimizeCSSAssetsPlugin
]
},
plugins: [ // 提取CSS到单独文件
new MiniCssExtractPlugin({
filename: 'css/app.[name].css',
chunkFilename: 'css/app.[contenthash:12].css' // use contenthash *
})
]
....
}
图片压缩
- 使用基于 Node 库的 imagemin (很多定制选项、可以处理多种图片格式)
- 配置 image-webpack-loader
缩小打包作用域
:- exclude/include (确定 loader 规则范围)
- resolve.modules 指明第三方模块的绝对路径 (减少不必要的查找)
- resolve.mainFields 只采用 main 字段作为入口文件描述字段 (减少搜索步骤,需要考虑到所有运行时依赖的第三方模块的入口文件描述字段)
- resolve.extensions 尽可能减少后缀尝试的可能性
- noParse 对完全不需要解析的库进行忽略 (不去解析但仍会打包到 bundle 中,注意被忽略掉的文件里不应该包含 import、require、define 等模块化语句)
- IgnorePlugin (完全排除模块)
- 合理使用alias
提取页面公共资源
:- 使用 html-webpack-externals-plugin,将基础包通过 CDN 引入,不打入 bundle 中
- 使用 SplitChunksPlugin 进行(公共脚本、基础包、页面公共文件)分离(Webpack4内置) ,替代了 CommonsChunkPlugin 插件
DLL
:- 使用 DllPlugin 进行分包,使用 DllReferencePlugin(索引链接) 对 manifest.json 引用,让一些基本不会改动的代码先打包成静态资源,避免反复编译浪费时间。
- HashedModuleIdsPlugin 可以解决模块数字id问题
充分利用缓存提升二次构建速度
:- babel-loader 开启缓存
- terser-webpack-plugin 开启缓存
- 使用 cache-loader 或者 hard-source-webpack-plugin
Tree shaking
- 打包过程中检测工程中没有引用过的模块并进行标记,在资源压缩时将它们从最终的bundle中去掉(只能对ES6 Modlue生效) 开发中尽可能使用ES6 Module的模块,提高tree shaking效率
- 禁用 babel-loader 的模块依赖解析,否则 Webpack 接收到的就都是转换过的 CommonJS 形式的模块,无法进行 tree-shaking
- 使用 PurifyCSS(不在维护) 或者 uncss 去除无用 CSS 代码
- purgecss-webpack-plugin 和 mini-css-extract-plugin配合使用(建议)
Scope hoisting
- 构建后的代码会存在大量闭包,造成体积增大,运行代码时创建的函数作用域变多,内存开销变大。Scope hoisting 将所有模块的代码按照引用顺序放在一个函数作用域里,然后适当的重命名一些变量以防止变量名冲突
- 必须是ES6的语法,因为有很多第三方库仍采用 CommonJS 语法,为了充分发挥 Scope hoisting 的作用,需要配置 mainFields 对第三方模块优先采用 jsnext:main 中指向的ES6模块化语法
动态Polyfill
- 建议采用 polyfill-service 只给用户返回需要的polyfill,社区维护
Webpack Proxy工作原理?为什么能解决跨域
1. 是什么
webpack proxy
,即webpack
提供的代理服务
基本行为就是接收客户端发送的请求后转发给其他服务器
其目的是为了便于开发者在开发模式下解决跨域问题(浏览器安全策略限制)
想要实现代理首先需要一个中间服务器,webpack
中提供服务器的工具为webpack-dev-server
2. webpack-dev-server
webpack-dev-server
是 webpack
官方推出的一款开发工具,将自动编译和自动刷新浏览器等一系列对开发友好的功能全部集成在了一起
目的是为了提高开发者日常的开发效率,「只适用在开发阶段」
关于配置方面,在webpack
配置对象属性中通过devServer
属性提供,如下:
// ./webpack.config.js
const path = require('path')
module.exports = {
// ...
devServer: {
contentBase: path.join(__dirname, 'dist'),
compress: true,
port: 9000,
proxy: {
'/api': {
target: 'https://api.github.com'
}
}
// ...
}
}
devServetr
里面proxy
则是关于代理的配置,该属性为对象的形式,对象中每一个属性就是一个代理的规则匹配
属性的名称是需要被代理的请求路径前缀,一般为了辨别都会设置前缀为/api
,值为对应的代理匹配规则,对应如下:
target
:表示的是代理到的目标地址pathRewrite
:默认情况下,我们的/api-hy
也会被写入到URL中,如果希望删除,可以使用pathRewrite
secure
:默认情况下不接收转发到https
的服务器上,如果希望支持,可以设置为false
changeOrigin
:它表示是否更新代理后请求的headers
中host
地址
2. 工作原理
proxy
工作原理实质上是利用http-proxy-middleware
这个http
代理中间件,实现请求转发给其他服务器
举个例子:
在开发阶段,本地地址为http://localhost:3000
,该浏览器发送一个前缀带有/api
标识的请求到服务端获取数据,但响应这个请求的服务器只是将请求转发到另一台服务器中
const express = require('express');
const proxy = require('http-proxy-middleware');
const app = express();
app.use('/api', proxy({target: 'http://www.example.org', changeOrigin: true}));
app.listen(3000);
// http://localhost:3000/api/foo/bar -> http://www.example.org/api/foo/bar
3. 跨域
在开发阶段,
webpack-dev-server
会启动一个本地开发服务器,所以我们的应用在开发阶段是独立运行在localhost
的一个端口上,而后端服务又是运行在另外一个地址上
所以在开发阶段中,由于浏览器同源策略的原因,当本地访问后端就会出现跨域请求的问题
通过设置webpack proxy
实现代理请求后,相当于浏览器与服务端中添加一个代理者
当本地发送请求的时候,代理服务器响应该请求,并将请求转发到目标服务器,目标服务器响应数据后再将数据返回给代理服务器,最终再由代理服务器将数据响应给本地
在代理服务器传递数据给本地浏览器的过程中,两者同源,并不存在跨域行为,这时候浏览器就能正常接收数据
注意:
「服务器与服务器之间请求数据并不会存在跨域行为,跨域行为是浏览器安全策略限制」
eval
模式:
- 生成代码通过
eval
执行 👇🏻
- 源代码位置通过
@sourceURL
注明 👇🏻
- 无法定位到错误位置,只能定位到某个文件
- 不用生成 SourceMap 文件,打包速度快
source-map
模式:
- 生成了对应的 SourceMap 文件,打包速度慢
- 在源代码中定位到错误所在行列信息 👇🏻
eval-source-map
模式:
- 生成代码通过
eval
执行 👇🏻
2. 包含 dataUrl 形式的 SourceMap 文件
- 可以在编译后的代码中定位到错误所在行列信息
- 生成 dataUrl 形式的 SourceMap,打包速度慢
eval-cheap-source-map
模式:
- 生成代码通过
eval
执行 - 包含 dataUrl 形式的 SourceMap 文件
- 可以在编译后的代码中定位到错误所在行信息
- 不需要定位列信息,打包速度较快
eval-cheap-module-source-map
模式:
- 生成代码通过
eval
执行 - 包含 dataUrl 形式的 SourceMap 文件
- 可以在编译后的代码中定位到错误所在行信息
- 不需要定位列信息,打包速度较快
- 在源代码中定位到错误所在行信息 👇🏻
inline-source-map
模式:
- 通过 dataUrl 的形式引入 SourceMap 文件 👇🏻
... 余下和 source-map
模式一样
hidden-source-map
模式:
- 看不到 SourceMap 效果,但是生成了 SourceMap 文件
nosources-source-map
模式:
- 能看到错误出现的位置 👇🏻
- 但是没有办法现实对应的源码
接下来,我们稍微总结一下:
devtool | build | rebuild | 显示代码 | SourceMap 文件 | 描述 |
---|---|---|---|---|---|
(none) | 很快 | 很快 | 无 | 无 | 无法定位错误 |
eval | 快 | 很快(cache) | 编译后 | 无 | 定位到文件 |
source-map | 很慢 | 很慢 | 源代码 | 有 | 定位到行列 |
eval-source-map | 很慢 | 一般(cache) | 编译后 | 有(dataUrl) | 定位到行列 |
eval-cheap-source-map | 一般 | 快(cache) | 编译后 | 有(dataUrl) | 定位到行 |
eval-cheap-module-source-map | 慢 | 快(cache) | 源代码 | 有(dataUrl) | 定位到行 |
inline-source-map | 很慢 | 很慢 | 源代码 | 有(dataUrl) | 定位到行列 |
hidden-source-map | 很慢 | 很慢 | 源代码 | 有 | 无法定位错误 |
nosource-source-map | 很慢 | 很慢 | 源代码 | 无 | 定位到文件 |
关键字 | 描述 |
---|---|
inline | 代码内通过 dataUrl 形式引入 SourceMap |
hidden | 生成 SourceMap 文件,但不使用 |
eval | eval(...) 形式执行代码,通过 dataUrl 形式引入 SourceMap |
nosources | 不生成 SourceMap |
cheap | 只需要定位到行信息,不需要列信息 |
module | 展示源代码中的错误位置 |
webpack import()原理
动态导入原理
用于动态加载的
import()
方法
- 这个功能可以实现按需加载我们的代码,并且使用了
promise
式的回调,获取加载的包 - 在代码中所有被
import()
的模块,都将打成一个单独的包,放在chunk
存储的目录下。在浏览器运行到这一行代码时,就会自动请求这个资源,实现异步加载
// 这里是一个简单的demo。
// 可以看到,import()的语法十分简单。该函数只接受一个参数,就是引用包的地址
import('lodash').then(_ => {
// Do something with lodash (a.k.a '_')...
})
webpack中如何实现动态导入?
使用import(/** webpackChunkName: "lodash" **/ 'lodash').then(_ => {})
,同时可以在webpack.config.js
中配置一下output的chunkFilename
为[name].bunld.js
将要导入的模块单独抽离到一个bundle
中,以此实现代码分离。
使用async
,由于import()
返回的是一个promise
, 因此我们可以使用async
函数来简化它,不过需要babel
这样的预处理器及处理转换async
的插件。const _ = await import(/* webpackChunkName: "lodash" */ 'lodash');
Webpack配置
Chunk
Chunk是Webpack打包过程中,一堆module的集合。Webpack通过引用关系逐个打包模块,这些module就形成了一个Chunk。
产生Chunk的三种途径
- entry入口
- 异步加载模块
- 代码分割(code spliting)
hash
模板 | 描述 |
---|---|
hash | 是跟整个项目的构建相关,只要项目里有文件更改,整个项目构建的hash 值都会更改,并且全部文件都共用相同的hash 值。(粒度整个项目) |
chunkhash | 是根据不同的入口进行依赖文件解析,构建对应的chunk (模块),生成对应的hash 值。只有被修改的chunk (模块)在重新构建之后才会生成新的hash 值,不会影响其它的chunk 。(粒度entry 的每个入口文件) |
contenthash | 是跟每个生成的文件有关,每个文件都有一个唯一的hash 值。当要构建的文件内容发生改变时,就会生成新的hash 值,且该文件的改变并不会影响和它同一个模块下的其它文件。(粒度每个文件的内容) |
hash 长度 | 默认20 ,可自定:[hash:8] 、[chunkhash:16] |
chunkhash
跟打包的chunk有关,具体来说webpack
是根据入口entry
配置文件来分析其依赖项并由此来构建该entry的chunk
,并生成对应的hash
值。不同的chunk
会有不同的hash
值。
在生产环境中,我们会把第三方或者公用类库进行单独打包,所以不改动公共库的代码,该chunk
的hash
就不会变,可以合理的使用浏览器缓存了。
但是这个中hash的方法其实是存在问题的,生产环境中我们会用webpack
的插件,将css
代码打单独提取出来打包。这时候chunkhash
的方式就不够灵活,因为只要同一个chunk
里面的js修改后,css
的chunk
的hash
也会跟随着改动。因此我们需要contenthash
。
contenthash
contenthash
表示由文件内容产生的hash
值,内容不同产生的contenthash
值也不一样。生产环境中,通常做法是把项目中css
都抽离出对应的css
文件来加以引用。
对于webpack,旧版本而言,即便每次你npm run build,内容不做修改的话,contenthash值还是会有所改变,这个是因为,当你在模块之间存在相互之间的引用关系,有一个manifest文件。
manifest文件是用来引导所以模块的交互,manifest文件包含了加载和处理模块的逻辑,举个例子,你的第三方库打包后的文件,我们称之为vendors,你的逻辑代码称为main,当你webpack生成一个bundle时,它同时会去维护一个manifest文件,你可以理解成每个bundle文件存在这里信息,所以每个bundle之间的manifest信息有不同,这样子我们就需要将manifest文件给提取出来。
这个时候,需要在optimization中增加一个配置👇
module.exports = {
optimization: {
splitChunks: {
// ...
},
runtimeChunk: {// 解决的问题是老版本中内容不发生改变的话,contenthash依旧会发生改变
name: 'manifest'
}
}
}
optimization
optimization
是webpack4
新增的,主要是用来让开发者根据需要自定义一些优化构建打包的策略配置minimize:true/false
,告诉webpack
是否开启代码最小化压缩minimizer
:自定js
优化配置,会覆盖默认的配置,结合UglifyJsPlugin
插件使用removeEmptyChunks: bool
值,它检测并删除空的块。将设置为false
将禁用此优化nodeEnv
:它并不是node
里的环境变量,设置后可以在代码里使用process.env.NODE_ENV === 'development'
来判断一些逻辑,生产环境UglifyJsPlugin
会自动删除无用代码splitChunks
:取代了CommonsChunkPlugin
,自动分包拆分、代码拆分,详细默认默认配置,只会作用于异步加载的代码块 ——chunks:'async'
,它有三个值:all
,async
,initial
//环境变更也可以直接 在启动中设置
//webpack --env.NODE_ENV=local --env.production --progress
//splitChunks 默认配置
splitChunks: {
chunks: 'async',
minSize: 30000,
maxSize: 0,
minChunks: 1,
maxAsyncRequests: 5,
maxInitialRequests: 3,
automaticNameDelimiter: '~',
name: true,
cacheGroups: {
vendors: {
test: /[\/]node_modules[\/]/,
priority: -10
},
default: {
minChunks: 2,
priority: -20,
reuseExistingChunk: true
}
}
}
splitChunks
-
在cacheGroups外层的属性设置适用于所有的缓存组,不过每个缓存组内部都可以重新设置它们的值
-
chunks: "async"
这个属性设置的是以什么类型的代码经行分隔,有三个值initial
入口代码块all
全部async
按需加载的代码块
-
minSize: 30000
模块大小超过30kb的模块才会提取 -
minChunks: 1
, 当某个模块至少被多少个模块引用时,才会被提取成新的chunk -
maxAsyncRequests: 5
,分割后,按需加载的代码块最多允许的并行请求数 -
maxInitialRequests: 3·
分割后,入口代码块最多允许的并行请求数 -
automaticNameDelimiter: "~"
代码块命名分割符 -
name: true,
每个缓存组打包得到的代码块的名称 -
cacheGroups
缓存组,定制相应的规则。 -
runtimeChunk
: 提取webpack
运行时代码,它可以设置为:boolean
、Object
-
该配置开启时,会覆盖 入口指定的名称
optimization: {
runtimeChunk:true,//方式一
runtimeChunk: {
name: entrypoint => `runtimechunk~${entrypoint.name}` //方式二
}
}
resolve - 配置模块如何解析
extensions
:自动解析确定的扩展,省去你引入组件时写后缀的麻烦,alias
:非常重要的一个配置,它可以配置一些短路径,modules
:webpack
解析模块时应该搜索的目录, 其他plugins
、unsafeCache
、enforceExtension
,基本没有怎么用到
//extensions 后缀可以省略,
import Toast from 'src/components/toast';
// alias ,短路径
import Modal from '../../../components/modal'
//简写
import Modal from 'src/components/modal'
resolve: {
extensions: ['.js', '.jsx','.ts','.tsx', '.scss','.json','.css'],
alias: {
src :path.resolve(__dirname, '../src'),
components :path.resolve(__dirname, '../src/components'),
utils :path.resolve(__dirname, '../src/utils'),
},
modules: ['node_modules'],
},