使用场景:开发各种小程序时候遇到主包过大,无法上传的情况
小程序的分包机制:
小程序启动时,默认会下载主包并启动主包内页面,当用户进入分包内某个页面时,会把对应分包自动下载下来,下载完成后再进行展示。此时终端界面会有等待提示。
所以分包后的页面是在打开分包内的某个页面以后才会加载分包的内容
每个使用分包小程序必定含有一个主包。所谓的主包,即放置默认启动页面/TabBar 页面,以及一些所有分包都需用到公共资源/JS 脚本;而分包则是根据开发者的配置进行划分。
目前小程序分包大小有以下限制:
- 整个小程序所有分包大小不超过 20M
- 单个分包/主包大小不能超过 2M
对小程序进行分包,可以优化小程序首次启动的下载时间,以及在多团队共同开发时可以更好的解耦协作。
分包下支持独立的 static 目录,用来对静态资源进行分包。
1.首先,在目录结构里原本已经有一个pages的包(文件夹)了,这时候在pages同级里新建一个packageA包 并新建页面
2.配置pages.json
在pages.json中新建数组"subPackages",数组中包含两个参数:1.root:为子包的根目录,2.pages:子包由哪些页面组成,参数同pages;
{
"pages":[
"pages/index",
"pages/logs"
],
"subpackages": [
{
"root": "packageA", //分包根目录
"pages": [ //分包页面路径,相对于分包根目录
"pages/cat",
"pages/dog"
]
}, {
"root": "packageB",
"name": "pack2", //分包别名,分包预下载时可以使用
"pages": [
"pages/apple",
"pages/banana"
]
}
]
}
独立分包
独立分包是小程序中一种特殊类型的分包,可以独立于主包和其他分包运行。从独立分包中页面进入小程序时,不需要下载主包。当用户进入普通分包或主包内页面时,主包才会被下载。
开发者可以按需将某些具有一定功能独立性的页面配置到独立分包中。当小程序从普通的分包页面启动时,需要首先下载主包;而独立分包不依赖主包即可运行,可以很大程度上提升分包页面的启动速度
一个小程序中可以有多个独立分包
开发者通过在app.json
的subpackages
字段中对应的分包配置项中定义independent
字段声明对应分包为独立分包。
{
"pages": [
"pages/index",
"pages/logs"
],
"subpackages": [
{
"root": "moduleA",
"pages": [
"pages/rabbit",
"pages/squirrel"
]
}, {
"root": "moduleB",
"pages": [
"pages/pear",
"pages/pineapple"
],
"independent": true
}
]
}
限制
独立分包属于分包的一种。普通分包的所有限制都对独立分包有效。独立分包中插件、自定义组件的处理方式同普通分包。
此外,使用独立分包时要注意:
- 独立分包中不能依赖主包和其他分包中的内容,包括 js 文件、template、wxss、自定义组件、插件等(使用 分包异步化 时 js 文件、自定义组件、插件不受此条限制)
- 主包中的
app.wxss
对独立分包无效,应避免在独立分包页面中使用app.wxss
中的样式; App
只能在主包内定义,独立分包中不能定义App
,会造成无法预期的行为;- 独立分包中暂时不支持使用插件
注意事项
(1)关于getApp():
与普通分包不同,独立分包运行时,App
并不一定被注册,因此 getApp()
也不一定可以获得 App
对象:
- 当用户从独立分包页面启动小程序时,主包不存在,
App
也不存在,此时调用getApp()
获取到的是undefined
。 当用户进入普通分包或主包内页面时,主包才会被下载,App
才会被注册。 - 当用户是从普通分包或主包内页面跳转到独立分包页面时,主包已经存在,此时调用
getApp()
可以获取到真正的App
。
为了在独立分包中满足这一需求,基础库 2.2.4 版本开始 getApp
支持 [allowDefault
] 参数,在 App
未定义时返回一个默认实现。当主包加载,App
被注册时,默认实现中定义的属性会被覆盖合并到真正的 App
中。
独立分包中:
const app = getApp({allowDefault: true}) // {}
app.data = 456
app.global = {}
(2)关于app的生命周期:
当从独立分包启动小程序时,主包中 App
的 onLaunch
和首次 onShow
会在从独立分包页面首次进入主包或其他普通分包页面时调用。
由于独立分包中无法定义 App
,小程序生命周期的监听可以使用 wx.onAppShow,wx.onAppHide 完成。App
上的其他事件可以使用 wx.onError,wx.onPageNotFound 监听。
分包预加载
预加载分包行为在进入某个页面时触发,通过在 app.json
增加 preloadRule
配置来控制。
preloadRule
中,key
是页面路径,value
是进入此页面的预下载配置,每个配置有以下几项:
字段 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
packages | StringArray | 是 | 无 | 进入页面后预下载分包的 root 或 name 。__APP__ 表示主包。 |
network | String | 否 | wifi | 在指定网络下预下载,可选值为:all(不限网络)、wifi(仅wifi下预下载) |
{
"pages": [{
"path": "pages/index/index",
"style": { ...}
}, {
"path": "pages/login/login",
"style": { ...}
}],
"subPackages": [{
"root": "pagesA",
"pages": [{
"path": "list/list",
"style": { ...}
}]
}, {
"root": "pagesB",
"pages": [{
"path": "detail/detail",
"style": { ...}
}]
}],
"preloadRule": {
"pagesA/list/list": {
"network": "all",
"packages": ["__APP__"]
},
"pagesB/detail/detail": {
"network": "all",
"packages": ["pagesA"]
}
}
}
三、实战
需求:将项目分包,分出function和produts两个包,然后,在index首页面加载的时候,预加载function包。
{
"pages": [
"pages/index/index",
"pages/views/welcome/index",
"pages/views/my/index",
"pages/logs/logs",
"pages/other/index"
],
"subPackages":[
{
"root" : "pages/views/function/",
"name" : "function",
"pages" : [
"preDownload01/index",
"form/index"
]
},
{
"root" : "pages/views/products/",
"name" : "produts",
"pages" : [
"ylS1908001/index",
"ylS1908002/index",
"ylS1908003/index",
"ylS1908004/index",
"ylS1908005/index"
]
}
],
"preloadRule":{
"pages/index/index":{
"network" : "all",
"packages" : [
"function"
]
}
}
}