从主包到分包,小程序插件的优雅引用方式

相信很多开发者朋友也知道:如果小程序插件只在某个分包中使用,无论从代码层面还是性能层面,插件放入分包都是最佳的解决办法。

然而像直播插件等公共插件应用多个功能页面,即有可能分布在多个分包。那么将小程序插件统一放入主包无疑是更优的处理方式。

面对体积较大的插件,有限的主包体积无法承载,开发者如何应对?下面我们将使用 **分包异步化 + 占位组件 **的方式将插件丝滑放入主包。

分包异步化

由于不同分包对应不同的下载单元,因此除了非独立分包能够依赖主包外,分包之间不能互相使用自定义组件或进行 require。

不过 分包异步化 可以允许通过一些配置和新的接口,使部分跨分包的内容能够等待下载后异步使用,从而一定程度上解决这个限制。

以往开发者直接在主包上引入公共插件,容易导致主包代码变多、性能减弱。现在我们可以通过 3 个步骤以分包异步化的方式引入插件,优化主包体积:

  1. app.json 中修改插件的位置到 pkgPlugin 分包

  2. 在 pkgPlugin 分包创建 index.js,并导出插件实例

  3. 在对应页面通过 require 回调函数获取插件实例

👉 点击查看代码


// 1. app.json 中修改插件的位置到 pkgPlugin 分包
{
      "root": "pkgPlugin",
      "pages": ["pages/index/index",],
      "plugins": {
    "tencentVideo": {
      "version": "1.4.7",
      "provider": "wxa75efa648b60994b"
    },
    },
}

// 2. 在 pkgPlugin 分包创建 index.js,并导出插件实例
export const TxvContext = requirePlugin('tencentVideo');

// 3. 在对应页面获取插件实例
let tencentVideo = ''
require('../pkgPlugin/index', (TxvContext) => {
    tencentVideo = TxvContext
}, (err) => {
    // 获取失败的回调
})

占位组件

由于部分插件需要用到自身的自定义组件才能够完成渲染过程,因此开发者还需要引用自定义组件:

  1. 在插件页面的 json 文件引用自定义组件

  2. 将插件放入 wxml

👉 点击查看代码

"txv-video": "plugin://tencentVideo/video"

但是由于插件没有被放入主包,以上通过分包引用自定义组件的操作将会出现报错。这时候我们需要 占位组件

13396d95b9c8b6b45ff1358ae10fa51f.png

分包引用自定义组件出现报错

为了使渲染过程不被阻塞,开发者可以使用占位组件进行渲染过程的占位。通过下面 3 个步骤即可实现占位组件的引用过程:

  1. pkgPlugin 分包创建 component,完成初始化并且封装成 1 个组件

  2. 其他分包直接引用 pkgPlugin 组件,不直接引用插件的自定义组件

  3. 使用 componentPlaceholder 属性定义占位组件,保证渲染不会被阻塞

👉 点击查看代码


// 1. pkgPlugin 分包创建 component,完成初始化并且封装成 1 个组件
<txv-video
  vid="{{vid}}"
  bindplay="bindPlayVideo"
  // 插件的props
/>

{
  "component": true,
  "usingComponents": {
    "txv-video": "plugin://tencentVideo/video"
  }
}
// 2. 其他分包直接引用 pkgPlugin 组件,不直接引用插件的自定义组件
 "usingComponents": {
    "txv-video": "/pkgPlugin/components/index"
  }, 
// 3. 使用 componentPlaceholder 属性定义占位组件,保证渲染不会被阻塞
 "componentPlaceholder": {
   "txv-video": "view:
 }

通过上述操作,我们重新封装自定义组件,并且使用占位组件的方式进行引用,完美解决插件不在对应分包也能正常引用自定义组件的情况。

面对公共插件应用在多个分包的情况,开发者可以尝试使用 分包异步化 + 占位组件 的方式,实现将小程序插件放入主包,但不占用主包体积的效果。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容