hi, 大家好, 我是徐小夕, 今天和大家分享一下前端項目重構(gòu)的一些思考和復盤, 同時也是對自己多年項目研發(fā)經(jīng)驗的一個總結(jié).

一. 背景介紹

1. 我們?yōu)槭裁匆鲰椖恐貥?gòu)

項目重構(gòu)是每一家穩(wěn)定發(fā)展的互聯(lián)企業(yè)的必經(jīng)之路, 就像一個產(chǎn)品的誕生, 會經(jīng)歷產(chǎn)品試錯和產(chǎn)品迭代 一樣, 隨著業(yè)務(wù)或新技術(shù)的不斷發(fā)展, 已有架構(gòu)已無法滿足更多業(yè)務(wù)擴展的需求, 所以只有通過重構(gòu)來讓產(chǎn)品“進化”, 才能跟上飛速發(fā)展的時代浪潮.

圖片

這里我結(jié)合自己的實際經(jīng)驗總結(jié)一下項目重構(gòu)的幾個原因:

1. 技術(shù)因素

技術(shù)因素主要有如下幾個方面:

• 早期技術(shù)團隊在技術(shù)選型上的誤判(常發(fā)生于MVP類型的產(chǎn)品快速上線導致的技術(shù)調(diào)研不夠充分)
• 新老技術(shù)框架的更替(比如從 jquery 遷移到 vue/react)
• 技術(shù)團隊交接出現(xiàn)的斷層(老技術(shù)團隊的架構(gòu)設(shè)計更不上新技術(shù)團隊的發(fā)展, 出現(xiàn)架構(gòu)上的“平替”)
• 技術(shù)架構(gòu)升級(比如隨著業(yè)務(wù)發(fā)展, 由傳統(tǒng)的MPA應用轉(zhuǎn)為基于微前端模式的SPA應用)
• 安全,性能,代碼質(zhì)量等原因?qū)е碌募夹g(shù)重構(gòu)

2. 產(chǎn)品因素

• 產(chǎn)品形態(tài)調(diào)整(比如由純PC應用轉(zhuǎn)為響應式應用, 或者從H5到支持跨端)
• 產(chǎn)品業(yè)務(wù)調(diào)整(非常常見的重構(gòu)理由之一)
• 產(chǎn)品指標調(diào)整(如兼容性, 性能指標等導致的代碼重構(gòu))

上面是我列出來的比較典型的重構(gòu)場景, 也是我們未來在設(shè)計產(chǎn)品技術(shù)架構(gòu)之前需要考慮的方面. 為了提高自己設(shè)計的架構(gòu)穩(wěn)定性, 我們需要提前和產(chǎn)品溝通明確, 以降低后期重構(gòu)和維護成本.

最后總結(jié)幾條架構(gòu)設(shè)計的經(jīng)驗:

• 能做規(guī)范的一定要嚴格做好規(guī)范
• 在設(shè)計架構(gòu)之前, 一定要充分理解業(yè)務(wù)場景, 明確產(chǎn)品的技術(shù)交付指標
• 架構(gòu)設(shè)計以可溯源 為基本要求
• 不要盲目追求最好的方案, 以局部最優(yōu)解為工程設(shè)計理念

3.做項目重構(gòu)之前, 需要有哪些準備

當然做項目重構(gòu)也是有技術(shù)門檻的,不是所有程序員都能做好重構(gòu)工作, 建議大家具備如下幾種技術(shù)能力:

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

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

二. 不同類型項目重構(gòu)的方法論

1. 業(yè)務(wù)系統(tǒng)自身的重構(gòu)

業(yè)務(wù)系統(tǒng)自身的重構(gòu)一般可以包含如下幾個方面:

• 業(yè)務(wù)代碼優(yōu)化

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

• 復雜業(yè)務(wù)邏輯需要編寫注釋
• 代碼中訪問性屬性提供兼容邏輯(常見的比如訪問對象屬性, a.b.c, 如果a,b為非對象則整段代碼將報錯)
• 代碼結(jié)構(gòu)優(yōu)化(比如冗長的if else 或者“回調(diào)地獄” 可以采用適配器模式或者es6+語法來優(yōu)化)
• 方法參數(shù)調(diào)優(yōu)(一個函數(shù)有多個參數(shù), 可以使用參數(shù)對象來提高可讀性,降低使用偏差)
• 業(yè)務(wù)代碼性能優(yōu)化(復雜后臺系統(tǒng)比如低代碼類產(chǎn)品, 前端需要處理很多數(shù)據(jù)和邏輯, 此時可以用合適的數(shù)據(jù)結(jié)構(gòu)和算法優(yōu)化js計算)
• 函數(shù)式編程思想優(yōu)化業(yè)務(wù)函數(shù)(可選)
• 業(yè)務(wù)代碼進行單元測試, 提高代碼質(zhì)量(可選)
• 代碼規(guī)范

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

常用的措施有:

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

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

• 工程化優(yōu)化

工程化優(yōu)化主要有以下幾個場景:

• 由于業(yè)務(wù)不斷增加, 系統(tǒng)的復雜性加大導致的本地運行和打包速度越來越慢
• 由于項目代碼量的增加導致頁面臃腫, 需要進行合理的拆分
• 基于已有的工程經(jīng)驗沉淀, 需要對工程化配置做進一步升級, 優(yōu)化
• 老舊腳手架無法適應當前的項目生產(chǎn)效率

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

1. 由于業(yè)務(wù)不斷增加, 系統(tǒng)的復雜性加大導致的本地運行和打包速度越來越慢

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

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

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

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',
        },
      ],
    }),
  ],
};

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

其他還有很多優(yōu)化的方案, 這里我列一下, 大家可以根據(jù)實際情況使用:

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

當然除了對已有構(gòu)建工具的優(yōu)化, 我們可以評估一下重構(gòu)成本, 將構(gòu)建內(nèi)核替換vite等更高效的構(gòu)建工具.

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

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

圖片

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

綜上, 我們可以根據(jù)項目復雜度, 做如下優(yōu)化:

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

當然我們始終需要保持一個理念: 局部最優(yōu), 誤增繁復.

3. 基于已有的工程經(jīng)驗沉淀, 需要對工程化配置做進一步升級, 優(yōu)化

這種情況主要是在項目發(fā)展穩(wěn)定之后, 需要思考的重構(gòu)方向, 比如早期由于業(yè)務(wù)場景單一, 很多公共配置都寫在業(yè)務(wù)代碼里的, 隨著業(yè)務(wù)復雜之后, 很多模塊都需要使用改配置或者變量, 比如:

// 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';

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

拿我的親身經(jīng)驗, 比如幾年前我開發(fā)的低代碼項目H5-Dooring, 有一些零散的配置信息分散在項目的各個角落, 后面經(jīng)過幾次重構(gòu)優(yōu)化之后, 整個項目只需要在配置文件中輕松配置內(nèi)容, 即可一鍵控制頁面的走向, 這里分享一下優(yōu)化過后的配置文件:

// h5-dooring全局配置文件
define: {
    START_ENV,
    lang,
    // 配置h5端訪問的域名
    h5Domain: 'h5.dooring.cn',
    // 設(shè)置當前版本號
    curVersion: dooringVersion,
    // 備案信息
    copyright: 'xxxxx-3',
    // 是否顯示更新彈窗
    showUpdateModal: true,
    // 更新日志
    updateList:  [
      "1. 新增表格組件",
      "2. 國際化優(yōu)化",
      "3. 表單詳情頁支持內(nèi)部滾動",
      "4. 個人圖片庫性能優(yōu)化",
      "5. 下載代碼功能優(yōu)化"
    ],
    // 網(wǎng)站logo地址
    logo: 'http://cdn.dooring.cn/dr/logo.ff7fc6bb.png',
    // 入口頁面是否展示贊助品牌和版權(quán)提示
    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
  },

這樣, 我們的工程化結(jié)果就可以讓不同的技術(shù)小伙伴輕松的享受, 讓項目創(chuàng)建的成本和自由度得到極大的提升.

4. 老舊腳手架無法適應當前的項目生產(chǎn)效率

圖片

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

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

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

• 渲染層優(yōu)化

渲染層優(yōu)化主要表現(xiàn)在產(chǎn)品的體驗上, 比如:

• 提高首屏加載速度
• 白屏體驗優(yōu)化
• 大數(shù)據(jù)列表渲染優(yōu)化
• api請求優(yōu)化
• 動畫性能優(yōu)化
• dom過載導致的頁面卡頓優(yōu)化

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

1. 提高首屏加載速度

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

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

當然還存在很多客觀因素, 比如用戶所在區(qū)域為弱網(wǎng)環(huán)境, 我們可以根據(jù)網(wǎng)速提供一個最小化弱網(wǎng)可替代頁面, 來保證我們網(wǎng)站的可用性和可訪問性.

2. 白屏體驗優(yōu)化

對于白屏優(yōu)化, 也有很多成熟的例子, 比如采用骨架屏:

圖片

如果我們的項目是基于 vue-cli 構(gòu)建的，那么可以使用比較成熟的的 page-skeleton-webpack-plugin 方案，否則我們?nèi)匀豢梢赃x擇 vue-router 提供的 vue-server-renderer.

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

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

圖片

3. 大數(shù)據(jù)列表渲染優(yōu)化

對于一些中后臺復雜的系統(tǒng)模塊, 可能會涉及到一次渲染大量列表項或者多級組織樹的情況:

圖片

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

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

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

4. api請求優(yōu)化

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

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

比如說我們可以把不長變動的請求數(shù)據(jù)存在 indexedDB 中, 當?shù)诙卧L問直接可以從 indexedDB 中拿到請求數(shù)據(jù), 這樣既降低了服務(wù)器壓力, 也提高了二次渲染的效率.

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

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

5. 動畫性能優(yōu)化

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

• 優(yōu)化精簡 DOM 結(jié)構(gòu)，合理布局
• 使用 transform 代替 left,top 減少使用引起頁面重排的屬性
• 開啟硬件加速(比如設(shè)置transform: translateZ(0) 或者transform: translate3d(0, 0, 0))
• 盡量避免瀏覽器創(chuàng)建不必要的圖形層
• 盡量減少 js 動畫，如需要，使用性能更友好的requestAnimationFrame
• 使用 chrome performance 工具調(diào)試動畫性能

由于dom動畫有上限很低, 所以對于一些更復雜的動畫渲染, 我們可以采用 svg 或者 canvas 來代替, 以降低 dom 對瀏覽器內(nèi)存的占用.

6. dom過載導致的頁面卡頓優(yōu)化

一個頁面如果dom數(shù)量過多, 會產(chǎn)生很多問題, 一方面會使得瀏覽器內(nèi)存占用過高, 導致其他不相關(guān)的js邏輯操作進行阻塞或者失效, 表現(xiàn)就是頁面卡頓或者無響應.

為了解決這個問題我們?nèi)匀豢梢允褂锰摂M滾動的方案或者懶加載的方案, 保證用戶當前屏幕下的dom在一個合理的范圍內(nèi), 如果是無法避免必須要展示大段dom元素, 我們可以用一個單獨的頁面來承載或者嵌入, 避免頁面其他部分宕機. 也可以對復雜dom 進行局部“冷凍”(在非激活狀態(tài)將其轉(zhuǎn)化為圖片, 激活時在逐漸渲染)

• 產(chǎn)品需求層優(yōu)化

產(chǎn)品需求層面導致的重構(gòu)主要場景比如:

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

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

2. 技術(shù)升級帶來的重構(gòu)

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

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

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

圖片

其次我們需要做好js變量隔離, 因為傳統(tǒng)模式我們會在 window 頂層定義大量 var 全局變量, 作為優(yōu)化的一部分, 我們可以采用閉包自執(zhí)行和變量約定來規(guī)范我的js變量定義,  以防止全局的變量污染.

老項目仍然需要不斷迭代, 并且后期會有新的模塊

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

圖片

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

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

3. 組件庫重構(gòu)

圖片

對于一個包含很多子系統(tǒng)的復雜的項目系統(tǒng)來說，要想設(shè)計一個好的架構(gòu)，第一步就是合理劃分組件，組件的粒度拆成的足夠細，這樣才能最大限度的復用組件。

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

同理，不同頁面中往往有可能出現(xiàn)視覺或者交互完全相同或者類似的區(qū)塊，為了提高可復用性和提高開發(fā)效率，我們往往會基于基礎(chǔ)組件和業(yè)務(wù)組件再進行一次封裝，讓其成為一個獨立的區(qū)塊以便直接復用。

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

圖片

所以對組件庫的重構(gòu)需要對我們的項目有一個本質(zhì)的認知, 并對頁面進行有效的拆分, 從而達到局部的最優(yōu), 降低后續(xù)的維護成本, 并能提高整個系統(tǒng)甚至跨系統(tǒng)的復用.

圖片

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

總結(jié)

系統(tǒng)重構(gòu)是一個持續(xù)的過程, 我們不僅要有持續(xù)學習的態(tài)度, 還需要不斷的實踐和積累優(yōu)秀的最佳實踐, 這樣才能在不斷重構(gòu)中讓我們的系統(tǒng)不斷適應復雜多變的“社會環(huán)境”.