一般的 JS 元件通常伴隨著 CSS 與圖片,使用時得手動引入三種資源,稍嫌麻煩。為了讓元件真正做到「拿一支檔案就能用」,可以把 CSS 與圖片一起打包進 JS;順帶的收益是請求數大幅下降——老實說,這個「順便」反而更誘人。
JavaScript 元件打包模式
為什麼不直接用現成方案
市面上已有 resource-packages 這類打包方案,但無奈的是,我們的核心使用者還停留在 IE6 這種「時尚」的瀏覽器上。先進方案在這裡派不上用場,只能自己動手。
我的做法
- CSS:把樣式當成字串存在 JS 裡,再由 JS 動態插入到頁面。一般頁面或許不適合這麼做,但元件通常影響範圍有限,可以接受。
- image:CSS 中用到的圖片,以 dataURI(RFC 2397)與 MHTML(RFC 2557)兩種方式編碼進 JS。CSS 若需要絕對路徑同樣可以放進 JS;JS 中直接引用圖片的理論上也行得通,但通常只改 className 會比較乾淨。
- flash:較小的 swf(例如用於儲存、複製功能的)也可以打包,但目前非 IE 的處理尚未解決,非 IE 環境建議還是走外部連結。
一些細節與糾結
- 並非所有圖片都該打包。進包的應該是必用圖片;被排除的那些,是另打一包好,還是直接沿用圖片檔?這取決於使用比例。
- 先壓縮再編碼。我選用的 PNG 壓縮工具是 pngout,一般加上
-s5 參數。有人做過 base64 是否反而讓資料變大的測試,結論不一,建議自行實測。
- 重複引用的圖片會讓檔案暴漲。同一張圖用 dataURI 寫十次就是十份資料,而 gzip 在這種情況下壓縮效果有限。解法是把圖片存成 JS 變數重複引用(我的做法),或者用提 class 的方式(淘寶同事的做法)。
- MHTML 的相容性坑。IE7+ 與 Vista 缺少結束分隔符號會無法顯示;Win03 SP2 缺少 Content-Type 會跳出安全性提示。根因都是 MIME 實作不標準——不是所有東西都能省。
- 打成一份還是分成兩份?可以全部包進單一檔案,也可以依 MHTML / dataURI 分兩包,由伺服器依 UA 派送檔案,或讓函式庫自行判斷讀取。後者似乎更和諧。
- swf 用 dataURI 有問題。據說 Flash Player 8 沒問題,但現在都 FP10 了。另一種讓 swf 獨立的方法是反過來把 JS 打包進 swf,不過感覺不太對稱。
multipart/related 範例
不算標準但能跑,換行在這裡格外重要:
Content-Type: multipart/related; boundary="_BAIDU_YOUA_BB_YEP"
--_BAIDU_YOUA_BB_YEP
Content-Type: image/png
Content-Location: logo.png
Content-Transfer-Encoding: base64
...base64...
--_BAIDU_YOUA_BB_YEP
Content-Type: image/png
Content-Location: nono.png
Content-Transfer-Encoding: base64
...base64...
--_BAIDU_YOUA_BB_YEP--
後記
這套做法在 IE6 至現代瀏覽器橫跨的年代是無奈之舉。以今天的眼光看, bundler 與 HTTP/2 已經讓「減少請求數」這個理由大幅弱化,元件化的主流做法也轉向標準的模組系統。但其中某些思路——例如把可變樣式抽成設定、避免元件樣式污染宿主頁面——放到今日仍然適用。