基于 iframe 的微前端框架 —— 擎天
作者|vivo 互聯(lián)網(wǎng)前端團隊- Jiang Zuohan
一、背景
VAPD是一款專為團隊協(xié)作辦公場景設計的項目管理工具,實踐敏捷開發(fā)與持續(xù)交付,以「項目」為核心,融合需求、任務、缺陷等應用,使用敏捷迭代、小步快跑的方式進行開發(fā)及質(zhì)量跟蹤,簡化工作流程,幫助團隊快速迭代并高效完成產(chǎn)品開發(fā)交付。
但早期VAPD以“一切皆可配置”的設計理念開發(fā)運行了兩年,整個前端代碼復雜混亂,組件龐大(需要支持多種配置),狀態(tài)混亂,前端代碼打包出來有50M之巨。這個項目難以為繼,bug多、維護困難、新增功能處處受限,總之產(chǎn)品不滿意、測試不滿意、用戶不滿意。
因此改版是必然的選擇,而改版的要求就是不能耽誤用戶繼續(xù)使用,必須保證網(wǎng)站可用、逐步更新,因此微前端是必然的選擇。
VAPD改版思路就是:
- 使用微前端框架,未改版部分作為子應用存在,繼續(xù)為用戶服務;
- 將項目模塊制定系統(tǒng)應用,并逐個改版,降低項目復雜度;
- 逐步舍棄舊項目代碼,將功能轉(zhuǎn)移到新項目中,提升項目整體性能,提高代碼可維護性。
二、什么是微前端
Techniques, strategies and recipes for building a modern web app with multiple teams that can ship features independently. —— Micro Frontends.
微前端是一種多個團隊通過獨立發(fā)布功能的方式來共同構(gòu)建現(xiàn)代化 web 應用的技術手段及方法策略。
微前端將微服務的理念應用于瀏覽器端,即將單頁面前端應用由單一的單體應用轉(zhuǎn)變?yōu)榘讯鄠€小型前端應用聚合為一的應用,各個前端應用獨立開發(fā)、獨立部署。
微前端架構(gòu)旨在解決單體應用在一個相對長的時間跨度下,由于參與的人員、團隊的增多、變遷,從一個普通應用演變成一個巨石應用(Frontend Monolith)后,隨之而來的應用不可維護的問題。這類問題在企業(yè)級 Web 應用中尤其常見。
現(xiàn)行最出名的微前端是阿里的qiankun,qiankun 是一個基于 single-spa? 的微前端實現(xiàn)庫,旨在幫助大家能更簡單、無痛的構(gòu)建一個生產(chǎn)可用微前端架構(gòu)系統(tǒng)。
但我嘗試試用qiankun后發(fā)現(xiàn)qiankun 的npm包常常滯后于qiankun源碼,有些issue解決了但還要等待其發(fā)版;首次加載子應用頁面出現(xiàn)抖動;子應用更新后報 ChunkLoadError 問題 。
同時它存在微前端框架常有的性能問題及沖突問題:
1、加載慢
基本上所有的微前端框架都需要先加載父框架,再加載子應用,都要經(jīng)歷如下圖的流程。整個流程是串行的,相同流程需要走兩遍,也就比普通的非微前端框架要慢1倍左右,直接影響了用戶體驗。
2、切換慢,每次切換都要重新走一次流程
微前端框架中不同子應用切換,需要銷毀當前子應用,然后加載其他子應用。子應用又需要進行“下載html --> 下載javascript文件 --> 運行javascript代碼 --> 請求服務端數(shù)據(jù) --> 頁面展示"整個流程,導致微前端框架切換應用卡頓不流暢。
3、容易出現(xiàn)樣式?jīng)_突,不同子應用容易影響
傳統(tǒng)微前端框架中所有子應用都在同一上下文中,如出現(xiàn)全局樣式、全局監(jiān)聽、全局變量,便會對其他子應用有影響,容易出現(xiàn)樣式?jīng)_突,內(nèi)存泄漏,或者不可預知的bug。
三、Why Not Iframe
iframe 最大的特性就是提供了瀏覽器原生的硬隔離方案,不論是樣式隔離、JS隔離這類問題統(tǒng)統(tǒng)都能被完美解決。
那為啥不使用iframe呢?
qiankun 團隊也給出了原因:看這里 Why Not Iframe。
總結(jié)起來就是:
- url 不同步。瀏覽器刷新 iframe url 狀態(tài)丟失、后退前進按鈕無法使用。
- UI 不同步,DOM 結(jié)構(gòu)不共享。想象一下屏幕右下角 1/4 的 iframe 里來一個帶遮罩層的彈框,同時我們要求這個彈框要瀏覽器居中顯示,還要瀏覽器 resize 時自動居中..
- 全局上下文完全隔離,內(nèi)存變量不共享。iframe 內(nèi)外系統(tǒng)的通信、數(shù)據(jù)同步等需求,主應用的 cookie 要透傳到根域名都不同的子應用中實現(xiàn)免登效果。
- 慢。每次子應用進入都是一次瀏覽器上下文重建、資源重新加載的過程。
其中有的問題比較好解決(問題1),有的問題我們可以睜一只眼閉一只眼(問題4),但有的問題我們則很難解決(問題3)甚至無法解決(問題2),而這些無法解決的問題恰恰又會給產(chǎn)品帶來非常嚴重的體驗問題, 最終導致我們舍棄了 iframe 方案。
四、擎天框架設計
4.1 設計理論
基于以上微前端缺陷,設計新型的微前端框架需要滿足以下要求:
- 快 —— 頁面加載速度、應用切換速度是前端極致的追求,用戶操作的響應速度永遠是第一體驗。
- 完全隔離 —— 不同子應用完全隔離,只在子應用項目初始化時設置一次,之后不需要在后續(xù)開發(fā)中及后期維護中考慮,降低開發(fā)的心智負擔。
4.2 架構(gòu)設計
擎天框架架構(gòu)分為三層,分別是用戶入口(瀏覽器地址欄),主應用層以及子應用集合層。
(1)瀏覽器(地址欄)是用戶入口,用戶通過輸入URL進入該系統(tǒng),同時瀏覽器地址欄URL根據(jù)應用頁面進行變化,方便用戶復制分享二次進入。
(2)主應用是擎天框架的關鍵部分,主要是由以下兩部分組成:
- 路由引擎:實現(xiàn)瀏覽器地址欄與子應用展示隱藏的協(xié)調(diào)控制,用來控制用戶第一次進入展示某個應用,當用戶切換頁面時需同步瀏覽器地址欄(方便用戶復制,再次進入同一頁面),并根據(jù)頁面URL展示隱藏子應用。
- 數(shù)據(jù)共享引擎:實現(xiàn)子應用間的數(shù)據(jù)共享,保證各個應用間數(shù)據(jù)統(tǒng)一,如登錄信息,用戶信息等。用戶在某個應用修改共享數(shù)據(jù)后,會同步到數(shù)據(jù)共享引擎,再分發(fā)給其他應用,從而保證共享數(shù)據(jù)一致。
(3)子應用集合層
該層為系統(tǒng)提前設置好的子應用集合,子應用由全屏iframe加載,同一時刻僅有一個子應用處于可視狀態(tài),其他子應用隱藏。當需要應用切換時,隱藏當前應用,顯示需要展示的應用,瞬間切換。
子應用響應擎天的路由引擎及數(shù)據(jù)共享引擎,做到實時的路由同步與數(shù)據(jù)同步,保證整個微前端項目路由及數(shù)據(jù)統(tǒng)一。
五、擎天框架實現(xiàn)
擎天框架突破了 iframe UI不同步、URL不同步、數(shù)據(jù)不共享以及加載慢等問題,并將iframe作為頁面容器存在,在實現(xiàn)硬隔離的同時做到了子應用瞬間切換,解決了微前端框架一直以來的通病,從而實現(xiàn)單應用級別的操作體驗。
5.1全屏iframe、共同組件
解決問題:UI 不同步
全屏iframe是指整個瀏覽器窗口全部給子應用iframe,子應用接管瀏覽器所有功能,無論是全局拖動、全部蒙層、resizie等,由此UI不同步的問題便不存在了。
但不同應用有個相同的公用部分,因此需要把公共部分做成統(tǒng)一組件,發(fā)到npm包中,在每一個應用中引入就行。
5.2 父子應用異步加載
解決問題:加載慢
在前端靜態(tài)頁面中預留子應用dom節(jié)點,如下圖 所示,每一個div有唯一id,代表一個預制子應用。同時該id對應子應用路由pathname,如New對應/New/*路由,即以New開頭的路由全部對應id為"New"的子應用。
當用戶進入頁面后,父框架拿到瀏覽器url,并獲取到pathname,從而知道需要首先加載那個子應用。并且直接創(chuàng)建iframe,并直接掛到對應的dom節(jié)點中,父應用和子應用異步加載。
加載完首個子應用后,開始加載其他子應用,并使用display: none將它們隱藏到頁面dom結(jié)構(gòu)中。最終dom節(jié)點如下圖所示。
5.3 子應用iframe瞬間切換
解決問題:子應用切換卡頓
用戶進行多個子應用切換時,擎天框架監(jiān)聽瀏覽器url地址,如pathname從/New/*變成/Web/*,則將/New/*對應的子應用iframe隱藏起來,將/Web/對應的子應用iframe顯示出來,實現(xiàn)應用的瞬間切換。
用戶可視范圍內(nèi)只能看一個應用,切換時僅僅是將New應用隱藏不可見,Web應用頁面可見。
5.4 路由引擎,同步切換
解決方案:URL不同步
受vue2中數(shù)組方法(如push、shift)響應式處理的啟發(fā),擎天對前端路由框架進行特殊處理,重寫了vue-router的push、replace等方法,當監(jiān)聽到子應用使用以上方法進行路由切換時,會同步到父框架進行操作。
父子應用簡單配置后,父子路由同步便做好了。路由切換分為單應用以及多應用間路由切換。
(1)單應用路由切換
單應用子iframe路由切換,如/New/b 切換到/New/c,其pathname結(jié)構(gòu)一致,是單應用的路由切換。子應用先切換路由,隨后發(fā)送syncRoute給父框架,父框架使用replace方法改變?yōu)g覽器地址欄即可,具體流程如下圖所示。
(2)多應用間路由切換
如/New/b 切換到/Web/c,其pathname結(jié)構(gòu)不一致。子應用先切換路由,隨后發(fā)送syncRoute消息給父框架,父框架使用replace方法改變?yōu)g覽器地址欄,同時將應用A隱藏起來,并發(fā)送消息到子應用B中。子應用B獲得消息后修改其本身路由。
5.5 數(shù)據(jù)共享
解決問題:內(nèi)存變量不共享
父應用將需要共享的數(shù)據(jù)放到store中,并使用syncStore進行注冊。
子應用通過類vuex似的 mapGlobalState 方法可以獲取父應用store中數(shù)據(jù),同時該數(shù)據(jù)為響應式,數(shù)據(jù)變更可觸發(fā)UI重新渲染。
通過mapGlobalMutations獲取修改數(shù)據(jù)的方法,通過該方法可以修改父應用store數(shù)據(jù),修改成功后擎天共享數(shù)據(jù)引擎將修改好的數(shù)據(jù)分發(fā)給各個子應用,保證共享數(shù)據(jù)一致。
其內(nèi)部邏輯是:
父應用將需要共享的數(shù)據(jù)放到store中,并暴露getTopStore(獲取store數(shù)據(jù))、syncTopMutation(更新store數(shù)據(jù))、syncTopStore(分發(fā)store數(shù)據(jù))等接口。
系統(tǒng)加載時子應用通過getTopStore方法可以獲取store中數(shù)據(jù),并賦值到子應用$pstore中,從而獲得數(shù)據(jù)響應式等能力。
當某個子應用需要修改共享數(shù)據(jù)時,調(diào)用syncTopMutation方法進行修改,修改成功后擎天通過syncTopStore分發(fā)給各個子應用,保證共享數(shù)據(jù)一致。
六、總結(jié)
擎天基于全屏Iframe與搭建公共組件等方式,解決了iframe UI不同步的難題,并充分發(fā)揮了iframe作為頁面容器的優(yōu)勢,實現(xiàn)了父子應用異步加載、子應用瞬間切換的能力,從而達到單應用項目的體驗。