在 JS 檔案裡嵌入大量字串常量是很常見的需求。為了省事,我們常把一些介面的 HTML 和 CSS 直接寫進 JS 裡。
數量少的時候還好,一旦多起來就是密密麻麻一大坨,視覺上非常難受。講究美觀的工程師會用大量字串串接符號,甚至加上縮進,硬把它拆成好幾行:
var html =
'<div>' +
'<p>Hello</p>' +
'<p>World</p>' +
'</div>';
如果字串裡還摻了不少雙引號、單引號,那就更麻煩了——各種跳脫字元看得眼花繚亂,少一個反斜線就整段跑掉。
其實有個不太起眼的小技巧能解決這個問題。
大家都知道字串必須包在 "..." 或 '...' 裡,這點沒錯。但還有一個地方的內容會被當成純文字保存下來,那就是函式的 toString() 輸出——把整個函式的程式碼當字串丟出來,其中的註解部分當然也一併保留。
所以我們寫一個空函式,裡面只放一個 /**/ 註解,註解內容就是我們要保存的常量。呼叫 toString() 之後再用正則把註解部分撈出來,就得到原始字串了。
var RES_CODE = _TEXT(function () {/*
#include <iostream>
int main()
{
std::cout << "Hello world" << std::endl;
return 0;
}
*/});
var RES_POEM = _TEXT(function () {/*
更吹落、星如雨。
寶馬雕車香滿路。
鳳簫聲動,玉壺光轉,一夜魚龍舞。
蛾兒雪柳黃金縷,
笑語盈盈暗香去。
眾裡尋他千百度,
驀然回首,那人卻在、燈火闌珊處。
*/});
var RES_XML = _TEXT(function () {/*
<projectDescription>
<name>Hello</name>
<comment></comment>
<projects></projects>
<buildSpec>
<buildCommand>
<name>com.adobe.flexbuilder.project.flexbuilder</name>
<arguments></arguments>
</buildCommand>
</buildSpec>
</projectDescription>
*/});
function _TEXT(wrap) {
return wrap.toString().match(/\/\*s*([\s\S]*)\s*\*\//)[1];
}
alert(RES_CODE);
alert(RES_POEM);
alert(RES_XML);
這段程式碼裡完全沒有跳脫字元,雙引號單引號都照原樣寫,C++ 的 <<、XML 的角括號也直接放著,可讀性跟看原始檔案沒兩樣。
註解裡不能出現 */。這是硬性限制,一旦內容本身含有這個序列就會提前結束,正則也擷取不到完整內容。
壓縮工具會把註解清掉。這是最致命的問題。UglifyJS、terser 這類工具預設就會剝除註解,你的資料會在打包後整批消失,必須手動設定排除——而這麼做等於放棄壓縮,得失很難算。
Chrome 裡每行前的 Tab 會被去掉。如果只是放程式碼還無妨,但對格式敏感的內容(例如需要保留縮進的模板)就得留意。
這些限制合起來說明了一件事:這技巧在 ES6 之前確實是個聰明的權宜之計,但今天已經有更正规的工具。
模板字符串(template literals)才是現在的答案:
const RES_CODE = `
#include <iostream>
int main()
{
std::cout << "Hello world" << std::endl;
return 0;
}
`;
const RES_POEM = `
更吹落、星如雨。
寶馬雕車香滿路。
`.trim();
反引號允許跨行,不需要串接符號,不需要跳脫雙引號,而且 ${} 還能插入變數。壓縮工具也认得它,不會當成註解丟掉。
而如果資料量大到需要認真管理,正確做法是把內容抽到獨立的檔案:純文字用 fetch() 載入,HTML 片段用 <template> 標籤存放,或者交給打包工具的 loader(如 webpack 的 raw-loader)處理。把大量資料塞進程式碼裡,無論用哪種技巧,都只是延後問題而非解決問題。