初识小程序-分包/独立分包

194 阅读5分钟

什么是分包

分包是把一个完整的小程序项目,按照要求划分为不同的子包,在构建时打包成不同的分包,用户在使用时按需进行加载

分包好处

  • 可以优化小程序首次启动的下载时间
  • 多团队共同开发时可以更好的解耦协作

分包项目构成

分包前,小程序项目中所有的页面资源都被打包到了一起,导致整个项目体积过大,影响小程序首次启动的下载时间

分包后,小程序项目由1个主包+多个分包组成:

主包:一般只包含项目的启动页面TarBar页面、以及所有的分包都需要用到的一些公共资源

分包:只包含和当前分包有关的页面和私有资源

image.png

分包的加载规则

  1. 小程序启动时,默认会下载主包启动主包内页面
  • tabBar页面需要放到主包中
  1. 当用户进入某个页面时,客户端会把对应分包下载下来,下载完成再进行展示
  • 非tarBar页面可以按照功能的不同,划分为不同的分包之后,进行按需下载

分包体积限制

  • 整个小程序所有分包大小不能超过16M(主包+所有分包)
  • 单个分包/主包大小不能超过2M 配置方法 如:

image.png

开发者通过在app.jsonsubpackages字段中对应的分包配置项中定义independent字段声明对应分包为独立分包。

{
  // 主包的所有页面,tabBar页面只能放在主包里 pages 下
  "pages": [
    "pages/index",
    "pages/logs"
  ],
  "subpackages": [ // 通过subpackages节点,声明分包的结构
    {
      "root": "moduleA", // 第一个分包的根目录
      "pages": [ // 当前分包下,所有页面的相对路径
        "pages/rabbit",
        "pages/squirrel"
      ]
    }, {
      "root": "moduleB",
      "name":"packageB", // 分包别名
      "pages": [
        "pages/pear",
        "pages/pineapple"
      ],
      "independent": true
    }
  ]
}

打包原则

  • 小程序会按subpackages的配置进行分包,subpackages之外的目录将会被打包到主包中
  • 主包也可以有自己的pages(即最外层的pages字段)
  • tarBar页面必须在主包内
  • 分包之间不能互相嵌套

资源引用原则

  • 主包无法引用分包内的私有资源
  • 分包之间不能相互引用私有资源
  • 分包可以引用主包内的公共资源

独立分包

独立分包本质上也是分包,只不过它比较特殊,可以独立于主包和其他分包而单独运行

如:用户打开小程序时,默认只能先进入主包里面,通过主包启动小程序,当小程序启动成功够,可以由主包进入到其他的分包【用户在默认情况下是无法由分包打开小程序的】

如确实需要通过分包打开小程序,这时就需要独立分包,小程序中,用户可以直接进入分包启动小程序,用户就可以在不打开主包的前提下,启动小程序

独立分包与普通分包的区别

最主要区别:是否依赖于主包才能运行

  • 普通分包必须依赖于主包才能运行
  • 独立分包可以在不下载主包的情况下,独立运行

独立分包应用场景 开发者可以按需,将某些具有一定功能独立性的页面配置到独立分包中。原因如下:

  • 当小程序从普通分包启动时,需要首先下载主包
  • 而独立分包不依赖主包即可运行,可以很大程度上提升分包页面的启动速度

注:一个小程序可以有多个独立分包

独立分包的配置方法

项目目录如:

image.png

通过在app.jsonsubpackages字段中对应的分包配置项中定义independent字段声明对应分包为独立分包。

{
  "pages": [
    "pages/index",
    "pages/logs"
  ],
  "subpackages": [
    {
      "root": "moduleA",
      "pages": [
        "pages/rabbit",
        "pages/squirrel"
      ]
    }, {
      "root": "moduleB",
      "pages": [
        "pages/pear",
        "pages/pineapple"
      ],
      "independent": true
    }
  ]
}

引用原则

独立分包和普通分包以及主包之间,是相互隔绝的,不能相互引用彼此的资源。如:

  1. 主包无法引用独立分包内的私有资源
  2. 独立分包之间,不能相互引用私有资源
  3. 独立分包和普通分包之间,不能相互引用私有资源
  4. 特别注意:独立分包中不能引用主包内的公共资源

分包预下载

分包预下载是指:在进入小程序的某个页面时,由框架自动预下载可能需要的分包,从而提升进入后续分包页面时启动速度。

使用场景:用在户某个页面,可能进入某个分包,这时就可以使用分包预下载

预下载分包行为在进入某个页面时触发,通过在 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:不限网络 wifi:仅限wifi模式下进行预下载(某人WiFi)
      "network": "all", 
      // packages 进入页面后,预下载哪些分包
      // 可以通过 root 和 name 指定预下载哪些分包
      "packages": ["important"] 
    },
    "sub1/index": {
      "packages": ["hello", "sub3"]
    },
    "sub3/index": {
      "packages": ["path/to"]
    },
    "indep/index": {
      "packages": ["__APP__"]
    }
  }
}

分包预下载限制

同一个分包中的页面享有共同的预下载大小限额 2M,限额会在工具中打包时校验。如果超过,可能预下载失败

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