DIV CSS 佈局教程網

JavaScript 字符串模板引擎:用佔位符快速生成文案
編輯:關於JavaScript     

前端常有大量「把資料填進固定文案」的需求:信件通知、提示訊息、HTML 片段。用字串相加寫久了程式碼會很難讀,改成模板佔位符後可讀性立刻改善。作者參考 Prism.js 的解析思路,寫了一個極輕量的 StringTemplate 類,核心邏輯只有一個 while 迴圈。

模板引擎類

/* class */StringTemplate = function ( /* Optional {patt: RegExp, clPatt: RegExp} */ pattern) {
  if (!!pattern) {
    this.patt   = pattern.patt;     // 比對佔位符的規則
    this.clPatt = pattern.clPatt;   // 去除佔位符外殼的規則
  } else {
    this.patt   = /%\{\s*[\w\-]+\s*\}/g;   // 預設佔位符形如 %{userName}
    this.clPatt = /(^%\{\s*)|(\s*\}$)/g;
  }

  this.format = function(val, map) {
    var ls = [];
    var res;
    var prevEnd = 0;

    // 逐一找出佔位符,把「一般文字」與「對應的值」交替推進陣列
    while ((res = this.patt.exec(val)) != null) {
      var va = res[0];
      var start = val.substr(prevEnd, res.index - prevEnd);
      prevEnd = res.index + va.length;
      ls.push(start);

      var vac = va.replace(this.clPatt, "");   // 取出佔位符內的鍵名
      ls.push(map[vac]);
    }

    ls.push(val.substr(prevEnd, val.length));
    return ls.join("");
  };
};

使用方式

var str = new StringTemplate().format(
  "你好 %{userName}, 歡迎再次登陸 %{systemName}",
  { userName: "小明", systemName: "jb51" }
);
// str === "你好 小明, 歡迎再次登陸 jb51"

它聰明在哪裡

1. 用 exec 搭配 lastIndex 前進,一次遍歷完成。不需要 split、不需要多次 replace,時間複雜度就是 O(n)。

2. 佔位符規則可替換。建構時傳入自訂的 patt 與 clPatt,就能改成 {{name}}、${name} 等風格,適配不同專案的既有約定。

3. 普通文字與佔位符交替收集後一次 join。相比字串累加,這種寫法在大量拼接時更省記憶體配置。

可以再強化的方向

1. 支援表達式與過濾器。目前的版本只做鍵名替換。若要 %{user.name} 這種點號取值,或 %{date|format} 這種格式化,需要在取出鍵名後加一層解析。

2. 找不到鍵時要有兜底。現在 map[vac] 若為 undefined,會直接拼出 "undefined" 字串,實務上建議改成回傳空字串或保留原佔位符,方便排查漏傳的欄位。

3. 要注意 XSS。若模板輸出到 innerHTML,且資料來源含使用者輸入,務必先做 HTML 轉義,或改用 textContent 寫入。

4. 若專案已支援 ES6,直接用原生模板字符串 `你好 ${userName}` 就能取代大部分場景;這套自製版本的價值在於「模板內容來自外部(例如後端存的通知範本)」時,可以在執行期動態決定要填哪些鍵。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved