研究背景
上个月团队很多人都在反馈有个项目打包速度越来越慢,打包发布一次至少要半个小时,这个速度不仅我们接受不了,测试那边也多次反馈发布进度卡在前端,因此对该项目进行了打包优化。
对项目进行 bundle 分析
优化前
目前线上splitChunks.cacheGroups配置如下:
优化前,我们项目在生产环境打包需要14min,通过bundle分析不难发现,并且多个页面都重复打包了arco-design等,很多应该抽离的chunk并没有抽取,导致最终产物极大。这也是打包时间缓慢的重要原因。究其根本原因:default配置没有起作用;按照我们的期望当一个modules被两个或两个以上的chunk共用时,应该就会被提取成独立的chunk,但是结果事与愿违,从bundle分析结果图可以看出arco-design明明被多个chunk共用,却并没有触发该配置。
优化后
定位到问题是default配置没有生效后,我们就针对default进行了一系列的修改,发现当我们将maxAsyncRequests设置为30的时候,default配置起作用了,最终抽离公用chunk,将打包大小降为30M左右,足足缩小了90%。线上打包时间更是缩短到了2.5min左右。 为什么配置maxAsyncRequests才能按照我们的期望进行分包?maxAsyncRequests又是什么?webpack的分包逻辑到底是如何运行的?一系列的问题就需要从webpack的源码出发进行解答了。
Module和Chunk的关系
由于下文会频繁的出现module和chunk,所以首先单独介绍一下Module和Chunk的关系以及这两者是什么?首先通过一个关系图来理解:
- 对于一份同逻辑的代码,当我们手写下一个一个的文件,它们无论是 ESM 还是 commonJS 或是 AMD,他们都是 module
- 当我们写的 module 源文件传到 webpack 进行打包时,webpack 会根据文件引用关系生成 chunk 文件,webpack 会对这个 chunk 文件进行一些操作
SplitChunksPlugin
我们项目的webpack版本为4.44.2,因此选择这个版本的webpack进行源码解析,进一步了解SplitChunksPlugin如何进行打包的。
SplitChunksPlugin 引入缓存组(cacheGroups)对模块(module)进行分组,每个缓存组根据规则将匹配到的模块分配到代码块(chunk)中,每个缓存组的打包结果可以是单一 chunk,也可以是多个 chunk。webpack 的默认优化就是通过 SplitChunksPlugin 配置实现的,具体可参考官方文档。
默认配置
实际开发会发现哪怕SplitChunksPlugin什么也没有配置,生产环境下还是会按照一些规则进行打包,为什么会这样?这就需要从源码找答案,webpack4有一个文件叫做WebpackOptionsDefaulter.js,在这个文件中有一系列的默认配置。文件的第226行-256行:
从源码可以看出,SplitChunksPlugin的默认配置在不同的环境下也有变化,比如minSize在生产环境是30000字节,而非生产环境是10000字节。但是官方文档并没有展示这些细节,估计是默认我们最终都会将代码打包到生产环境,但是实际中,我们会在不同模式下切换,因此还是需要注意到这些细节,毕竟开发环境的打包速度也是我们需要关心的。
基本属性
结合前面提到的默认配置的源码,可以确定生产模式下,SplitChunksPlugin的默认配置如下:
这些配置都是什么意义和作用的?一个一个来看:
- chunks: 指的的那些chunks需要进行优化,是一个字符串类型,有效值是:all,async和initial。
async
这个值表示按需引入的模块将会被用于优化。initial
表示项目中被直接引入的模块将会被用于优化。all
顾名思义,表明直接引入和按需引入的模块都会被用于优化。
- minSize: 打包优化完生成的新chunk大小要> 30000字节,否则不生成新chunk。
- minChunks: 共享该module的最小chunk数
- maxAsyncRequests:最多有N个异步加载请求该module
- maxInitialRequests: 一个入口文件可以并行加载的最大文件数量
- automaticNameDelimiter:名字中间的间隔符
- name:chunk的名字,
- 如果设成true,会根据被提取的chunk自动生成。
- 值为 false 时,适合生产模式使用,webpack 会避免对 chunk 进行不必要的命名,以减小打包体积,除了入口 chunk 外,其他 chunk 的名称都由 id 决定,所以最终看到的打包结果是一排数字命名的 js,这也是为啥我们看线上网页请求的资源,总会掺杂一些 0.js,1.js 之类的文件(当然,使资源名为数字 id 的方式不止这一种,懒加载也能轻松办到)。
- 值为 string 时,缓存组最终会打包成一个 chunk,名称就是该 string。此外,当两个缓存组 name 一样,最终会打包在一个 chunk 中。你甚至可以把它设为一个入口的名称,从而将这个入口会移除。
- cacheGroups: 这个就是重点了,我们要切割成的每一个新chunk就是一个cache group。
- test:用来决定提取哪些module,可以接受字符串,正则表达式,或者函数,函数的一个参数为module,第二个参数为引用这个module的chunk(数组)。
- priority:优先级高的chunk为被优先选择(说出来感觉好蠢),优先级一样的话,size大的优先被选择。
- reuseExistingChunk: 当module未变时,是否可以使用之前的chunk。
- 要禁用任何默认缓存组,请将它们设置为
false
。例如 default:false
这些规则一旦制定,只有全部满足的模块才会被提取,所以需要根据项目情况合理配置才能达到满意的优化结果。
执行流程
首先看一下wbepack的主题流程:
流程图中展示了些核心任务点,简要说明下:
- 通过yargs解析config和shell的配置项
- webpack 初始化过程,首先会根据第一步的 options 生成 compiler 对象,然后初始化 webpack 的内置插件及 options 配置
- run 代表编译的开始,会构建 compilation 对象,用于存储这一次编译过程的所有数据
- make 执行真正的编译构建过程,从入口文件开始,构建模块,直到所有模块创建结束
- seal 生成 chunks,对 chunks 进行一系列的优化操作,并生成要输出的代码
- seal 结束后,Compilation 实例的所有工作到此也全部结束,意味着一次构建过程已经结束
Webpack 插件统一以 apply
方法为入口,然后注册优化事件,apply
方法接收一个参数,该参数是webpack初始化过程中生成的compiler
对象的引用,从而可以在回调函数中访问到 compiler
对象。
SplitChunksPlugin逻辑都在 SplitChunksPlugin.js 中:
从源码中可以看到两个重要的对象compiler
和compilation
,这两个对象是连接plugin和webpack的重要桥梁。官方API
在编译过程中,SplitChunksPlugin监听了optimizeChunksAdvanced
钩子;在块优化阶段的开始时,触发 optimizeChunksAdvanced
事件并传入 chunks
,开始代码分割优化过程,所有优化都在 optimizeChunksAdvanced
事件的回调函数中完成。
分块策略执行步骤
回调事件注册好后,接下来是核心的分块策略执行流程,这一块的代码较多,因此根据每块代码的作用,将执行过程分为三步:1、优化前准备阶段;2、模块分组阶段;3、依次检查阶段。
优化前准备阶段
在进行块优化前,首先要定义一些必要的方法和数据结构,在优化过程的每个阶段中都可能使用到这些方法和数据结构,具体流程如图:
接下来看具体代码,着重是流程图中红色部分:
前面这一块代码都是优化前的准备阶段,这个阶段最关键的点就是chunksInfoMap
和addModuleToChunksInfoMap
。
chunksInfoMap
存储着代码分割信息,每一项都是一个缓存组,对应于最终要分割出哪些额外代码块,会不断迭代,最终将代码分割结果加入results
中,而results
最终会生成我们见到的打包文件。这些缓存组还附带一些额外信息,比如 cacheGroup,就是我们配置的 cacheGroup 代码分割规则,用于后续校验;再比如 sizes,记录了缓存组中模块的总体积,用于之后判断是否符合我们配置的 minSize 条件。addModuleToChunksInfoMap
这个方法就是向chunksInfoMap
中添加新的代码分割信息(选中的chunk集合),在方法中会通过key去更新缓存组或者添加新的缓存组。
模块分组阶段
准备工作做好之后,开始核心的分组优化工作,遍历所有的models,将符合条件的module 通过 addModuleToChunksInfoMap
方法存到 chunksInfoMap
中。该代码在SplitChunksPlugin.js的565-670行:
chunksFilter是chunks
属性的过滤,即判断chunk是满足all
、async
还是initial
。因此在分组阶段,除了将 cacheGroup 的配置全部取出,还检查配置中的 minChunks
和 chunks
规则,满足条件的分组才会被创建出来。其他各种需要校验的配置会在下一个阶段做处理。
依次检查阶段
在上一个阶段,我们将模块按照按照一定条件分组,并存入了chunksInfoMap
中。本阶段就是优化的最后一步,判断chunksInfoMap
的每一个缓存组是不是符合用户的cacheGroup
配置,不满足就剔除。还是流程图出发:
经过本阶段的筛选,chunksInfoMap 中符合配置规则的缓存组会被全部打包成新代码块,完成代码分割的工作。
总结
以上就是SplitChunksPlugin的整个工作流程,从优化前准备到模块分组,最终依次检查,输出最终打包文件。不管是哪一个步骤都有着关键的作用。SplitChunksPlugin的源码我们不能修改,但是cacheGroups是交给我们配置的,合适cacheGroups配置,就能产出合适的chunksInfoMap,从而输出合适的分包结果。
分析源码的过程,可以看到整个过程并没有复杂的算法逻辑,而是合理的安排每一个步骤,在合适的时间做合适的事情,最终将一个庞大的项目分割成能够预测的结果。我们自己在开发过程中也应该学习这样的思想,不要过度设计,而是把复杂的设计简单化。当然简化流程的代价可能就是复杂的数据结构,这两者如何抉择还是因项目而异了。
常见问题FAQ
- 免费下载或者VIP会员专享资源能否直接商用?
- 本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用者承担。更多说明请参考 VIP介绍。
- 提示下载完但解压或打开不了?
- 找不到素材资源介绍文章里的示例图片?
- 模板不会安装或需要功能定制以及二次开发?
发表评论
还没有评论,快来抢沙发吧!