此文较为详细的介绍了分包的使用包括独立分包,以及一些注意事项,希望大家能够耐心的看下去
背景介绍
微信限制了代码包不能超过 2MB,限制大小是出于对小程序启动速度的考虑,希望用户在使用任何一款小程序时,都能获得一种“秒开”体验。然而,2MB 的大小也限制了小程序功能的扩展,小程序业务的发展可能需要更大的体积。那么有没有一种办法,在增加小程序包的同时,也能保持不错的体验速度呢?
为了解决这个矛盾点,微信推出了“分包加载方案”
原理介绍
在小程序启动时,默认会下载主包并启动主包内页面,如果用户需要打开分包内某个页面,客户端会把对应分包下载下来,下载完成后再进行展示。
分包类型
普通分包与独立分包。独立分包是小程序中一种特殊类型的分包,可以独立于主包和其他分包运行。从独立分包中页面进入小程序时,不需要下载主包。当用户进入普通分包或主包内页面时,主包才会被下载。一个小程序中可以有多个独立分包。
小游戏不支持独立分包
使用分包
配置方法:假设支持分包的小程序目录结构如下:
├── app.js
├── app.json
├── app.wxss
├── moduleA
│ └── pages
│ ├── rabbit
│ └── squirrel
├── packageA
│ └── pages
│ ├── cat
│ └── dog
├── packageB
│ └── pages
│ ├── apple
│ └── banana
├── pages
│ ├── index
│ └── logs
└── utils
开发者通过在 app.json subpackages
字段声明项目分包结构:
{
"pages":[
"pages/index",
"pages/logs"
],
"subpackages": [
{
"root": "packageA",
"pages": [
"pages/cat",
"pages/dog"
]
}, {
"root": "packageB",
"name": "pack2",
"pages": [
"pages/apple",
"pages/banana"
]
},{
"root": "moduleA",
"pages": [
"pages/rabbit",
"pages/squirrel"
],
"independent": true
}
]
}
注:其中moduleA为独立分包 (independent
字段声明对应分包为独立分包)
字段 | 类型 | 说明 |
---|---|---|
root | String | 分包根目录 |
name | String | 分包别名,分包预下载时可以使用 |
pages | StringArray | 分包页面路径,相对与分包根目录 |
independent | Boolean | 分包是否是独立分包 |
此外,使用独立分包时要注意:
-
独立分包中不能依赖主包和其他分包中的内容,包括js文件、template、wxss、自定义组件、插件等。主包中的
app.wxss
对独立分包无效,应避免在独立分包页面中使用app.wxss
中的样式; -
App
只能在主包内定义,独立分包中不能定义App
,会造成无法预期的行为; - 独立分包中暂时不支持使用插件。
注意事项:
-
关于
getApp()
与普通分包不同,独立分包运行时,App
并不一定被注册,因此getApp()
也不一定可以获得App
对象:- 当用户从独立分包页面启动小程序时,主包不存在,
App
也不存在,此时调用getApp()
获取到的是undefined
。 当用户进入普通分包或主包内页面时,主包才会被下载,App
才会被注册。 - 当用户是从普通分包或主包内页面跳转到独立分包页面时,主包已经存在,此时调用
getApp()
可以获取到真正的App
。
由于这一限制,开发者无法通过
App
对象实现独立分包和小程序其他部分的全局变量共享。
为了在独立分包中满足这一需求,基础库 2.2.4 版本开始getApp
支持 [allowDefault
]参数,在App
未定义时返回一个默认实现。当主包加载,App
被注册时,默认实现中定义的属性会被覆盖合并到真正的App
中。 - 当用户从独立分包页面启动小程序时,主包不存在,
示例代码:
- 独立分包中
const app = getApp({allowDefault: true}) // {}
app.data = 456
app.global = {}
- app.js 中
App({
data: 123,
other: 'hello'
})
console.log(getApp()) // {global: {}, data: 456, other: 'hello'}
-
关于
App
生命周期
当从独立分包启动小程序时,主包中App
的onLaunch
和首次onShow
会在从独立分包页面首次进入主包或其他普通分包页面时调用。由于独立分包中无法定义
App
,小程序生命周期的监听可以使用 wx.onAppShow,wx.onAppHide 完成。App
上的其他事件可以使用 wx.onError,wx.onPageNotFound 监听。
分包预下载
开发者可以通过配置,在进入小程序某个页面时,由框架自动预下载可能需要的分包,提升进入后续分包页面时的启动速度。对于独立分包,也可以预下载主包
配置方法:
预下载分包行为在进入某个页面时触发,通过在 app.json
增加 preloadRule
配置来控制。
{
"pages": ["pages/index"],
"subpackages": [
{
"root": "important",
"pages": ["index"],
},
{
"root": "sub1",
"pages": ["index"],
},
{
"name": "hello",
"root": "path/to",
"pages": ["index"]
},
{
"root": "sub3",
"pages": ["index"]
},
{
"root": "indep",
"pages": ["index"],
"independent": true
}
],
"preloadRule": {
"pages/index": {
"network": "all",
"packages": ["important"]
},
"sub1/index": {
"packages": ["hello", "sub3"]
},
"sub3/index": {
"packages": ["path/to"]
},
"indep/index": {
"packages": ["__APP__"]
}
}
}
preloadRule
中,key
是页面路径,value
是进入此页面的预下载配置,每个配置有以下几项:
字段 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
packages | StringArray | 是 | 无 | 进入页面后预下载分包的 root 或 name 。__APP__ 表示主包。 |
network | String | 否 | wifi | 在指定网络下预下载,可选值为:all : 不限网络wifi : 仅wifi下预下载 |
适用版本
微信客户端 6.6.0,基础库 1.7.3 及以上版本开始支持。开发者工具请使用 1.01.1712150 及以上版本
分包限制
- 整个小程序所有分包大小不超过 12M
- 单个分包/主包大小不能超过 2M
分包好处
- 对小程序进行分包,可以优化小程序的首次启动的下载时间
- 在多团队共同开发的时候可以更好的解耦操作
打包原则
- 声明
subpackages
后,将按subpackages
配置路径进行打包,subpackages
配置路径外的目录将被打包到 app(主包) 中 - app(主包)也可以有自己的 pages(即最外层的 pages 字段)
-
subpackage
的根目录不能是另外一个subpackage
内的子目录 -
tabBar
页面必须在 app(主包)内
引用原则
-
packageA
无法 requirepackageB
JS 文件,但可以 requireapp
、自己 package 内的 JS 文件 -
packageA
无法 importpackageB
的 template,但可以 requireapp
、自己 package 内的 template -
packageA
无法使用packageB
的资源,但可以使用app
、自己 package 内的资源