小程序路由 & 分包 & 预加载

最新推荐文章于 2024-08-09 14:38:42 发布

weixin79893765432...

最新推荐文章于 2024-08-09 14:38:42 发布

阅读量1.1k

点赞数 1

分类专栏：微信小程序文章标签：小程序

原文链接：https://developers.weixin.qq.com/miniprogram/dev/framework/subpackages.html

版权

微信小程序专栏收录该内容

40 篇文章 1 订阅

订阅专栏

一、分包

分包是为了满足：按需加载。

目前，小程序分包，大小有以下限制：

整个小程序所有分包大小不超过 8M
单个分包/主包大小不能超过 2M

1、独立分包

独立分包是小程序中一种特殊类型的分包，可以独立于主包和其他分包运行。从独立分包中页面进入小程序时，不需要下载主包。当用户进入普通分包或主包内页面时，主包才会被下载；
开发者可以按需分配页面的功能到独立分包中；
一个小程序中可以有多个独立分包。

（1）、配置方法

假设小程序目录结构如下：

├── app.js
├── app.json
├── app.wxss
├── moduleA
│   └── pages
│       ├── rabbit
│       └── squirrel
├── moduleB
│   └── pages
│       ├── pear
│       └── pineapple
├── pages
│   ├── index
│   └── logs
└── utils

开发者通过在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
    }
  ]
}

（2）、限制

独立分包属于分包的一种。普通分包的所有限制都对独立分包有效。独立分包中插件、自定义组件的处理方式同普通分包。

此外，使用独立分包时要注意：

独立分包中不能依赖主包和其他分包中的内容，包括js文件、template、wxss、自定义组件、插件等。主包中的app.wxss对独立分包无效，应避免在独立分包页面中使用 app.wxss 中的样式；
App 只能在主包内定义，独立分包中不能定义 App，会造成无法预期的行为；
独立分包中暂时不支持使用插件。

（3）、注意事项

关于 getApp()

与普通分包不同，独立分包运行时，App 并不一定被注册，因此 getApp() 也不一定可以获得 App 对象：

①、当用户从独立分包页面启动小程序时，主包不存在，App也不存在，此时调用 getApp() 获取到的是 undefined。当用户进入普通分包或主包内页面时，主包才会被下载，App 才会被注册。

②、当用户是从普通分包或主包内页面跳转到独立分包页面时，主包已经存在，此时调用 getApp() 可以获取到真正的 App。

由于这一限制，开发者无法通过 App 对象实现独立分包和小程序其他部分的全局变量共享。

为了在独立分包中满足这一需求，基础库 2.2.4 版本开始 getApp支持 [allowDefault]参数，在 App 未定义时返回一个默认实现。当主包加载，App 被注册时，默认实现中定义的属性会被覆盖合并到真正的 App 中。

示例代码：

a、独立分包中

const app = getApp({allowDefault: true}) // {}
app.data = 456
app.global = {}

b、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 监听。

2、使用分包

（1）、配置方法

假设支持分包的小程序目录结构如下：

├── app.js
├── app.json
├── app.wxss
├── packageA
│   └── pages
│       ├── cat
│       └── dog
├── packageB
│   └── pages
│       ├── apple
│       └── banana
├── pages
│   ├── index
│   └── logs
└── utils

开发者通过在 app.json subpackages 字段声明项目分包结构：

写成 subPackages 也支持。

{
  "pages":[
    "pages/index",
    "pages/logs"
  ],
  "subpackages": [
    {
      "root": "packageA",
      "pages": [
        "pages/cat",
        "pages/dog"
      ]
    }, {
      "root": "packageB",
      "name": "pack2",
      "pages": [
        "pages/apple",
        "pages/banana"
      ]
    }
  ]
}

subpackages 中，每个分包的配置有以下几项：

字段	类型	说明
root	String	分包根目录
name	String	分包别名，分包预下载时可以使用
pages	StringArray	分包页面路径，相对与分包根目录
independent	Boolean	分包是否是独立分包

（2）、打包原则

声明 subpackages 后，将按 subpackages 配置路径进行打包，subpackages 配置路径外的目录将被打包到 app（主包）中；
app（主包）也可以有自己的 pages（即最外层的 pages 字段）；
subpackage 的根目录不能是另外一个 subpackage 内的子目录；
tabBar 页面必须在 app（主包）内。

（3）、引用原则

packageA 无法 require packageB JS 文件，但可以 require app、自己 package 内的 JS 文件；
packageA 无法 import packageB 的 template，但可以 require app、自己 package 内的 template；
packageA 无法使用 packageB 的资源，但可以使用 app、自己 package 内的资源。

二、分包预加载

开发者可以通过配置，在进入小程序某个页面时，由框架自动预加载可能需要的分包；
目前，分包预加载只支持通过配置方式使用，暂不支持通过调用API完成。

1、配置方法

预加载分包行为在进入某个页面时触发，通过在 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下预加载

2、限制

同一个分包中的页面享有共同的预加载大小限额 2M，限额会在工具中打包时校验。

如，页面 A 和 B 都在同一个分包中，A 中预加载总大小 0.5M 的分包，B中最多只能预加载总大小 1.5M 的分包。

三、实战

需求：将项目分包，分出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"
      ]
    }
  }
}

感悟：