關(guān)于小程序分包問(wèn)題

此文較為詳細(xì)的介紹了分包的使用包括獨(dú)立分包,以及一些注意事項(xiàng),希望大家能夠耐心的看下去

背景介紹

微信限制了代碼包不能超過(guò) 2MB踏拜,限制大小是出于對(duì)小程序啟動(dòng)速度的考慮,希望用戶在使用任何一款小程序時(shí)低剔,都能獲得一種“秒開(kāi)”體驗(yàn)速梗。然而肮塞,2MB 的大小也限制了小程序功能的擴(kuò)展,小程序業(yè)務(wù)的發(fā)展可能需要更大的體積姻锁。那么有沒(méi)有一種辦法枕赵,在增加小程序包的同時(shí),也能保持不錯(cuò)的體驗(yàn)速度呢位隶?

為了解決這個(gè)矛盾點(diǎn)设易,微信推出了“分包加載方案”

原理介紹

在小程序啟動(dòng)時(shí)揩环,默認(rèn)會(huì)下載主包并啟動(dòng)主包內(nèi)頁(yè)面,如果用戶需要打開(kāi)分包內(nèi)某個(gè)頁(yè)面,客戶端會(huì)把對(duì)應(yīng)分包下載下來(lái)托享,下載完成后再進(jìn)行展示。

分包類型

普通分包與獨(dú)立分包呀舔。獨(dú)立分包是小程序中一種特殊類型的分包场斑,可以獨(dú)立于主包和其他分包運(yùn)行。從獨(dú)立分包中頁(yè)面進(jìn)入小程序時(shí)挽鞠,不需要下載主包疚颊。當(dāng)用戶進(jìn)入普通分包或主包內(nèi)頁(yè)面時(shí),主包才會(huì)被下載信认。一個(gè)小程序中可以有多個(gè)獨(dú)立分包材义。

小游戲不支持獨(dú)立分包

使用分包

配置方法:假設(shè)支持分包的小程序目錄結(jié)構(gòu)如下:

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

開(kāi)發(fā)者通過(guò)在 app.json subpackages字段聲明項(xiàng)目分包結(jié)構(gòu):

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

注:其中moduleA為獨(dú)立分包 (independent字段聲明對(duì)應(yīng)分包為獨(dú)立分包)

字段 類型 說(shuō)明
root String 分包根目錄
name String 分包別名,分包預(yù)下載時(shí)可以使用
pages StringArray 分包頁(yè)面路徑嫁赏,相對(duì)與分包根目錄
independent Boolean 分包是否是獨(dú)立分包

此外其掂,使用獨(dú)立分包時(shí)要注意:

  • 獨(dú)立分包中不能依賴主包和其他分包中的內(nèi)容,包括js文件潦蝇、template款熬、wxss、自定義組件攘乒、插件等贤牛。主包中的app.wxss對(duì)獨(dú)立分包無(wú)效,應(yīng)避免在獨(dú)立分包頁(yè)面中使用 app.wxss 中的樣式则酝;
  • App 只能在主包內(nèi)定義殉簸,獨(dú)立分包中不能定義 App,會(huì)造成無(wú)法預(yù)期的行為沽讹;
  • 獨(dú)立分包中暫時(shí)不支持使用插件般卑。

注意事項(xiàng):

  1. 關(guān)于 getApp()
    與普通分包不同,獨(dú)立分包運(yùn)行時(shí)爽雄,App 并不一定被注冊(cè)蝠检,因此 getApp() 也不一定可以獲得 App對(duì)象:

    • 當(dāng)用戶從獨(dú)立分包頁(yè)面啟動(dòng)小程序時(shí),主包不存在挚瘟,App也不存在叹谁,此時(shí)調(diào)用 getApp() 獲取到的是 undefined迟杂。 當(dāng)用戶進(jìn)入普通分包或主包內(nèi)頁(yè)面時(shí),主包才會(huì)被下載本慕,App才會(huì)被注冊(cè)排拷。
    • 當(dāng)用戶是從普通分包或主包內(nèi)頁(yè)面跳轉(zhuǎn)到獨(dú)立分包頁(yè)面時(shí),主包已經(jīng)存在锅尘,此時(shí)調(diào)用getApp()可以獲取到真正的App监氢。

    由于這一限制,開(kāi)發(fā)者無(wú)法通過(guò)App對(duì)象實(shí)現(xiàn)獨(dú)立分包和小程序其他部分的全局變量共享藤违。
    為了在獨(dú)立分包中滿足這一需求浪腐,基礎(chǔ)庫(kù) 2.2.4 版本開(kāi)始 getApp支持 [allowDefault]參數(shù),在 App 未定義時(shí)返回一個(gè)默認(rèn)實(shí)現(xiàn)顿乒。當(dāng)主包加載议街,App 被注冊(cè)時(shí),默認(rèn)實(shí)現(xiàn)中定義的屬性會(huì)被覆蓋合并到真正的 App 中璧榄。

示例代碼:

  • 獨(dú)立分包中
const app = getApp({allowDefault: true}) // {}
app.data = 456
app.global = {}

  • app.js 中
App({
  data: 123,
  other: 'hello'
})

console.log(getApp()) // {global: {}, data: 456, other: 'hello'}

  1. 關(guān)于 App 生命周期
    當(dāng)從獨(dú)立分包啟動(dòng)小程序時(shí)特漩,主包中 ApponLaunch 和首次 onShow 會(huì)在從獨(dú)立分包頁(yè)面首次進(jìn)入主包或其他普通分包頁(yè)面時(shí)調(diào)用。

    由于獨(dú)立分包中無(wú)法定義 App骨杂,小程序生命周期的監(jiān)聽(tīng)可以使用 wx.onAppShow涂身,wx.onAppHide 完成。App 上的其他事件可以使用 wx.onError搓蚪,wx.onPageNotFound 監(jiān)聽(tīng)蛤售。

分包預(yù)下載

開(kāi)發(fā)者可以通過(guò)配置,在進(jìn)入小程序某個(gè)頁(yè)面時(shí)妒潭,由框架自動(dòng)預(yù)下載可能需要的分包悴能,提升進(jìn)入后續(xù)分包頁(yè)面時(shí)的啟動(dòng)速度。對(duì)于獨(dú)立分包雳灾,也可以預(yù)下載主包
配置方法:
預(yù)下載分包行為在進(jìn)入某個(gè)頁(yè)面時(shí)觸發(fā)漠酿,通過(guò)在 app.json 增加 preloadRule 配置來(lái)控制。

{
  "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 是頁(yè)面路徑记靡,value 是進(jìn)入此頁(yè)面的預(yù)下載配置,每個(gè)配置有以下幾項(xiàng):

字段 類型 必填 默認(rèn)值 說(shuō)明
packages StringArray 無(wú) 進(jìn)入頁(yè)面后預(yù)下載分包的 rootname团驱。
__APP__ 表示主包。
network String wifi 在指定網(wǎng)絡(luò)下預(yù)下載空凸,可選值為:
all: 不限網(wǎng)絡(luò)
wifi: 僅wifi下預(yù)下載

適用版本

微信客戶端 6.6.0嚎花,基礎(chǔ)庫(kù) 1.7.3 及以上版本開(kāi)始支持。開(kāi)發(fā)者工具請(qǐng)使用 1.01.1712150 及以上版本

分包限制

  • 整個(gè)小程序所有分包大小不超過(guò) 12M
  • 單個(gè)分包/主包大小不能超過(guò) 2M

分包好處

  1. 對(duì)小程序進(jìn)行分包呀洲,可以優(yōu)化小程序的首次啟動(dòng)的下載時(shí)間
  2. 在多團(tuán)隊(duì)共同開(kāi)發(fā)的時(shí)候可以更好的解耦操作

打包原則

  • 聲明 subpackages 后紊选,將按 subpackages 配置路徑進(jìn)行打包啼止,subpackages 配置路徑外的目錄將被打包到 app(主包) 中
  • app(主包)也可以有自己的 pages(即最外層的 pages 字段)
  • subpackage 的根目錄不能是另外一個(gè) subpackage 內(nèi)的子目錄
  • tabBar 頁(yè)面必須在 app(主包)內(nèi)

引用原則

  • packageA 無(wú)法 require packageB JS 文件,但可以 require app兵罢、自己 package 內(nèi)的 JS 文件
  • packageA 無(wú)法 import packageB 的 template献烦,但可以 require app、自己 package 內(nèi)的 template
  • packageA 無(wú)法使用 packageB 的資源卖词,但可以使用 app巩那、自己 package 內(nèi)的資源

參考文章

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市此蜈,隨后出現(xiàn)的幾起案子即横,更是在濱河造成了極大的恐慌,老刑警劉巖裆赵,帶你破解...
    沈念sama閱讀 217,657評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件东囚,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡战授,警方通過(guò)查閱死者的電腦和手機(jī)页藻,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,889評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)植兰,“玉大人惕橙,你說(shuō)我怎么就攤上這事《危” “怎么了弥鹦?”我有些...
    開(kāi)封第一講書人閱讀 164,057評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)爷辙。 經(jīng)常有香客問(wèn)我彬坏,道長(zhǎng),這世上最難降的妖魔是什么膝晾? 我笑而不...
    開(kāi)封第一講書人閱讀 58,509評(píng)論 1 293
  • 正文 為了忘掉前任栓始,我火速辦了婚禮,結(jié)果婚禮上血当,老公的妹妹穿的比我還像新娘幻赚。我一直安慰自己,他們只是感情好臊旭,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,562評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布落恼。 她就那樣靜靜地躺著,像睡著了一般离熏。 火紅的嫁衣襯著肌膚如雪佳谦。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 51,443評(píng)論 1 302
  • 那天滋戳,我揣著相機(jī)與錄音钻蔑,去河邊找鬼啥刻。 笑死,一個(gè)胖子當(dāng)著我的面吹牛咪笑,可吹牛的內(nèi)容都是我干的可帽。 我是一名探鬼主播,決...
    沈念sama閱讀 40,251評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼窗怒,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼映跟!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起兜粘,我...
    開(kāi)封第一講書人閱讀 39,129評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤申窘,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后孔轴,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體剃法,經(jīng)...
    沈念sama閱讀 45,561評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,779評(píng)論 3 335
  • 正文 我和宋清朗相戀三年路鹰,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了贷洲。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,902評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡晋柱,死狀恐怖优构,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情雁竞,我是刑警寧澤钦椭,帶...
    沈念sama閱讀 35,621評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站碑诉,受9級(jí)特大地震影響彪腔,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜进栽,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,220評(píng)論 3 328
  • 文/蒙蒙 一德挣、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧快毛,春花似錦格嗅、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,838評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至没隘,卻和暖如春懂扼,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背右蒲。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,971評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工阀湿, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人瑰妄。 一個(gè)月前我還...
    沈念sama閱讀 48,025評(píng)論 2 370
  • 正文 我出身青樓陷嘴,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親间坐。 傳聞我的和親對(duì)象是個(gè)殘疾皇子灾挨,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,843評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容