主頁 > 前端設計 > 微前端之如何拆解React巨石應用 qiankun

微前端之如何拆解React巨石應用 qiankun

2020-10-02 13:05:59 前端設計

這里寫目錄標題

  • 背景
  • 解決之路
    • 為什么用微前端
    • 為什么我們選擇`qiankun`
  • 重構之路
    • 兩個 React 的坑
    • babel 配置讀取不到的坑
    • 通信
    • 異步加載
    • 瀏覽器的 fetch 差異
    • 總結
  • 優化開發體驗篇
    • 記憶體占用嚴重,子應用無法熱更新
    • monorepo 專案的開發命令管理
    • 公共包
  • 結尾
  • 更多文章

背景

📢 博客首發 : SugarTurboS Blog

團隊的專案 A 經歷兩年需求的洗禮,一些問題也隨之暴露出來:

  • 專案參考的npm包很多,業務代碼也很多,有著向巨石應用發展的趨勢,巨石應用的一些典型問題如下:構建效率低下dev-server 占用記憶體大甚至記憶體泄露維護成本急劇增加
  • 專案主框架升級成本高,要兼容舊代碼
  • 專案里的某些業務幾乎不再迭代,但每個版本依然會被打包構建,每次構建的npm包版本可能不同,導致一些隱藏未知錯誤
  • 該專案之前是由兩個不同的專案合并而來,代碼風格上存在兩種方式,解決類似問題時引入的技術方案也是不一樣,導致后期維護成本高,同樣對于新人來說閱讀性差

解決之路

為什么用微前端

對于微前端跟 iframe 的方案區別,為什么用微前端這個問題,這里不再累贅,qiankun里面有一篇文章已經說得非常不錯,有興趣可以去看看,
why not iframe

為什么我們選擇qiankun

  • qiankun的接入對專案改動小,成本低,
  • 社區活躍,作者對于 issue 回復快,
  • star 數相對較多
  • 阿里自家專案有在使用,穩定性 ok,即生產可用(這一點其實是官方上說的,實際我們也不肯定,就我們使用感覺,穩定性還是有一定保障的),

重構之路

這個的坑不是指qiankun的坑,當然,qiankun這個框架還是有一些坑在的,這里主要的指在專案重構的時候,遇到的一些坑及我們的解決方案,以供大家參考,

兩個 React 的坑

專案之前的結構,所有的包都安裝在根目錄的node_modules,專案里所有內容都指向一個React,而用qiankun重構后,我們定義每個子專案為一個相對獨立的專案(有獨立的package.json檔案,獨立包管理),但子專案之前又會有一些公共的組件,我們把它放在以子專案同級的 common 檔案夾,如下圖,

這時候就遇到一個問題:子專案參考自己package.json目錄下的node_modules里面的React,而 common 參考根目錄的package.json目錄下node_modules里面的React,當子專案參考 common 封裝的React 組件,子專案跑的時候會報同時引入了兩個React,導致報錯,

一開始,我們想到的方案是這樣的,把全部包安裝在根目錄的node_modules,但是,這個方案最大問題是所有子專案必須用同一版本React、后期React想升級,必須所有子專案做兼容,但是有些子專案被劃分出來就是為了不再跟隨升級迭代,這就矛盾了,

后來,我們換了一個方案,我們在打包的時候,預先把 common 目錄 copy 一份到子專案,這樣就能保住都是參考一個React,在開發的時候,額外啟動一個監聽服務 watch common 目錄,監聽到檔案變化的時候自動 copy 檔案到子專案,子專案的 common 目錄進行權限控制,只能進行讀寫操作,無其他操作執行權限,所有參考 common 通過@common 映射,這樣給到開發時,common 內容的更改只需要在根目錄 common 修改,子專案通過@common 參考不需要關注真實的 common 與子專案的目錄結構關系,

babel 配置讀取不到的坑

重構前,我們們只有一個 babel 配置,重構后,我們們的目錄結構是典型的 monorepo 結構,我們們只有子專案有 .babelrc.json 檔案,導致 common 往上查找找不到配置報錯 (ps:我們們專案是使用babel7構建)

一開始,是沿用babel6時候的方式,使用.babelrc.json檔案,根目錄及子專案分別有一個.babelrc.json檔案,這樣的最大缺點是兩個.babelrc.json檔案配置幾乎相同,后期維護改配置需要修改兩個檔案,

然后改用子專案 .babelrc.json 通過 extends 配置復用根目錄的.babelrc.json配置,

后面發現,由于 babel 配置有一些是需要配置路徑,而json只能配置相對路徑,于是改用js格式配置,

我們們專案參考的一些 npm 包沒有轉es6,我們們只能用 webpack 對這些包額外 babel 轉化一下,但是發現專案的 babel 配置對 npm 包并不生效,后來發現是因為 babel7 之后,.babelrc 不會對 node_modules 包起作用,必須改用babel.config.js代替,

以上就是我們最終關于babel的配置,

【記得 babel-loader 時要配置引數 rootModeupward,表示允許 babel 往上查找babel.config.js檔案】,同樣子專案要配置 extends 引數指向最外層的 babel 檔案路徑,

關于babel6.xbabel7的區別,babel對于monorepo專案的配置,官網上面這篇文章寫的是最詳細的,

通信

qiankun 只給我們們提供了一個 initGlobalState(初始化一個全域state)、onGlobalStateChange(監聽變化)、setGlobalState(更新state)的全域狀態管理,并不跟React的狀態管理器做關聯,我們們要做的是把全域state與子應用redux做一個雙向系結,

// 這里面state與globalState要進行深比較,如果是淺比較,會導致程式陷入死回圈,
const [state, setState] = useState({}) // 這里用state代替redux,做一個簡單演示,
let globalState = null
// 監聽globalState值變化,如果有變化則更新state
actions.onGlobalStateChange((newGlobalState) => {
  globalState = newGlobalState
  const diffState = getDiffState(globalState, state)
  if (diffState) setState(diffState)
})

// 監聽state值變化,如果有變化則更新globalState
useEffect(() => {
  const diffState = getDiffState(state, globalState)
  if (diffState) actions.setGlobalState(diffState)
}, [state])

異步加載

由于我們們專案之前是使用 webpackimport 實異步加載,在使用qiankun重構后,發現以下問題:

當前處于子應用 A,切換子應用 B,在異步 js 還在加載程序中,快速切換回應用 A,待子應用 B 的異步 js 加載完畢后,我們們切換回子應用 B,發現子應用那個異步 js 加載的內容為空,

導致該問題原因是 A->B->A 程序后,子應用 B 的沙箱被移除了,異步 js 缺少執行環境,導致異步 js 執行的(window.webpackJsonp...)已經找不到,

目前沒有找到有效的解決辦法,這可能是框架的一個隱藏坑,已提issue,期望大佬們能協助解決,我們現在想到的可行方案是改用loadMicroApp手動加載子應用,

瀏覽器的 fetch 差異

在專案送測程序中,測驗發現在某些瀏覽器(目前知道的是搜狗瀏覽器某個版本)會有兼容性問題,后來追查發現,有些瀏覽器的 fetch 默認 credentials 不是 same-origin,導致一些 cookieheader 資訊沒被帶上,后臺權限認證一直不過,

解決方法就是呼叫 qiankunstart 是重寫fetch,設定 credentials=same-origin,保證瀏覽器的兼容性,

start({
  fetch(...args) {
    const config = {
      credentials: 'same-origin',
    }
    if (!args[1]) args[1] = {}
    args[1] = {
      ...args[1],
      ...config,
    }
    return fetch(...args)
  },
})

總結

其實整體來說,接入qiankun成本還是比較低的,遇到的問題大多不是qiankun直接導致,而是用qiankun重構后,專案結構發生變化帶來的一些問題,

優化開發體驗篇

專案重構后,因為整體結構的變化,出現的一些性能及開發體驗的問題,這里主要說影響比較大的兩點,

記憶體占用嚴重,子應用無法熱更新

1、有同事發現,專案用qiankun重構后,在本地開發程序中,如果chrome tool長期打開,隨著頁面重繪次數越多,chrome的記憶體占用會越來越嚴重,理論上來說,就算程式有記憶體泄露啥的,重繪頁面也會釋放掉才對,為啥記憶體卻是越來越大呢?后來發現,只要不打開chrome tool,記憶體是正常的,重繪記憶體就會降下來的,而且,我們們使用未重構的分支驗證,也是不會記憶體越來越大的,如圖:


2、子應用內容變更,是無法熱更新的,一開始以為是webpack的配置沒有配對導致的,后來發現并不是webpack,而是qiankun使用的single-spa框架的問題,詳細可見issue,里面作者也提供了一個方案,就是允許你重新加載子應用,但是這樣就違背了熱更新的更新區域的思想,而且,加載子應用跟重繪并沒有太大差別了,開發體驗太差,

我們們討論發現,沒有什么方案可以解決這個問題,只有一個規避的方案,就是我們們平時開發的時候,使用子應用路由進行開發,這樣就可以規避這兩個略為蛋疼的問題,當然,在一些場景下,如果主應用做一些權限的東西,單獨跑子應用必須重寫一套權限,我們目前做法是把這種模塊掛公共目錄里,后面還要繼續探索有沒有更好的方案,大家如果有更好的解決方案歡迎留言,

monorepo 專案的開發命令管理

專案組的小伙伴吐槽說,我們們之前開發只需要npm run dev一個命令列就可以搞定,qiankun重構后,每個子應用啟動一個服務,qiankun還要一個服務,如果要全套跑起來,我們需要打開多個命令列視窗分別運行,這樣太麻煩了,針對這個問題,自然是引入npm-run-all解決這個問題,一開始我們也是這樣做的,但是后面發現,實際開發程序中,有的時候小 A 只要開發子應用 A,小 B 只需要開發子應用 B,每個人都全部啟動,既浪費記憶體資源,也不優雅,那么,要怎么樣隨心所欲一行命令開啟你想要的服務呢?
我們們最后是使用npm-run-all的 Node API,自主處理命令列,然后使用它提供的 API 動態啟動想要的服務,如npm start main A,會啟動 qiankun 所在的服務及 A 微服務,

// package.json
"scripts": {
  'start': 'node start.js',
  "start:main": "cd client/main && npm run dev",
  "start:A": "cd client/A && npm run dev",
  "start:B": "cd client/B && npm run dev",
  "start:C": "cd client/C && npm run dev",
}
// start.js
const runAll = require('npm-run-all')

function getApps() {
  // 查找命令列所帶的引數,如果沒有帶引數,然后啟動Main及A服務
  let apps = process.argv.filter((arg) =>
    ['Main', 'A', 'B', 'C'].some((name) => name === arg)
  )
  if (apps.length <= 0) apps = ['Main', 'A']
  return apps
}

function getTasks() {
  let apps = getApps()
  let tasks = apps.map((app) => `start:${app}`)
  return tasks
}

runAll(getTasks(), {
  parallel: true,
  // stdout: writable,
  // stderr: errWritable,
  // printLabel: true,
})
  .then((results) => {
    console.log('done!', results)
  })
  .catch((err) => {
    console.log('failed!', err)
  })

公共包

重構后,我們發現有些包子應用都有使用,比如Reactantd…,如果每個子應用都安裝依賴一個antd,那就很浪費資源加載,也會影響用戶首屏等待時間,qiankun沒有提供這方面的方案,我們最后是使用dll方式,先把這些公共包提前打包后,在dll到各個子專案,dll的方式也是有一些不足的,因為dll無法按需加載,只能參考整個包,同樣,dll需要提前加載,如果dll打包的東西不是使用很頻繁或首屏使用的,會特別浪費,所以我們一般只有滿足以下條件才會考慮dll:

  • 1、多個專案使用
  • 2、專案使用的頻率高
  • 3、這個npm包幾乎大部分功能都需要使用

結尾

最后說說我們的想法,專案是否需要引入 qiankun,我們覺得關鍵還是要清楚引入 qiankun 后的收益及成本,拿我們們這個專案來說,因為可預見后面業務越來越大的時候,它肯定會變成巨石應用,qiankun 的接入在當前來看可能成本高于收益,但從長遠來說,收益是絕對高于成本的,所以我們們把它引到專案中去了,

最后,由于篇幅有限,很多細節的東西沒有在這里展現,如果有興趣的,歡迎私下交流,

未經授權,禁止轉載~

更多文章

  • SugarTurboS Blog
  • Redux原始碼解讀與編程藝術
  • 淺談前端設計模式
  • 你還在為專案里的重復請求發愁嗎?
  • 協同編輯場景的基礎分析及方案設計

轉載請註明出處,本文鏈接:https://www.uj5u.com/qianduan/148384.html

標籤:其他

上一篇:前后端分離理解

下一篇:公司用自助建站模板建站推薦

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • vue移動端上拉加載

    可能做得過于簡單或者比較low,請各位大佬留情,一起探討技術 ......

    uj5u.com 2020-09-10 04:38:07 more
  • 優美網站首頁,頂部多層導航

    一個個人用的瀏覽器首頁,可以把一下常用的網站放在這里,平常打開會比較方便。 第一步,HTML代碼 <script src=https://www.cnblogs.com/szharf/p/"js/jquery-3.4.1.min.js"></script> <div id="navigate"> <ul> <li class="labels labels_1"> ......

    uj5u.com 2020-09-10 04:38:47 more
  • 頁面為要加<!DOCTYPE html>

    最近因為寫一個js函式,需要用到$(window).height(); 由于手寫demo的時候,過于自信,其實對前端方面的認識也不夠體系,用文本檔案直接敲出來的html代碼,第一行沒有加上<!DOCTYPE html> 導致了$(window).height();的結果直接是整個document的高 ......

    uj5u.com 2020-09-10 04:38:52 more
  • WordPress網站程式手動升級要做好資料備份

    WordPress博客網站程式在進行升級前,必須要做好網站資料的備份,這個問題良家佐言是遇見過的;在剛開始接觸WordPress博客程式的時候,因為升級問題和博客網站的修改的一些嘗試,良家佐言是吃盡了苦頭。因為購買的是西部數碼的空間和域名,每當佐言把自己的WordPress博客網站搞到一塌糊涂的時候 ......

    uj5u.com 2020-09-10 04:39:30 more
  • WordPress程式不能升級為5.4.2版本的原因

    WordPress是一款個人博客系統,受到英文博客愛好者和中文博客愛好者的追捧,并逐步演化成一款內容管理系統軟體;它是使用PHP語言和MySQL資料庫開發的,用戶可以在支持PHP和MySQL資料庫的服務器上使用自己的博客。每一次WordPress程式的更新,就會牽動無數WordPress愛好者的心, ......

    uj5u.com 2020-09-10 04:39:49 more
  • 使用CSS3的偽元素進行首字母下沉和首行改變樣式

    網頁中常見的一種效果,首字改變樣式或者首行改變樣式,效果如下圖。 代碼: <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, ......

    uj5u.com 2020-09-10 04:40:09 more
  • 關于a標簽的講解

    什么是a標簽? <a> 標簽定義超鏈接,用于從一個頁面鏈接到另一個頁面。 <a> 元素最重要的屬性是 href 屬性,它指定鏈接的目標。 a標簽的語法格式:<a href=https://www.cnblogs.com/summerxbc/p/"指定要跳轉的目標界面的鏈接">需要展示給用戶看見的內容</a> a標簽 在所有瀏覽器中,鏈接的默認外觀如下: 未被訪問的鏈接帶 ......

    uj5u.com 2020-09-10 04:40:11 more
  • 前端輪播圖

    在需要輪播的頁面是引入swiper.min.js和swiper.min.css swiper.min.js地址: 鏈接:https://pan.baidu.com/s/15Uh516YHa4CV3X-RyjEIWw 提取碼:4aks swiper.min.css地址 鏈接:https://pan.b ......

    uj5u.com 2020-09-10 04:40:13 more
  • 如何設定html中的背景圖片(全屏顯示,且不拉伸)

    1 <style>2 body{background-image:url(https://uploadbeta.com/api/pictures/random/?key=BingEverydayWallpaperPicture); 3 background-size:cover;background ......

    uj5u.com 2020-09-10 04:40:16 more
  • Java學習——HTML詳解(上)

    HTML詳解 初識HTML Hyper Text Markup Language(超文本標記語言) 1 <!--DOCTYPE:告訴瀏覽器我們要使用什么規范--> 2 <!DOCTYPE html> 3 <html lang="en"> 4 <head> 5 <!--meta 描述性的標簽,描述一些 ......

    uj5u.com 2020-09-10 04:40:33 more
最新发布
  • 我的第一個NPM包:panghu-planebattle-esm(胖虎飛機大戰)使用說明

    好家伙,我的包終于開發完啦 歡迎使用胖虎的飛機大戰包!! 為你的主頁添加色彩 這是一個有趣的網頁小游戲包,使用canvas和js開發 使用ES6模塊化開發 效果圖如下: (覺得圖片太sb的可以自己改) 代碼已開源!! Git: https://gitee.com/tang-and-han-dynas ......

    uj5u.com 2023-04-20 07:59:23 more
  • 生產事故-走近科學之消失的JWT

    入職多年,面對生產環境,盡管都是小心翼翼,慎之又慎,還是難免捅出簍子。輕則滿頭大汗,面紅耳赤。重則系統停擺,損失資金。每一個生產事故的背后,都是寶貴的經驗和教訓,都是專案成員的血淚史。為了更好地防范和遏制今后的各類事故,特開此專題,長期更新和記錄大大小小的各類事故。有些是親身經歷,有些是經人耳傳口授 ......

    uj5u.com 2023-04-18 07:55:04 more
  • 記錄--Canvas實作打飛字游戲

    這里給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 打開游戲界面,看到一個畫面簡潔、卻又富有挑戰性的游戲。螢屏上,有一個白色的矩形框,里面不斷下落著各種單詞,而我需要迅速地輸入這些單詞。如果我輸入的單詞與螢屏上的單詞匹配,那么我就可以獲得得分;如果我輸入的單詞錯誤或者時間過長,那么我就會輸 ......

    uj5u.com 2023-04-04 08:35:30 more
  • 了解 HTTP 看這一篇就夠

    在學習網路之前,了解它的歷史能夠幫助我們明白為何它會發展為如今這個樣子,引發探究網路的興趣。下面的這張圖片就展示了“互聯網”誕生至今的發展歷程。 ......

    uj5u.com 2023-03-16 11:00:15 more
  • 藍牙-低功耗中心設備

    //11.開啟藍牙配接器 openBluetoothAdapter //21.開始搜索藍牙設備 startBluetoothDevicesDiscovery //31.開啟監聽搜索藍牙設備 onBluetoothDeviceFound //30.停止監聽搜索藍牙設備 offBluetoothDevi ......

    uj5u.com 2023-03-15 09:06:45 more
  • canvas畫板(滑鼠和觸摸)

    <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>canves</title> <style> #canvas { cursor:url(../images/pen.png),crosshair; } #canvasdiv{ bo ......

    uj5u.com 2023-02-15 08:56:31 more
  • 手機端H5 實作自定義拍照界面

    手機端 H5 實作自定義拍照界面也可以使用 MediaDevices API 和 <video> 標簽來實作,和在桌面端做法基本一致。 首先,使用 MediaDevices.getUserMedia() 方法獲取攝像頭媒體流,并將其傳遞給 <video> 標簽進行渲染。 接著,使用 HTML 的 < ......

    uj5u.com 2023-01-12 07:58:22 more
  • 記錄--短視頻滑動播放在 H5 下的實作

    這里給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 短視頻已經無數不在了,但是主體還是使用 app 來承載的。本文講述 H5 如何實作 app 的視頻滑動體驗。 無聲勝有聲,一圖頂百辯,且看下圖: 網址鏈接(需在微信或者手Q中瀏覽) 從上圖可以看到,我們主要實作的功能也是本文要講解的有: ......

    uj5u.com 2023-01-04 07:29:05 more
  • 一文讀懂 HTTP/1 HTTP/2 HTTP/3

    從 1989 年萬維網(www)誕生,HTTP(HyperText Transfer Protocol)經歷了眾多版本迭代,WebSocket 也在期間萌芽。1991 年 HTTP0.9 被發明。1996 年出現了 HTTP1.0。2015 年 HTTP2 正式發布。2020 年 HTTP3 或能正... ......

    uj5u.com 2022-12-24 06:56:02 more
  • 【HTML基礎篇002】HTML之form表單超詳解

    ??一、form表單是什么

    ??二、form表單的屬性

    ??三、input中的各種Type屬性值

    ??四、標簽 ......

    uj5u.com 2022-12-18 07:17:06 more