拼接 HTML 字符串這件事,寫的時候快,改的時候痛苦。本文記錄一次重構:把散落在 JS 裡的字符串拼接改成「HTML 模板 + JSON 數據」的渲染方式,讓結構和邏輯各歸其位。
當時在做一個基於 Tab 頁的訂單中心,每切換一個 Tab 就請求對應狀態的訂單列表。按照以前的習慣,我會這樣寫:
var html = '';
html += '<div class="empty-list">' +
'<div class="icon icon-box"></div>' +
'<div>還沒有訂單</div>' +
'</div>';
內容少的時候還能忍,一旦結構嵌套三四層、字段有十幾個,這種寫法就變成噩夢:可讀性差、改一處要數清楚加號和引號、設計稿調整時幾乎無法複用。既然後端有模板引擎,前端為什麼不能有?搜了一下,還真有成熟方案。
把模板寫進隐藏的 textarea 裡,用 $變量名$ 的形式標記佔位符,並用注釋把可循環的片段框起來:
<textarea class="js-order-tmp" style="display:none;">
<!--goods-block-->
<div class="block m-s-order">
<div class="block-item block-news">
<a href="<?php echo site_url('order/detail/'. '$id$')?>" class="dis-block external">
<div class="item-img"><img src="$thumb$"/></div>
<div class="item-intro">
<div class="sub-l">
<p class="t-order-num">訂單號:$order_num$</p>
<p class="t-name">收件人:$cus_name$</p>
<p class="t-date">$create_time$</p>
</div>
<div class="sub-r">
<p class="t-expand"><span class="icon icon-right"></span></p>
<p class="t-flag">$flag_name$</p>
</div>
</div>
<div class="clear"></div>
</a>
</div>
</div>
<!--/goods-block-->
</textarea>
<textarea class="js-no-order-tmp" style="display:none;">
<!-- no order -->
<div class="empty-list">
<div class="icon icon-box"></div>
<div>還沒有訂單</div>
</div>
<!-- /no order -->
</textarea>
用 textarea 而不是 script type="text/template",好處是內容不會被瀏覽器當作 HTML 解析,也不會閃現;缺點是裡面不能出現 </textarea> 這種字符串。
直接擴展 String 原型,保證全局可用:
String.prototype.temp = function (obj) {
return this.replace(/\$\w+\$/gi, function (matchs) {
var returns = obj[matchs.replace(/\$/g, '')];
return (returns + '') === 'undefined' ? '' : returns;
});
};
核心就是一次正則替換:匹配 $xxx$,取出中間的鍵名去數據對象裡查值。查不到就返回空字符串,避免頁面上出現「undefined」。
{
"ecd": 0,
"msg": "成功",
"result": [{
"id": "32",
"order_num": "test-001",
"thumb": "https://example.com/a.jpg",
"price": "0.11",
"cus_name": "test",
"cus_tel": "10086",
"cus_address": "北京 北京海澱區",
"create_time": "20160329115544",
"flag_name": "訂單已取消"
}],
"locate": ""
}
$.progress_show('正在努力加載中');
$.ajax({
url: site_url + 'api/order/getAll/' + status,
type: 'get',
dataType: 'json',
error: doAjax.error,
success: function (response) {
$.progress_hide();
if (response.ecd != '0') return $.alert(response.msg);
var htmlList = '';
var htmlTemp = $('textarea.js-order-tmp').val();
if (typeof response.result === 'undefined') {
// 空數據走另一個模板
htmlList = $('textarea.js-no-order-tmp').val();
} else {
$.each(response.result, function (i, el) {
htmlList += htmlTemp.temp(el);
});
}
$('.js-status-' + status).empty().append(htmlList);
}
});
這樣一來,點擊 Tab 就能渲染出對應列表,而 JS 裡再沒有一行拼接 HTML 的字符串。
字符串模板的優點是零依賴、上手極快,適合中小型項目和快速疊代。但它有兩個必須正視的短板。
安全問題。模板直接輸出字符串,如果數據裡帶有 HTML,就會形成 XSS 風險。上面的 temp 方法應該在返回值時做一次轉義,或者約定所有插值都經過統一的安全處理。
能力有限。它只能做簡單的變量替換,條件判斷、循環嵌套、局部片段複用都還得靠手工框注釋正則處理,一旦模板複雜起來就會失控。
所以更推薦的選擇是成熟的模板庫,比如 Handlebars、Mustache 這類「logic-less」方案,或者直接在項目裡引入 Vue / React 的聲明式渲染。它們不僅支持條件與循環,默認還會做 HTML 轉義,安全性和可維護性都更好。本文的字符串模板思路可以看作理解這些工具原理的一塊敲門磚:模板的本質,就是把「數據」與「展示結構」解耦,而這件事在任何規模的項目裡都值得做。