一種對開發更友好的前端骨架屏自動生成方案

来源:https://www.cnblogs.com/mfwtech/archive/2019/09/06/11474796.html
-Advertisement-
Play Games

(馬蜂窩技術原創內容,公眾號 ID:mfwtech) 一份來自 Akamai 的研究報告顯示,在對 1048 名網購戶進行採訪後發現: 約 47% 的用戶期望他們的頁面在兩秒之內載入完成。 如果頁面載入時間超過 3s,約 40% 的用戶會選擇離開或關閉頁面。 約 47% 的用戶期望他們的頁面在兩秒之 ...


(馬蜂窩技術原創內容,公眾號 ID:mfwtech)

一份來自 Akamai 的研究報告顯示,在對 1048 名網購戶進行採訪後發現:

  • 約 47% 的用戶期望他們的頁面在兩秒之內載入完成。

  • 如果頁面載入時間超過 3s,約 40% 的用戶會選擇離開或關閉頁面。

一直以來,為了提升用戶在頁面載入時的體驗,無論是 Web 還是 iOS、Android 的應用中,前端開發工程師都做了許多工作。除瞭解決如何讓網頁展現速度更快的問題,還有很重要的一點就是提升用戶對載入等待時間的感知。「菊花圖」以及由其衍生出的各種載入動畫就是一類常見的解決方案,相信無論是開發者還是用戶對下麵這個圖標都不會陌生:

本文要介紹的「骨架屏」則被視為菊花圖升級版的方案。受現有骨架屏方案的啟發,馬蜂窩電商前端研發團隊實現了一種自動化生成骨架屏的方法,併在馬蜂窩商城的多個頁面中實現應用,取得了不錯的效果。

 

一、什麼是骨架屏

骨架屏可以理解為在頁面數據尚未返回或頁面未完成完全渲染前,先給用戶呈現一個由灰白塊組成的當前頁面大致結構,讓用戶產生頁面正在逐漸渲染的感受,從而使載入過程從視覺上變得流暢。生成後的骨架屏頁面如下圖所示:

骨架屏的主要優勢為:

  1. 用戶避免看到長時間的白頁
  2. 可以獲知頁面的大體結構,減小用戶認為頁面出錯而離開的機率
  3. 與菊花圖相比視覺更加流暢

 

二、常見的前端骨架屏方案

在選擇骨架屏之前,我們也考慮了一些其他的方法,比如能否通過服務端渲染(SSR)的方式來避開前端白屏時間的問題。但發現需要涉及項目過多,還會涉及服務的構建與部署;或是通過 prerender-spa-plugin 提供簡單的預呈現,它對 SPA 支持友好,但需要額外的 webpack 配置,且因為包源的問題,下載時間過長,有時還會莫名失敗,等等,都因為種種原因最終放棄。

經過一系列調研後,我們對業界常見的幾種骨架屏解決方案,以及它們的優勢、不足進行了一個簡單的梳理。

1. UI 骨架屏圖

即通過 UI 提供符合頁面首頁樣式的圖來充當骨架屏,將骨架屏 base64 圖片插入 root 根節點,在 webpack 打包時嵌入項目中。

這是一種簡單粗暴的方法,實現起來比較容易。但缺點也很明顯,就是需要 UI 設計師支持和開發介入,不能自動生成。

2.  手寫骨架屏

即通過手寫 HTML、CSS 的方式為目標頁定製骨架屏。這種方式可以做到對頁面真實樣式的復刻。不過一旦由於各種原因導致頁面樣式發生改變,就需要再改一遍骨架屏的樣式和佈局,極大增加了維護的成本。

3. 自動生成靜態骨架屏

目前比較受關註的是餓了麽開源的插件 page-skeleton-webpack-plugin,其具體實現原理為:

  • 生成骨架屏

通過 Puppeteer 操控 handless Chrome 打開需要生成的骨架屏頁面,在等待頁面載入完成之後,保留頁面佈局樣式的前提下,通過對頁面中元素進行增刪,對已有元素通過層疊樣式進行覆蓋,使其展示為灰白塊。然後將修改後的 HTML 和 CSS 提取出來,將頁面分為不同的塊區域,例如文本塊、圖片塊、按鈕塊、SVG、偽類元素塊等,分別對每個塊進行處理,使其儘量與原頁面保持一致。這裡用到了 Puppeteer  page 實例的 addScriptTag 方法來將處理塊的腳本插入到 headless Chrome 打開的頁面當中。

實際生成的骨架屏頁面與原頁面可能還會存在差距,插件通過 memory-fs 將骨架屏寫入記憶體中,可以通過預覽頁面對生成的骨架屏進行二次編輯和效果預覽,修改完成後點擊生成按鈕就能生成一份新的骨架屏寫入到項目中。

借一張圖來說明:

  • 插入骨架屏

骨架屏的 DOM 結構和 CSS 通過離線生成後,在構建時註入模板 (EJS) 中的節點下麵,插入到 HTML 是在 after-emit 鉤子函數中進行。

page-skeleton-webpack-plguin 生成骨架屏的方案可以根據項目中不同的路由頁面生成相應的骨架屏頁面,並將骨架屏頁面通過 webpack 打包到對應的靜態路由頁面中。

它的不足之處在於:

  • 實際使用過程中無法監聽介面返回導致生成骨架屏的時機是否準確

  • 生成的頁面與業務人員寫的結構質量有直接關係,經常出現需要手工二次調整的情況

在這樣的背景下,馬蜂窩電商研發前端團隊希望找一種在提升用戶體驗的同時,對開發更友好的骨架屏生成方式,能針對不同的業務場景自動生成出相似的骨架屏,並且實現自動註入。對於開發而言,只需要執行一條命令,或者簡單配置,就可以生成骨架屏,不需要再考慮後續的維護工作。

在方案調研過程中,draw-page-structure 為我們的設計提供了靈感。

4. draw-page-structure

  • 生成骨架屏:
// dps.config.js
{
  url: 'https://baidu.com',
  output: {
    filepath: '/Users/famanoder/DrawPageStructure/example/index.html',
    injectSelector: '#app'
  },
  background: '#eee',
  animation: 'opacity 1s linear infinite;',
  // ...
}

根據 URL 指定的線上地址,配合 Puppeteer 獲取當前頁面的 DOM 結構,並對其中元素節點生成骨架屏文件到 filepath 指定的文件裡面,就可以生成骨架屏頁面,結果如下圖所示:

  • 插入骨架屏

將上述生成的骨架屏文件插入到頁面根節點下麵一般為 id="app" 的節點,然後在通用工具里提供主動銷毀骨架屏的方法,就可以幫助開發主動控制或銷毀骨架屏,顯示頁面真實內容。

draw-page-structure 的設計思想很大程度上可以滿足我們的需求,不足的是只能對線上已經存在的 URL 生成骨架屏,不支持開發環境。另外由於是自動生成,當頁面存在重定向(如果未登錄重定向到登錄頁面)的情況時,生成的骨架屏可能與預期不一致。而且它的內部實現並不完善,可能導致某些結構複雜的頁面下生成的骨架屏需要二次優化調整。

於是,我們開始了進一步的探索。

三、對開發更友好的實現方案

1. 設計思路

基於對現有方案的借鑒,我們想到了在配置文件中指定要生成骨架屏的頁面 URL 和文件輸出的目錄,運行時讀取配置文件中的配置項,通過 Puppeteer 打開指定的頁面並註入 evalDom.js 的方法。因為此 JS 是在 Puppeteer 裡面執行的,所以可以獲取到當前頁面完整的 DOM 結構,這給我們留下了非常大的發揮空間。

最初我們是從獲取到的 DOM 結構中的 body 標簽出發,遞歸去處理頁面上的所有節點,處理完成後用生成的 DIV 替換原有元素的位置。第一版方案中通過 getBoundingClientRect 和 getComputedStyle 的方法來獲取元素所有計算屬性和相對於視口的寬高和位置,然後結合元素本身的樣式屬性遞歸渲染,保留頁面原始 DOM 嵌套層次。

但由於能夠決定元素位置的屬性實在太多,如 position,z-index、width、height、top、display、box-sizing、flex 等都需要考慮,導致無法聚焦對頁面 DOM 結構處理的邏輯,而且這些屬性在處理完成後還需要加到最終生成骨架屏節點的 style 上,這樣骨架屏文件可能比原來完整的頁面結構還大,這肯定不是我們希望的。

優化後的方案是用 getBoundingClientRect 和 getComputedStyle 獲取元素相關屬性,然後直接通過絕對定位的方式來生成最終的骨架屏節點。這樣在頁面上最終需要的屬性主要是 position、z-index、top、left、width、height、background、border-radius。除了無法保證頁面原始的 DOM 結構,其它需求基本都可以滿足,也更加聚焦於節點的處理。

主要實現流程如下圖:

該方案目前主要應用於馬蜂窩電商業務的多頁面項目中,包括下單頁、簽證頁等,以下單頁為例,展示效果如下圖:

2. 實現方式

  • 生成骨架屏

(1) config.js 配置

const dpsConfig = {
   // 預設生成位置為當前項目目錄skeleton文件夾,已有骨架屏頁面不會再次生成,新頁面配置只需要添加新條目即可
    visa_guide: {
        url: 'https://w.mafengwo.cn/sfe-app/visa_guide.html?mdd_id=10083', // 必填項
    },
    call_charge: {
        url: 'http://localhost:8081/sfe-app/call_charge.html?rights_id=25', // 必填項 待生成骨架屏頁面的地址,用百度(https://baidu.com)試試也可以
        //url:'https://www.baidu.com',
        device: 'pc', // 非必填,預設mobile
        background: '#eee', // 非必填
        animation: 'opacity 1s linear infinite;', // 非必填
        headless:false, // 非必填
        customizeElement: function(node) { // 非必填
            //返回值枚舉如果是true表示不會向下遞歸到這層為止,如果返回值是一個對象那麼節點的檔子就按照對象裡面的樣式來繪製
            //如果返回值為0表示正常遞歸渲染
            //如果返回值為1表示渲染當前節點不在向下遞歸
            //如果返回值為2表示對當前節點不作任何處理
            if(node.className === 'navs-bottom-bar'){
                return 2;
            }
            return 0;
        },
        showInitiativeBtn: true,// 非必填 如果此值設置為true表示開發需要主動觸發生成骨架屏了,此時headless需設置為false
        writePageStructure: function(html) { // 非必填
            // 自己處理生成的骨架屏
            // fs.writeFileSync(filepath, html);
            // console.log(html)
        },
        init: function() { // 非必填
            // 生成骨架屏之前的操作,比如刪除干擾節點
        }  
    }
}


module.exports = dpsConfig;

(2)Puppeteer 新打開頁面並返回瀏覽器實例、openPage

const ppteer = require('puppeteer');
const { log, getAgrType } = require('./utils');
const insertBtn = require('../insertBtn');


const devices = {
  mobile: [375, 667, 'Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Mobile/15A372 Safari/604.1'],
  ipad: [1024, 1366, 'Mozilla/5.0 (iPad; CPU OS 11_0 like Mac OS X) AppleWebKit/604.1.34 (KHTML, like Gecko) Version/11.0 Mobile/15A5341f Safari/604.1'],
  pc: [1200, 1000, 'Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Mobile/15A372 Safari/604.1']
};

async function pp({device = 'mobile', headless = true, showInitiativeBtn = false}) {

  const browser = await ppteer.launch({headless});//返回browser實例

  async function openPage(url, extraHTTPHeaders) {
    const page = await browser.newPage();
    let timeHandle = null;

   if(showInitiativeBtn){
    browser.on('targetchanged', async ()=>{//監聽頁面路由變化,並獲取當前標簽頁的最新的頁面,在showInitiativeBtn為true時插入按鈕由開發控制主動生成骨架屏
      const targets = await browser.targets();
      const currentTarget = targets[targets.length - 1]
      const currentPage = await currentTarget.page();

      clearTimeout(timeHandle)
      setTimeout(()=>{
        if(currentPage){
          currentPage.evaluate(insertBtn);
        }
      },300)
    })
   }
    try{
      let deviceSet = devices[device];
      page.setUserAgent(deviceSet[2]);
      page.setViewport({width: deviceSet[0], height: deviceSet[1]});

      if(extraHTTPHeaders && getAgrType(extraHTTPHeaders) === 'object') {
        await page.setExtraHTTPHeaders(new Map(Object.entries(extraHTTPHeaders)));
      }
      await page.goto(url, {
        waitUntil: 'networkidle0'//不再有網路連接時觸發(至少500ms後)
      });
    }catch(e){
      console.log('\n');
      log.error(e.message);
    }
    return page;
  }
  return {
    browser,
    openPage
  }
};

module.exports = pp;

(3)在瀏覽器環境里執行 evalDom.js 和 evalDom.js 中處理 node 節點的主要邏輯

agrs.unshift(evalScripts);//evalScripts = require('../evalDOM');在puppeteer里執行evalDom.js並將config.js里配置的參數傳遞給evalDom
html = await page.evaluate.apply(page, agrs);
//evalDom.js主要邏輯
startDraw: function () {
    const $this = this;
    const nodes = this.rootNode.childNodes;
    this.beforeRenderDomStyle();
    function childNodesStyleConcat(childNodes) {
        for (let i = 0; i < childNodes.length; i++) {
            const currentChildNode = childNodes[i];//當前子節點
            //有哪些節點要跳過繪製骨架屏的過程

            if ($this.shouldIgnoreCurrentElement(currentChildNode)) { //是否應該忽略當前節點,不採取任何措施。後續這個地方可以由用戶指定哪些節點應該被略去,todo
                continue;
            }

            const backgroundHasurl = analyseIfHadBackground(currentChildNode);
            const hasDirectTextChild = childrenNodesHasText(currentChildNode);//判斷當前元素是不是有直接的子元素並且此元素是Text
            if ($this.customizeElement && $this.customizeElement(currentChildNode) !== 0 && $this.customizeElement(currentChildNode) !==  undefined) {
                //開發者自定義節點需要渲染的樣子,預設返回false表示使用正常遞歸的演算法來處理。如果返回值是true表示不會在向下遞歸,如果返回值是一個對象那麼表示開發需要自定義樣式此時直接繪製就好。todo
                if (getArgtype($this.customizeElement(currentChildNode)) === 'object') {
                    console.log('object');
                    //此處如果返回一個對象表示對象要自定義最後繪製的對象
                } else if ($this.customizeElement(currentChildNode) === 1) {
                    //如果此時返回true,表示此節點要過濾
                    getRenderStyle(currentChildNode);
                } else if ($this.customizeElement(currentChildNode) === 2){
                    continue ;
                }
                continue;
            }
            if (backgroundHasurl || analyseIsEmptyElement(currentChildNode) || hasDirectTextChild || shouldDrawCurrentNode(currentChildNode)) { //如果當前元素是內聯元素或者當前元素非內聯元素,但是不包含子節點或者子節點都是內聯元素的話那麼我們就在當前的骨架屏上繪製此節點。                   
                getRenderStyle(currentChildNode, hasDirectTextChild);
            } else if (currentChildNode.childNodes && currentChildNode.childNodes.length) { //如果當前節點包含子節點
                //遞歸
                childNodesStyleConcat(currentChildNode.childNodes);
            }
        }
    }
    childNodesStyleConcat(nodes);
    return this.showBlocks();
},  
  • 上述 rootNode 為根節點,預設為 document.body 或者可以由開髮指定

  • 主要邏輯為判斷當前節點是否需要忽略、是否設置了背景圖片、是否含有文本信息、開發是否指定了當前節點的處理方式等,對滿足條件的渲染其對應的骨架屏節點,否則處理當前節點的子節點

  • 所有節點處理完成後,調用 showBlocks 將生成的骨架屏節點拼接位 HTML 字元串,以便後續處理

(4) getRenderStyle 生成骨架屏樣式

const styles = [
    'position: fixed',
    `z-index: ${zIndex}`,
    `top: ${top}%`,
    `left: ${left}%`,
    `width: ${width}%`,
    `height: ${height}%`,
    'background: '+(background || '#eee'),
];
const radius = getStyle(node, 'border-radius');
radius && radius != '0px' && styles.push(`border-radius: ${radius}`);
blocks.push(`<div style="${styles.join(';')}"></div>`);
  • zIndex、top、left、width、height 為處理後的屬性,然後把所有骨架屏節點的字元串都 push 進 blocks 這個數組中。

(5) 最終生成骨架屏的 HTML 文件如下:

<html><head></head>
    <body><div style="position: fixed;z-index: 999;top: 89.805%;left: 4.267%;width: 91.467%;height: 11.994%;background: #eee"></div></body></html>
  • 插入骨架屏

在項目入口 index.html 文件內添加

<body>
    <div id="app">
    </div>
    <% if(htmlWebpackPlugin.options.hasSkeleton) { %>
        <div id="skeleton"><!-- 骨架屏通過htmlWebpackPlugin在啟動打包的時候自動註入 -->
            <%= htmlWebpackPlugin.options.loading.html %>
        </div>
    <% } %>
    <!-- built files will be auto injected -->
</body>

四、 總結

目前,該方案已經支持由開發主動控制骨架屏生成時間,這樣就避免了頁面重定向的過程中無法生成正確的骨架屏,同時可以支持在本地開發時生成骨架屏。未來我們將實現支持開發自定義生成骨架屏節點的樣式和組件骨架屏的生成,並優化 evalDom.js 內部節點過濾、處理的演算法。敬請期待!

最後,我們正在招聘資深前端開發工程師,歡迎感興趣的同學發送簡歷至:[email protected]

本文作者:康岑波、孫昊男,馬蜂窩電商平臺前端研發工程師。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 向DataGrid數據表格增加查詢搜索框 效果如下: js代碼: $(function(){ var dg = $('#dg').datagrid({ url:"${pageContext.request.contextPath}/OfferServlet",//servlet路徑 columns: ...
  • 一個box中,點擊其中的任意位置,會有煙花從正下方升起到點擊處,並燃放出一圈圓形的煙花。代碼如下: 首先是佈局以及樣式: 只給一個盒子的佈局,燃放的煙花以及綻放的小煙花都是中js代碼中創建。 js代碼: 順便把我封裝的一些實用的函數分享出來: 若有不足,還望指出。可以一起互相交流學習一下 ...
  • 問題講解:在使用vue版本的ElementUI中的table功能的時候還是遇到了一些問題,可以說餓了麽團隊在這個UI框架的文檔撰寫已經非常不錯了,不過還是有一些方法乍一看讓人摸不著頭腦,有些table的常用功能示例代碼提供的不是非常詳細,所以這次針對這個可展開表格實現手風琴效果寫一篇博客探討一下。 ...
  • 1.nodejs安裝,地址 https://nodejs.org/en/ 2.在本地項目中運行npm run build 命令將開發好的項目打包生成.nuxt文件夾,然後把.nuxt文件夾、nuxt.config.js、static文件夾、package.json (如果有自己創建的文件夾也需拷貝) ...
  • 首先在要使用的靜態文件代碼中引入‘./sliderVerify/sliderVerify.js‘ 先看看效果 示例代碼 另外 如果你不是用的layui的form提交 那麼這裡提供了一種方法 可以拿去放在你自己想要驗證的form中 作為校驗依據 或者你可以配置一下滑動成功時的回調 使用該方法可以將組件 ...
  • <!doctype html><!--聲明文檔類型 網頁文檔--> <html lang="en"><!--根目錄標簽 父級--> <head><!--網頁的頭部 用戶看不見的--> <meta charset='UTF-8'><!--國際編碼 字元的編碼格式--> <!--網頁三要素 title ... ...
  • 過去十年,是前端覺醒的十年。 前端這個行業很年輕,更早時候其實是有前端工作但是沒有前端崗位。大家覺得這個東西程式員做也行,設計師做也行。前端工作一直存在,但是沒有人認為它是一個獨立的工種和崗位,也沒有人去發展它的工程體系,更沒有人去找它的核心價值。所以如果說過去十年前端是什麼樣的十年,我認為是覺醒的 ...
  • 本來是想做一個滑鼠點擊事件:A,B兩個東西,B先隱藏,點擊A,B出現,再點一次A,B消失,然後發現在判斷不同的情況下,出現了一點小問題 暫時沒有問題的寫法: 然後,我把它的判斷條件改了一下,其實這是我第一次寫的想法: 然後它的效果是,第一次點擊的時候沒有反應,要點第二次,B才會出來,有點不明白 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...