小程序分包详解与最佳实践

敲代码的玉米C
774 阅读7分钟

小程序分包详解与最佳实践

在小程序开发过程中，随着功能的不断增加，项目体积也会随之增大。为了优化用户体验，微信小程序平台推出了分包加载功能。本文将详细介绍小程序分包的概念、配置方法及最佳实践。

目录

什么是分包

分包指的是把一个完整的小程序项目，按照需求划分为不同的子包，在构建时打包成不同的分包，用户在使用时按需进行加载。这样可以有效地减少小程序的启动时间，提升用户体验。

分包的好处

对小程序进行分包的好处主要有以下两点：

  1. 优化首次启动体验：可以显著减少小程序首次启动的下载时间，只需加载主包即可运行基础功能
  2. 团队协作更高效：在多团队共同开发时可以更好地解耦协作，不同团队可以负责不同的分包

分包前后的项目构成

分包前项目的构成

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

分包后项目的构成

分包后，小程序项目由1个主包＋多个分包组成：

  • 主包：一般只包含项目的启动页面或TabBar页面、以及所有分包都需要用到的一些公共资源
  • 分包：只包含和当前分包有关的页面和私有资源

image.png

分包的加载规则

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

分包的体积限制

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

  • 整个小程序所有分包大小不超过16M（主包＋所有分包）
  • 单个分包/主包大小不能超过2M

使用分包

配置方法

在app.json 的 subpackages 节点中声明分包的结构：

{
  "pages":[  // 主包的所有页面
    "pages/index/index",
    "pages/index/list/list",
    "pages/home/home",
    "pages/info/info",
    "pages/message/message",
    "pages/contact/contact",
    "pages/logs/logs"
  ],
  "subPackages": [  // 通过 subpackages 节点，声明分包的结构
    {
      "root": "pkgA",  // 第一个分包的根目录
      "name": "p1",  // 分包的别名
      "pages": [  // 当前分包下，所有页面的相对存放路径
        "pages/cat/cat",
        "pages/dog/dog"
      ]
    },
    {
      "root": "pkgB",  // 第二个分包的根目录
      "name": "p2",  // 分包的别名
      "pages": [  // 当前分包下，所有页面的相对存放路径
        "pages/apple/apple"
      ],
      "independent": true  // 声明为独立分包
    }
  ]
}

打包原则

  1. 小程序会按 subpackages 的配置进行分包，subpackages 之外的目录将被打包到主包中
  2. 主包也可以有自己的pages（即最外层的pages字段）
  3. TabBar页面必须在主包内
  4. 分包之间不能互相嵌套

引用原则

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

独立分包详解

什么是独立分包

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

image.png

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

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

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

独立分包的应用场景

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

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

注意：一个小程序中可以有多个独立分包。

独立分包的配置方法

通过 independent 字段声明独立分包：

{
  "independent": true
}

独立分包的引用原则

独立分包和普通分包以及主包之间，是相互隔绝的，不能相互引用彼此的资源！例如：

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

分包预下载

什么是分包预下载

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

配置分包的预下载

预下载分包的行为，会在进入指定的页面时触发。在app.json中，使用preloadRule 节点定义分包的预下载规则：

{
  "preloadRule": {  // 分包预下载规则
    "pages/contact/contact": {  // 触发分包预下载的页面路径
      // packages表示进入页面后，预下载哪些分包
      // 可以通过root或name指定预下载哪些分包
      "packages": ["p1"],
      // network表示在指定的网络模式下进行预下载
      // 可选值为: all（不限网络）和 wifi（仅wifi模式下进行预下载）
      // 默认值为: wifi
      "network": "wifi"
    }
  }
}

分包预下载的限制

同一个分包中的页面享有共同的预下载大小限额2M。

image.png

小程序分包的最佳实践

在实际开发中，可以考虑以下分包策略：

  1. 合理划分主包内容：

    • 将必要的启动页面和TabBar页面放在主包中
    • 将公共组件、工具类、样式等放在主包中以便各分包共享

  2. 功能模块化分包：

    • 根据功能模块划分不同的分包
    • 相关联的功能尽量放在同一个分包中，减少跨包引用

  3. 合理使用独立分包：

    • 将相对独立且不依赖主包资源的模块设置为独立分包
    • 特别适用于活动页、营销页等相对独立的功能

  4. 优化分包预下载：

    • 分析用户使用路径，配置合理的预下载规则
    • 在WiFi环境下可以预加载更多资源，在移动网络下可以适当减少预加载

  5. 控制分包大小：

    • 注意资源优化，特别是图片资源
    • 避免将大型资源重复放置在不同分包中

通过合理的分包策略，可以有效提升小程序的加载速度和用户体验，同时也便于团队协作开发。

avatar
文章
阅读
粉丝