@mpxjs/size-report
v2.9.26
Published
mpx size report plugin
Downloads
89
Readme
包体积分析
目前业内主流小程序平台都对小程序的代码包设置了严格的体积限制，微信是单包 2MB，总包 16MB，支付宝是单包 2MB，总包 8MB；包体积作为有限的资源，在小程序业务开发中异常重要，特别对于像滴滴出行这样的大型复杂业务。
Mpx 在包体积控制上做了很多工作，主要包括：
此外由于 Mpx 的编译构建完全基于 webpack，也能够直接复用webpack生态自带的代码压缩，模块复用，tree shaking，side effects 等能力对代码体积进行优化。
但是系统能做的工作终究有限，在一些人为不规范操作的影响下，最终输出的项目依然可能存在大量优化空间，比如在业务中不会被调用但无法被 tree shaking / side effects 移除的代码，因为 npm 依赖版本不统一造成的重复依赖，未经压缩的图像静态资源等，在大型项目中，这些问题想要被发现会非常困难，因此我们非常需要一个体积分析工具来管控项目体积和发现隐藏的体积问题。
与 webpack-bundle-analyzer 的区别
webpack-bundle-analyzer 提供了非常完善的体积分析和可视化展示能力，但是在 Mpx 构建输出小程序场景下，其所提供的能力还是有所缺失：
- 只能对 js 资源进行模块体积分析，而小程序的输出中包含了大量的非 js 静态资源，如 wxss / wxml / json 等，这些资源的体积都不会被统计分析；
- 没有针对某个分包进行体积分析的能力，由于小程序中存在对单一分包的体积限制，我们的体积往往会集中在主包和主要业务分包中，以分包维度进行体积分析的能力非常必要；
- 无法以特定的输入范围为维度进行体积的统计分析，这个能力诉求更多地出现在跨团队合作的复杂小程序当中，如滴滴出行。在这种场景下，接入合作的各方会更加关注己方引入的体积，并进行针对性地优化。
由于上述原因，我们提供了@mpxjs/size-report插件提供包体积分析能力，弥补了 webpack-bundle-analyzer 的能力缺失，为业务提供了便捷准确的包体积管控优化抓手。
使用方法
安装插件
npm i @mpxjs/size-report --save-dev配置插件
在项目 webpack.config 文件中配置使用 @mpxjs/size-report 插件即可使用，简单示例如下：
const MpxSizeReportPlugin = require('@mpxjs/size-report')
{
plugins: [
new MpxSizeReportPlugin({
// 本地可视化服务相关配置
server: {
enable: true, // 是否启动本地服务，非必填，默认 true
autoOpenBrowser: true, // 是否自动打开可视化平台页面，非必填，默认 true
port: 0, // 本地服务端口，非必填，默认 0(随机端口)
host: '127.0.0.1', // 本地服务host，非必填
},
// group 阈值校验时忽略该分包体积，总包体积校验时也会忽略该分包体积
ignoreSubpackages: ['new-homepage'],
// 体积报告生成后输出的文件地址名，路径相对为 dist/wx 或者 dist/ali
filename: '../report.json',
// 配置阈值，此处代表总包体积阈值为 16MB，分包体积阈值为 2MB，超出将会触发编译报错提醒，该报错不阻断构建
threshold: {
size: '16MB',
packages: '2MB'
},
// 配置体积计算分组，以输入分组为维度对体积进行分析，当没有该配置时结果中将不会包含分组体积信息
groups: [
{
// 分组名称
name: 'vant',
// 配置分组 entry 匹配规则，小程序中所有的页面和组件都可被视为 entry，如下所示的分组配置将计算项目中引入的 vant 组件带来的体积占用
entryRules: {
include: '@vant/weapp'
}
},
{
name: 'pageGroup',
// 每个分组中可分别配置阈值，如果不配置则表示没任何限制
threshold: {
size: '500KB',
preWarningSize: true// 可选项，开启分组体积阈值预警，会以warning的形式在每次构建后输出当前分组的剩余体积
},
entryRules: {
include: ['src/pages/index', 'src/pages/user']
}
},
{
name: 'someSdk',
entryRules: {
include: ['@somegroup/someSdk/index', '@somegroup/someSdk2/index']
},
// 有的时候你可能希望计算纯 js 入口引入的体积（不包含组件和页面），这种情况下需要使用 noEntryModules
noEntryModules: {
include: 'src/lib/sdk.js'
}
}
],
// 配置模块引用链路记录规则，符合规则的模块的引用关系会输出在moduleEntryGraph中
needEntryPathRules: {
include: [
'src/components/tools.js'
]
},
// 是否收集页面维度体积详情，默认 false
reportPages: true,
// 是否收集资源维度体积详情，默认 false
reportAssets: true,
// 是否收集冗余资源，默认 false
reportRedundance: true
})
]
}参考上述示例进行配置后，构建代码后，dist 目录下会产出 report.json 文件，里边是项目的具体体积信息，关于输入 json 的简单示例如下：
{
// 项目体积概要，大部分情况下，我们只需要看这部分就足够了
"sizeSummary": {
// 项目各个分包以及主包体积概要
"sizeInfo": {
"main": "1000KiB",
"fenbao1": "200kiB"
},
// 项目总体积
"totalSize": "13468.85KiB",
// 项目静态资源总体积
"staticSize": "4880.58KiB",
// 项目chunk 文件总体积
"chunkSize": "8587.70KiB",
// 非依赖项体积大小
"copySize": "1KiB"
},
// 分组资源详细体积
"groupsSizeInfo": [
{
"name": "groupOne",
// group 自身包含的 module 详情列表
"selfEntryModules": [],
// group 与其他group 共有的 module 详情列表
"sharedEntryModules": [],
// 自身包含 module 体积
"selfSize": "",
// 自身包含 module 体积详情
"selfSizeInfo": {
"main": {},
"homepage": {}
},
// 与其他 group 共有 module 体积
"sharedSize": "",
// 与其他 group 共有 module 体积详情
"sharedSizeInfo": {
"main": {},
"homepage": {}
},
}
],
// 页面维度的体积详情
"pagesSizeInfo": [
{
"name": "pages/index",
"resourcePath": "/mpx-webpack5-beta-test/src/pages/index.mpx",
"selfSize": "0.43KiB",
"selfSizeInfo": {},
"sharedSize": "75.44KiB",
"sharedSizeInfo": {}
}
],
// 项目资源详细体积报告
"assetsSizeInfo": {
"assets": [{
// 资源类型
"type": "chunk",
"name": "test",
// 分包名
"packageName": "main",
"size": "",
"modules": []
}]
},
// 项目的冗余资源信息
"redundanceSizeInfo": [
{
"resourcePath": "src/components/index.mpx",
"redundantSize": "8.24KiB",
"packages": {
"package1": "4.12KiB",
"package2": "4.12KiB",
"package3": "4.12KiB"
}
}
],
// 模块引用关系图
"moduleEntryGraph": {
"8": {
// 是否为目标模块
"target":false,
"parents":[],
"children":[9, 12],
"identifier":"src/app.mpx"
},
"9": {
"target":true,
"parents":[8, 12],
"children":[],
"identifier":"src/components/tools.js"
},
"12": {
"target":false,
"parents":[8],
"children":[9],
"identifier":"src/components/index.mpx"
}
}
}与此同时，如果你开启了本地可视化平台服务，可以直接通过可视化平台查看项目体积构成。默认开启自动打开平台网页或者手动打开后，整体页面展示如下图：
可视化平台中包含三部分功能，第一个体积分析如上图所示，主要是展示整体项目的体积总览，以及 group 体积列表和分包体积列表。
第二个功能是体积详情模块，在该模块中，可以最小颗粒度的查看包体积构成，通过 table 表格的层层展开可看到每个 group 中包含的分包，点击分包可看到该分包包含的静态资源和 js 模块详细列表，同时聚合模式可将分散的模块整合为具体的npm包名，方便宏观查看。此外为了方便用户定向查看某个特定资源的分布情况，列表上方可进行资源路径/名称搜索，该搜索支持模糊匹配，搜索结果为该资源在项目中 group 和 分包的分布情况。
第三个功能为体积对比功能，这里主要进行项目不同版本之间的体积大小变化比较，体积对比依赖插件生成的json文件，通过该功能，可具体的分析出包体积具体增大的group，分包，以及模块，给包体积优化提供定向目标。
业务实践
目前 sizeReport 工具在滴滴出行小程序, 花小猪, 青桔骑行, 特惠出行小程序以及一部分外部小程序中使用。
在滴滴出行小程序中，配置使用 @mpxjs/size-report 插件后使包体积管控和优化更加工程化：
在 sizeReport 检测结果文件中，通过对 groupsSizeInfo 和 assetsSizeInfo 中assets 与 module 体积分析，我们发现了部分体积较大图片文件和css资源，通过将图片存 CDN 和删除冗余文件；
基于各小程序平台对小程序总包，主包，分包有大小限制的原则，给各接入方配置了主包和首页分包体积大小占比阈值，在构建时检测到包体积超过阈值时，抛出 error 阻断构建，开发者可通过 size-report.json 中详细的包体积分析准确的找到体积变动点。
总结
Mpx sizeReport 工具对小程序体积计算有更细微(模块级别)的体积展示。 更加适合小程序开发场景的包体积分析。