一、方法來源與落地場景
本文要談的 loadCss,是從 Sea.js 當中剝離出來、再進一步改良的版本(改良點會在後文逐一拆解)。之所以要做這件事,是因為公司專案需要靠延遲載入來壓低首屏的資源壓力,於是把那些並非首屏渲染必需的樣式表,改為需要時才動態插入。
二、優化後的完整程式碼
/* * @function 動態加載css文件 * @param {string} options.url -- css資源路徑 * @param {function} options.callback -- 加載後回調函數 * @param {string} options.id -- link標簽id */ function loadCss(options){ var url = options.url, callback = typeof options.callback == "function" ? options.callback : function(){}, id = options.id, node = document.createElement("link"), supportOnload = "onload" in node, isOldWebKit = +navigator.userAgent.replace(/.*(?:AppleWebKit|AndroidWebKit)\/?(\d+).*/i, "$1") < 536, // webkit舊內核做特殊處理 protectNum = 300000; // 阈值10分鐘,一秒鐘執行pollCss 500次 node.rel = "stylesheet"; node.type = "text/css"; node.href = url; if( typeof id !== "undefined" ){ node.id = id; } document.getElementsByTagName("head")[0].appendChild(node); // for Old WebKit and Old Firefox if (isOldWebKit || !supportOnload) { // Begin after node insertion setTimeout(function() { pollCss(node, callback, 0); }, 1); return; } if(supportOnload){ node.onload = onload; node.onerror = function() { // 加載失敗(404) onload(); } }else{ node.onreadystatechange = function() { if (/loaded|complete/.test(node.readyState)) { onload(); } } } function onload() { // 確保只跑一次下載操作 node.onload = node.onerror = node.onreadystatechange = null; // 清空node引用,在低版本IE,不清除會造成內存洩露 node = null; callback(); } // 循環判斷css是否已加載成功 /* * @param node -- link節點 * @param callback -- 回調函數 * @param step -- 計步器,避免無限循環 */ function pollCss(node, callback, step){ var sheet = node.sheet, isLoaded; step += 1; // 保護,大於10分鐘,則不再輪詢 if(step > protectNum){ isLoaded = true; // 清空node引用 node = null; callback(); return; } if(isOldWebKit){ // for WebKit < 536 if(sheet){ isLoaded = true; } }else if(sheet){ // for Firefox < 9.0 try{ if(sheet.cssRules){ isLoaded = true; } }catch(ex){ // 火狐特殊版本,通過特定值獲知是否下載成功 // The value of `ex.name` is changed from "NS_ERROR_DOM_SECURITY_ERR" // to "SecurityError" since Firefox 13.0. But Firefox is less than 9.0 // in here, So it is ok to just rely on "NS_ERROR_DOM_SECURITY_ERR" if(ex.name === "NS_ERROR_DOM_SECURITY_ERR"){ isLoaded = true; } } } setTimeout(function() { if(isLoaded){ // 延遲20ms是為了給下載的樣式留夠渲染的時間 callback(); }else{ pollCss(node, callback, step); } }, 20); } }
三、逐段拆解
(一)三個參數
這個方法對外只暴露三個參數,但擴充空間並不小。
1. options.url
要載入的樣式表位址,也就是最終寫進 link 標籤 href 屬性的那串內容。
2. options.id
link 標籤的 id。這是一個非必要參數,不傳也沒問題。它的價值在於「做記號」:後續可以用 JS 快速查找該節點,判斷某個 CSS 是否已經載入過,避免重複插入。
3. options.callback
樣式表載入完成後要執行的回呼函式。需要注意的是,在某些特殊情境下(例如資源 404 或輪詢超時),即使檔案實際上沒載成功,這個回呼仍會被觸發。
(二)建立節點並掛進 head
var url = options.url, callback = typeof options.callback == "function" ? options.callback : function(){}, id = options.id, node = document.createElement("link"); node.rel = "stylesheet"; node.type = "text/css"; node.href = url; if( typeof id !== "undefined" ){ node.id = id; } document.getElementsByTagName("head")[0].appendChild(node);
先用 createElement 造出一個 link 節點,把 rel、type、href 這幾個必要屬性補齊,瀏覽器才認得出這是什麼資源。接著抓到 head,把節點掛進去——真正的下載就是從這一刻開始的。
(三)用 pollCss 監控下載狀態
pollCss 的唯一職責,是想辦法確認那個 link 節點到底載完了沒。
3.1 判斷依據
瀏覽器在處理 CSS 資源時,會在對應的 link 節點上生成 sheet 屬性。不同家族的瀏覽器可以讀到的內容不太一樣,於是判斷策略也得跟著分岔。所以第一句 var sheet = node.sheet 就是先把這個屬性抓下來再說。
3.2 主流瀏覽器的判斷方式
try{ if(sheet.cssRules){ isLoaded = true; } }catch(ex){ // 火狐特殊版本,通過特定值獲知是否下載成功 // The value of `ex.name` is changed from "NS_ERROR_DOM_SECURITY_ERR" // to "SecurityError" since Firefox 13.0. But Firefox is less than 9.0 // in here, So it is ok to just rely on "NS_ERROR_DOM_SECURITY_ERR" if(ex.name === "NS_ERROR_DOM_SECURITY_ERR"){ isLoaded = true; } }
能讀到 sheet.cssRules 且有值,代表樣式表已經進到頁面並開始被解析,可以判定載入成功。若讀取過程直接拋錯,就退一步看錯誤名稱:一旦出現 NS_ERROR_DOM_SECURITY_ERR,說明這是 9.0 以前的舊版 Firefox,而且資源其實已經載好了。
3.3 舊版 WebKit 內核的判斷方式
var isOldWebKit = +navigator.userAgent.replace(/.*(?:AppleWebKit|AndroidWebKit)\/?(\d+).*/i, "$1") < 536; // webkit舊內核做特殊處理 if(isOldWebKit){ // for WebKit < 536 if(sheet){ isLoaded = true; } }
碰到 WebKit 舊內核(版本號小於 536),判斷可以大幅簡化:只要 sheet 屬性存在,就當作載入完成。
3.4 加上輪詢
setTimeout(function() { if(isLoaded){ // 延遲20ms是為了給下載的樣式留夠渲染的時間 callback(); }else{ pollCss(node, callback, step); } }, 20);
第一次呼叫 pollCss 時,資源很可能還在路上,sheet 自然是空的。所以必須反覆問,這裡的間隔是 20 毫秒一次,直到讀到為止。之所以在 isLoaded 之後還要再等 20 毫秒才呼叫 callback,是為了給瀏覽器留出把樣式真正套用上去的時間。
3.5 輪詢的保險絲(這一點是對 Sea.js 原始碼的改良)
CSS 載入是有可能失敗的,而且並不保證一定會觸發 onerror。如果完全不做保護,輪詢就可能永遠轉下去。因此必須設一個上限。
var protectNum = 300000, // 阈值10分鐘,一秒鐘執行pollCss 500次 step = 0; // 很多代碼.... step += 1; // 保護,大於10分鐘,則不再輪詢 if(step > protectNum){ isLoaded = true; // 清空node引用 node = null; callback(); return; }
這裡把上限設在 10 分鐘(20 毫秒一次,約 300000 次)。一旦超過門檻,就強制視為已完成:執行 callback、把 node 釋放掉,然後收工,避免無限輪詢拖垮頁面。
(四)決定何時啟用輪詢
4.1 輪詢的適用範圍
只有在兩種情況下才需要 pollCss:一是瀏覽器屬於舊版 WebKit 內核,二是節點根本不支援 onload 事件。
// for Old WebKit and Old Firefox if (isOldWebKit || !supportOnload) { // Begin after node insertion setTimeout(function() { pollCss(node, callback, 0); }, 1); return; }
(五)現代瀏覽器直接靠 onload 與 onreadystatechange
對現代瀏覽器來說,事件驅動遠比輪詢划算,判斷也更即時準確。
5.1 onload 的內容
function onload() { // 確保只跑一次下載操作 node.onload = node.onerror = node.onreadystatechange = null; // 清空node引用,在低版本IE,不清除會造成內存洩露 node = null; callback(); }
進入 onload 後第一件事,是把 onload、onerror、onreadystatechange 全部清空,確保 callback 只會跑一次,不會因為多個事件先後觸發而重複執行。
接著 node = null:這一步不是可有可無的修飾,低版本 IE 若不及時斷開引用,很容易累積出記憶體洩漏。
5.2 支援 onload 的瀏覽器
if(supportOnload){ node.onload = onload; node.onerror = function() { // 加載失敗(404) onload(); } }
這裡刻意讓 onerror 也走同一個 onload 流程,好處是無論成功或失敗,後續的收尾與回呼邏輯都只有一份。
5.3 不支援 onload 的瀏覽器
if(supportOnload){ // 代碼... }else{ node.onreadystatechange = function() { if (/loaded|complete/.test(node.readyState)) { onload(); } } }
四、後記
之所以挑 Sea.js 的實作當藍本,理由很實際:這個庫的使用者基數大,一旦有邊緣案例出問題,社群與作者通常都會很快修掉。以它為基礎改寫,等於站在一個被反覆驗證過的地基上,能降低自家用戶群大面積踩雷的機率。
以上就是關於動態載入 CSS 的完整解析,希望對有同樣需求的朋友有幫助。若有任何疑問,歡迎留言,我會盡快回覆。也感謝各位對網站的支持!