前端項目重構的一些思考和覆盤

項目重構是每一家穩定發展的互聯企業的必經之路, 就像一個產品的誕生, 會經歷產品試錯和產品迭代 一樣。

隨着業務或新技術的不斷髮展, 已有架構已無法滿足更多業務擴展的需求, 所以只有通過重構來讓產品“進化”, 才能跟上飛速發展的時代浪潮.

一. 重構原因及準備

這裏我結合自己的實際經驗總結一下項目重構的幾個原因:

1. 技術因素

技術因素主要有如下幾個方面:

• 早期技術團隊在技術選型上的誤判(常發生於MVP類型的產品快速上線導致的技術調研不夠充分)
• 新老技術框架的更替(比如從 jquery 遷移到 vue/react)
• 技術團隊交接出現的斷層(老技術團隊的架構設計更不上新技術團隊的發展, 出現架構上的“平替”)
• 技術架構升級(比如隨着業務發展, 由傳統的MPA應用轉爲基於微前端模式的SPA應用)
• 安全,性能,代碼質量等原因導致的技術重構

2. 產品因素

• 產品形態調整(比如由純PC應用轉爲響應式應用, 或者從H5到支持跨端)
• 產品業務調整(非常常見的重構理由之一)
• 產品指標調整(如兼容性, 性能指標等導致的代碼重構)

上面是我列出來的比較典型的重構場景, 也是我們未來在設計產品技術架構之前需要考慮的方面. 爲了提高自己設計的架構穩定性, 我們需要提前和產品溝通明確, 以降低後期重構和維護成本.

最後總結幾條架構設計的經驗:

• 能做規範的一定要嚴格做好規範
• 在設計架構之前, 一定要充分理解業務場景, 明確產品的技術交付指標
• 架構設計以可溯源 爲基本要求
• 不要盲目追求最好的方案, 以局部最優解爲工程設計理念

2. 做項目重構之前, 需要有哪些準備

當然做項目重構也是有技術門檻的,不是所有程序員都能做好重構工作, 建議大傢俱備如下幾種技術能力:

• 對項目所使用的框架語言有相對深入的理解和掌握
• 有一定的前端工程化經驗(如webpack, vite, gulp, nodejs, babel, AST等有一定的研究)
• 熟悉常用的web性能優化方案
• 熟悉常見的設計模式和前端編碼規範
• 熟悉前端主流的技術框架的設計原理和工程設計思想

接下來我們一起看看常見的幾種項目重構場景及其重構方向.

二. 不同類型項目重構的方法論

1. 業務系統自身的重構

業務系統自身的重構一般可以包含如下幾個方面:

• 業務代碼優化

業務代碼優化主要是針對一些核心業務代碼, 進行流程上, 邏輯上的重構, 讓它更具可讀性和維護性, 同時保證業務操作的兼容性, 具體方案如下:

• 複雜業務邏輯需要編寫註釋

• 代碼中訪問性屬性提供兼容邏輯(常見的比如訪問對象屬性, a.b.c, 如果a,b爲非對象則整段代碼將報錯)

• 代碼結構優化(比如冗長的if else 或者“回調地獄” 可以採用適配器模式或者es6+語法來優化)

• 方法參數調優(一個函數有多個參數, 可以使用參數對象來提高可讀性,降低使用偏差)

• 業務代碼性能優化(複雜後臺系統比如低代碼類產品, 前端需要處理很多數據和邏輯, 此時可以用合適的數據結構和算法優化js計算)

• 函數式編程思想優化業務函數(可選)

• 業務代碼進行單元測試, 提高代碼質量(可選)

• 代碼規範

早期可能由某名研發單獨負責的項目, 對代碼規範和格式要求不是很高, 但是需要考慮後期團隊擴容帶來的協作開發問題, 這個時候如果沒有統一的規範, 不同研發小夥伴可能寫出的代碼千奇百怪, 導致後期維護成本巨大, 尤其是涉及到需要維護他人代碼時. 所以我們重構的另一個目標就是降低代碼理解成本, 保證項目代碼在閱讀時就像同一個寫出來的, 這樣對後期邏輯複用, 組件解耦, 問題定位以及業務代碼維護將非常有幫助.

常用的措施有:

• 代碼格式規範(如eslint)
• 邏輯語法類型約束(如typescript)
• 代碼規範(如css命名規範OOCSS, BEM等, 文件命名規範, js變量命名復規範等)
• git 提交規範(常見的是在git hooks的提交階段對提交格式等進行校驗)

當然, 這些都是需要結合自身團隊和項目來定的, 這裏只做參考.

• 工程化優化

工程化優化主要有以下幾個場景:

• 由於業務不斷增加, 系統的複雜性加大導致的本地運行和打包速度越來越慢
• 由於項目代碼量的增加導致頁面臃腫, 需要進行合理的拆分
• 基於已有的工程經驗沉澱, 需要對工程化配置做進一步升級, 優化
• 老舊腳手架無法適應當前的項目生產效率

接下來我會針對以上場景, 進行一些解決方案的分享.

1. 由於業務不斷增加, 系統的複雜性加大導致的本地運行和打包速度越來越慢

針對這種情況, 我們可以藉助 speed-measure-webpack-plugin 插件，它可以分析 webpack 的總打包耗時以及每個 plugin 和 loader 的打包耗時，從而讓我們對打包時間較長的部分進行鍼對性優化。

同時默認情況react, react-dom, react-router 等公共模塊在每次構建都會參與打包, 這些實際上是沒有必要的, 我們可以將其傳到 cdn上, 從而減少webpack 的打包”工作量“.

我們可以安裝 html-webpack-externals-plugin 來實現將指定模塊從打包列表中排除, 具體用法如下:

const HtmlWebpackExternalsPlugin = require('html-webpack-externals-plugin');

module.exports = {
  // ...其他配置代碼
  plugins: [
    new HtmlWebpackExternalsPlugin({
      externals: [
        {
          module: 'react',
          entry: 'https://cdn.dooring.cn/umd/react.production.min.js',
          global: 'React',
        },
        {
          module: 'react-dom',
          entry:
            'https://cdn.dooring.cn/umd/react-dom.production.min.js',
          global: 'ReactDOM',
        },
      ],
    }),
  ],
};

爲了追求更驚一步的打包效率, 我們可以使用並行的方式構建, 同樣 webpack 生態也提供了對應的模塊 parallel-webpack. 具體用法大家可以看文檔, 非常簡單方便.

其他還有很多優化的方案, 這裏我列一下, 大家可以根據實際情況使用:

• 配置並行壓縮(terser-webpack-plugin, css-minimizer-webpack-plugin, html-minimizer-webpack-plugin 等都支持parallel參數)
• 預編譯資源模塊(可以利用webpack.DllPlugin來提前將公共模塊打包以便後續直接複用)
• 使用構建緩存(webpack5 內置的 cache 模塊, 或者cache-loader)
• 對打包體積進行分析, 以便有針對性的優化(如webpack-bundle-analyzer)

當然除了對已有構建工具的優化, 我們可以評估一下重構成本, 將構建內核替換vite等更高效的構建工具.

1. 由於項目代碼量的增加導致頁面臃腫, 需要進行合理的拆分

針對項目代碼量的增加導致頁面臃腫, 我們可以從項目本身的角度, 對項目進行拆解, 將公共模塊抽離爲公用業務類庫或者組件庫:

除了對項目進行可複用性拆分之外, 我們還需要根據系統複雜量級, 近一步拆分項目, 比如將一個巨石工程拆分爲多個子工程, 單獨運行維護, 或者採用之前熱點討論的微前端的模式, 比如使用 qainkun, single-spa, Micro App, EMP, Garfish, Bit 這些優秀的微前端框架.

綜上, 我們可以根據項目複雜度, 做如下優化:

• 模塊 & 組件化
• 拆分子系統(已有架構不變的MPA模式)
• 拆分子系統(微前端)

當然我們始終需要保持一個理念: 局部最優, 誤增繁複.

1. 基於已有的工程經驗沉澱, 需要對工程化配置做進一步升級, 優化

這種情況主要是在項目發展穩定之後, 需要思考的重構方向, 比如早期由於業務場景單一, 很多公共配置都寫在業務代碼裏的, 隨着業務複雜之後, 很多模塊都需要使用改配置或者變量, 比如:

// a.js
const publicDomain = 'https://dooring.vip';
const serverUrl = 'https://xxx.cn';

// b.js
const publicDomain = 'https://dooring.vip';

// c.js
const appid = 'xxxxxxxx';
const website_Logo = 'http://h5.dooring.cn/logo.png';

對於這種零散且固定的變量, 未來可能會被多個頁面或者模塊複用, 所以爲了降低成本, 我們可以把這些通用配置提取到外層, 作爲公共配置文件, 這樣後期新項目也能享受開箱即用的配置體驗.

拿我的親身經驗, 比如幾年前我開發的低代碼項目H5-Dooring, 有一些零散的配置信息分散在項目的各個角落, 後面經過幾次重構優化之後, 整個項目只需要在配置文件中輕鬆配置內容, 即可一鍵控制頁面的走向, 這裏分享一下優化過後的配置文件:

// h5-dooring全局配置文件
define: {
    START_ENV,
    lang,
    // 配置h5端訪問的域名
    h5Domain: 'h5.dooring.cn',
    // 設置當前版本號
    curVersion: dooringVersion,
    // 備案信息
    copyright: 'xxxxx-3',
    // 是否顯示更新彈窗
    showUpdateModal: true,
    // 更新日誌
    updateList:  [
      "1\. 新增表格組件",
      "2\. 國際化優化",
      "3\. 表單詳情頁支持內部滾動",
      "4\. 個人圖片庫性能優化",
      "5\. 下載代碼功能優化"
    ],
    // 網站logo地址
    logo: 'http://cdn.dooring.cn/dr/logo.ff7fc6bb.png',
    // 入口頁面是否展示贊助品牌和版權提示
    showAdsAndTip: true,
    // 登錄時獲取登錄碼的二維碼
    qrcode: 'http://cdn.dooring.cn/dr%2Fcode1.png',
    // 友情鏈接展示
    friendLinks: [
      {
        name: 'V6',
        link: 'http://v6.dooring.cn/beta',
        title: '可視化大屏編輯器'
      },
      {
        name: 'Power',
        link: '/powernice',
        title: '文檔編輯器'
      }
    ],
    // 默認語言
    defaultLocale: 'zh-CN',
    langMap: langMap
  },

這樣, 我們的工程化結果就可以讓不同的技術小夥伴輕鬆的享受, 讓項目創建的成本和自由度得到極大的提升.

1. 老舊腳手架無法適應當前的項目生產效率

對於這種場景, 我們就需要對腳手架自身有更多的研究和了解, 比如熟悉webpack設計思想, 熟悉babel的工作流程, 熟悉 nodejs 開發工具鏈的一些模式等, 這裏分享幾個比較成熟的先進腳手架, 大家如果覺得老項目工程比較老舊, 可以往這幾個方向重構:

• 基於webpack5.0的項目腳手架
• vite
• umi4.0

如果大家對以上三種之一比較熟悉, 也可以基於他們二次封裝成符合自身業務場景的DIY項目工具.

• 渲染層優化

渲染層優化主要表現在產品的體驗上, 比如:

1. 提高首屏加載速度
2. 白屏體驗優化
3. 大數據列表渲染優化
4. api請求優化
5. 動畫性能優化
6. dom過載導致的頁面卡頓優化

以上是我之前遇到的一些渲染優化的維度, 接下來和大家一一介紹解決思路.

1. 提高首屏加載速度

有很多方法可以幫助我們提高首屏加載速度, 比如:

• 靜態資源放cdn, 提高不同地域用戶訪問資源的速度
• 頁面或路由懶加載, 降低首次加載單一頁面的代碼體積
• 靜態資源(如圖片, 視頻等)懶加載
• 資源壓縮(比如開啓gzip模式)

當然還存在很多客觀因素, 比如用戶所在區域爲弱網環境, 我們可以根據網速提供一個最小化弱網可替代頁面, 來保證我們網站的可用性和可訪問性.

2. 白屏體驗優化

對於白屏優化, 也有很多成熟的例子, 比如採用骨架屏:

如果我們的項目是基於 vue-cli 構建的，那麼可以使用比較成熟的的 page-skeleton-webpack-plugin 方案，否則我們仍然可以選擇 vue-router 提供的 vue-server-renderer.

當然你的項目是使用react的, 也可以輕鬆使用如 react-content-loader 這樣的svg方案來定製自己的骨架屏.

除了骨架屏之外, 我們還可以提供一個模版頁面或者加載動畫, 以便在頁面加載完成之前給用戶一個優雅的過渡提示. 比如:

3. 大數據列表渲染優化

對於一些中後臺複雜的系統模塊, 可能會涉及到一次渲染大量列表項或者多級組織樹的情況:

尤其是在大公司或者大集團中出現的頻率非常高, 這種情況我們就需要用到虛擬列表或者節點懶加載的方式了. 虛擬列表應用非常廣泛, 目前也有幾個成熟的方案大家可以直接使用:

• vue virtual scroll list
• react-virtualized
• rc-virtual-list

如果你的項目目前還好沒有使用這種方案, 不妨評估一下, 是否可以用這些方案爲自己項目保駕護航.

4. api請求優化

api 請求優化主要正對這種場景: 頁面的渲染依賴於某個或者某些請求的完成, 或者由於某個頁面請求量過大導致每次重新進入頁面都需要造成一定的性能開銷.

對於這兩種情況, 其實不僅僅是對瀏覽器渲染有影響, 還會極大的增加服務器的壓力, 所以我們需要對請求或者頁面進行一定範圍的緩存.

比如說我們可以把不長變動的請求數據存在 indexedDB 中, 當第二次訪問直接可以從 indexedDB 中拿到請求數據, 這樣既降低了服務器壓力, 也提高了二次渲染的效率.

其次我們可以對部分頁面做路由緩存, 避免每次切換都重新渲染, 當然這隻針對於不需要實時更新數據的頁面而言. 我之前也分享了一篇瀏覽器緩存接口實戰的文章, 大家感興趣的可以學習參考, 對於 indexedDB, 我封裝了一個開箱即用的庫, 大家可以直接使用:

github地址: https://github.com/MrXujiang/xdb

5. 動畫性能優化

這也是個老生常談的問題, 這裏直接分享幾個方案:

• 優化精簡 DOM 結構，合理佈局
• 使用 transform 代替 left,top 減少使用引起頁面重排的屬性
• 開啓硬件加速(比如設置transform: translateZ(0) 或者transform: translate3d(0, 0, 0))
• 儘量避免瀏覽器創建不必要的圖形層
• 儘量減少 js 動畫，如需要，使用性能更友好的requestAnimationFrame
• 使用 chrome performance 工具調試動畫性能

由於dom動畫有上限很低, 所以對於一些更復雜的動畫渲染, 我們可以採用 svg 或者 canvas 來代替, 以降低 dom 對瀏覽器內存的佔用.

6. dom過載導致的頁面卡頓優化

一個頁面如果dom數量過多, 會產生很多問題, 一方面會使得瀏覽器內存佔用過高, 導致其他不相關的js邏輯操作進行阻塞或者失效, 表現就是頁面卡頓或者無響應.

爲了解決這個問題我們仍然可以使用虛擬滾動的方案或者懶加載的方案, 保證用戶當前屏幕下的dom在一個合理的範圍內, 如果是無法避免必須要展示大段dom元素, 我們可以用一個單獨的頁面來承載或者嵌入, 避免頁面其他部分宕機. 也可以對複雜dom 進行局部“冷凍”(在非激活狀態將其轉化爲圖片, 激活時在逐漸渲染)

• 產品需求層優化

產品需求層面導致的重構主要場景比如:

• 項目國際化支持
• 項目埋點
• 整體項目UI升級

當然還有很到場景這裏不一一介紹了. 以上列的場景都是比較常見的, 而且也有很多解決方案, 後期我會一一覆盤. 我們在項目重構之前或者立項之前, 這幾種情況也是需要重點考慮的, 畢竟都是大工作量的任務.

2. 技術升級帶來的重構

技術升級帶來的重構主要有前端框架的升級, 前端設計模式的升級, 腳手架的升級. 後面兩個主要是圍繞前端技術的不斷演進, 我們採取的程序性升級, 比如從傳統的 gulp 升級到 webpack, 或者從 webpack 升級到vite 等. 前者比較常見的場景是企業中有很多老的系統, 採用的是比較傳統的技術方案如 CMD 模式 + jquery, 但是新項目採用的是 webpack + vue 或者 react, 此時我們需要更新項目情況來有選擇的做重構:

1. 老項目只需要少量維護的情況

這種情況我們就不需要大刀闊斧的重新用新框架再寫一套了, 我們只需要在重構時, 對老項目代碼做好足夠的註釋, 類庫的封裝即可:

其次我們需要做好js變量隔離, 因爲傳統模式我們會在 window 頂層定義大量 var 全局變量, 作爲優化的一部分, 我們可以採用閉包自執行和變量約定來規範我的js變量定義, 以防止全局的變量污染.

1. 老項目仍然需要不斷迭代, 並且後期會有新的模塊

這種情況我們需要做評估和拆分, 如果是小模塊, 我們可以用 jquery插件 的方式快速爹迭代, 如果是頁面級別的迭代, 並且交互比較複雜, 我們可以將老系統的新頁面拆離一個子工程, 採用最新的框架(如vue)來開發迭代, 再通過 MPA 的方式和老系統做集成:

1. 老項目和新項目需要相互通信, 嵌套

這種場景下最好的方式就是用iframe + postmessage, 或者我們可以參考類似微前端的方式來管理組織不同子系統.

3. 組件庫重構

對於一個包含很多子系統的複雜的項目系統來說，要想設計一個好的架構，第一步就是合理劃分組件，組件的粒度拆成的足夠細，這樣才能最大限度的複用組件。

對於任何一個複雜系統來說，最重要的就是實現錯綜複雜的業務功能，但是不同模塊或者子系統之間很多業務往往是相通的或者相似的，如果這個時候我們每個頁面對於實現類似的業務場景都去重複去寫一遍業務代碼，那完全是沒必要的，對於可維護性來說也是一種打擊，所以基於這種場景我們的 業務組件 就很有必要出場了。我們可以把功能或者需求類似的有機體封裝成一個業務組件，並對外暴露接口來實現靈活的可定製性，這樣的話我們就可以再不同頁面不同子系統中複用同樣的邏輯和功能了。

同理，不同頁面中往往有可能出現視覺或者交互完全相同或者類似的區塊，爲了提高可複用性和提高開發效率，我們往往會基於基礎組件和業務組件再進行一次封裝，讓其成爲一個獨立的區塊以便直接複用。

通過這樣一層層封裝，我們就逐漸搭建了一套完整的組件化系統，基於這種模式的開發往往也是一個好的前端架構的開始。但要注意一點就是高層次的組件一定會依賴低層次的組件，但是低層次的組件不可以包含高層次的組件。（聽起來有點像rudex的單向數據流法則），他們的關係就好像下圖：

所以對組件庫的重構需要對我們的項目有一個本質的認知, 並對頁面進行有效的拆分, 從而達到局部的最優, 降低後續的維護成本, 並能提高整個系統甚至跨系統的複用.

有關如何從0到1教你搭建前端團隊的組件系統 我之前也寫過詳細的文章, 大家可以參考學習一下.

總結

系統重構是一個持續的過程, 我們不僅要有持續學習的態度, 還需要不斷的實踐和積累優秀的最佳實踐, 這樣才能在不斷重構中讓我們的系統不斷適應複雜多變的“社會環境”.