DIV CSS 佈局教程網

JavaScript 模板引擎的基本實現原理剖析
編輯:JavaScript基礎知識     

模板把資料與呈現分離開來,讓畫面的邏輯與效果更容易維護。本文將借助 JavaScript 的 Function 物件,一步步打造一個極其簡易的模板轉化引擎。

模板簡介

模板通常是指嵌入了某種動態程式語言程式碼的文本,資料與模板透過某種形式結合,就能變化出不同的結果。模板通常用來定義顯示形式,讓資料呈現更豐富,也更易維護。下面是一個例子:

<ul>
<% for(var i in items){ %>
<li class='<%= items[i].status %>'><%= items[i].text %></li>
<% } %>
</ul>

如果有如下 items 資料:

items: [
  { text: 'text1', status: 'done' },
  { text: 'text2', status: 'pending' },
  { text: 'text3', status: 'pending' },
  { text: 'text4', status: 'processing' }
]

透過某種方式結合,就能產生下面的 HTML:

<ul>
<li class='done'>text1</li>
<li class='pending'>text2</li>
<li class='pending'>text3</li>
<li class='processing'>text4</li>
</ul>

如果不使用模板,要達到同樣效果,就得這樣寫:

var temp = '<ul>';
for(var i in items){
  temp += "<li class='" + items[i].status + "'>" + items[i].text + "</li>";
}
temp += '</ul>';

由此可見,使用模板有以下好處:簡化了 HTML 的書寫;能透過迴圈、條件分支等程式元素,對資料呈現擁有更強的控制力;把資料與呈現分離,讓邏輯與效果更易維護。

模板引擎

分析模板、把資料與模板結合並輸出最終結果的程式,稱為模板引擎。模板有很多種,對應的引擎也有很多種。一種比較古老的模板稱為 ERB,被眾多 Web 框架採用,例如 ASP.NET、Rails 等,上面的例子就是 ERB 風格。ERB 有兩個核心概念:evaluate 與 interpolate。表面上,evaluate 指包含在 <% %> 中的部分,interpolate 指包含在 <%= %> 中的部分。從引擎角度看,evaluate 的內容不會直接輸出,通常用於流程控制;而 interpolate 的內容會直接輸出到結果中。

從實作上看,模板引擎通常依賴程式語言的動態編譯或動態解釋特性,以簡化實作並提升效能。例如 ASP.NET 利用 .NET 的動態編譯,把模板編譯成動態類別。而 JavaScript 因為有 Function,可以用極少的程式碼實作一個簡易的模板引擎。

模板文本轉化

仔細觀察模板寫法與非模板寫法,你會發現兩者十分「相似」,存在某種意義上的一一對應。如果能將模板文本變成程式碼執行,就能實現模板轉化。轉化過程有兩個原則:

  • 遇到普通文本,直接當作字串拼接
  • 遇到 interpolate(即 <%= %>),把其中內容當成變數拼接到字串中
  • 遇到 evaluate(即 <% %>),直接當成程式碼

依上述原則變換後,再包一個總函式:

var template = function(items){
  var temp = '';
  temp += '<ul>';
  for(var i in items){
    temp += "<li class='" + items[i].status + "'>" + items[i].text + "</li>";
  }
  temp += '</ul>';
}

最後執行這個函式、傳入資料即可:var result = template(items);

JavaScript 動態函式

轉化邏輯其實很簡單,關鍵在於:模板是不斷變化的,這意味著生成的程式碼必須在執行時動態產生並執行。好在 JavaScript 有 Function 這個強大特性。我們通常用 function 關鍵字宣告函式,而 function 其實是字面語法,執行時會被轉化成 Function 物件,因此 Function 提供了更底層、更靈活的機制。

var function_name = new Function(arg1, arg2, ..., argN, function_body)

例如:

var sayHi = new Function("sName", "sMessage", "alert(\"Hello \" + sName + sMessage);");
sayHi('Hello', 'World');

函式體和參數都能透過字串建立!有了這個特性,就能把模板文本轉化成函式體字串,動態建立並呼叫函式。

實現思路

首先用正則式描述 interpolate 和 evaluate,括號用於分組捕獲:

var interpolate_reg = /<%=([\s\S]+?)%>/g;
var evaluate_reg = /<%([\s\S]+?)%>/g;

為了對整個模板連續匹配,將兩者合併,但要注意所有能匹配 interpolate 的字串都能匹配 evaluate,所以 interpolate 需要更高的優先級:

var matcher = /<%=([\s\S]+?)%>|<%([\s\S]+?)%>/g

設計一個函式用於轉化模板,輸入參數為模板文本字串與資料物件,並用 replace 在匹配的過程中「構建」方法體:

var matcher = /<%=([\s\S]+?)%>|<%([\s\S]+?)%>/g
// text: 傳入的模板文本字串;data: 資料物件
var template = function(text, data){
  var index = 0;                 // 記錄當前掃描到哪裡了
  var function_body = "var temp = '';";
  function_body += "temp += '";
  text.replace(matcher, function(match, interpolate, evaluate, offset){
    function_body += text.slice(index, offset);
    if(evaluate){
      function_body += "';" + evaluate + "temp += '";
    }
    if(interpolate){
      function_body += "' + " + interpolate + " + '";
    }
    index = offset + match.length;
    return match;
  });
  function_body += "';return temp;";
}

此時 function_body 雖然是個字串,但內容實際上是一段函式程式碼,可以用它動態建立函式物件,並透過 data 參數呼叫:

var render = new Function('obj', function_body);
return render(data);

注意到方法的形式參數是 obj,所以模板內部引用的變數應該是 obj:

<script id='template' type='javascript/template'>
<ul>
<% for(var i in obj){ %>
<li class="<%= obj[i].status %>"><%= obj[i].text %></li>
<% } %>
</ul>
</script>

還有一個必須解決的問題:模板文本中可能包含 \r \n \u2028 \u2029 等字元,若直接出現在程式碼中會出錯,因此需要在拼接前把這些特殊字元轉義。此外,最後一個 evaluate 或 interpolate 之後的部分也需要拼接進來,只要改正則式加上行尾匹配 $ 即可。

var matcher = /<%=([\s\S]+?)%>|<%([\s\S]+?)%>|$/g;
// 模板文本中的特殊字元轉義處理
var escaper = /\\|'|\r|\n|\t|\u2028|\u2029/g;
var escapes = {
  "'": "'", '\\': '\\', '\r': 'r', '\n': 'n', '\t': 't',
  '\u2028': 'u2028', '\u2029': 'u2029'
};
// text: 傳入的模板文本字串;data: 資料物件
var template = function(text, data){
  var index = 0;
  var function_body = "var temp = '';";
  function_body += "temp += '";
  text.replace(matcher, function(match, interpolate, evaluate, offset){
    function_body += text.slice(index, offset).replace(escaper, function(match){
      return '\\' + escapes[match];
    });
    if(evaluate){
      function_body += "';" + evaluate + "temp += '";
    }
    if(interpolate){
      function_body += "' + " + interpolate + " + '";
    }
    index = offset + match.length;
    return match;
  });
  function_body += "';return temp;";
  var render = new Function('obj', function_body);
  return render(data);
}

可以看到,我們只用了很少的程式碼,就實現了一個簡易的模板引擎。

遺留的問題

  • 由於 <% 或 %> 都是模板的邊界字元,若模板需要輸出它們,就要設計轉義辦法
  • 若資料物件中包含 null,通常不希望輸出「null」,需在函式體中考慮 null 的情況
  • 每次都用 obj 形參引用資料可能不太方便,可在函式體加上 with(obj||{}){...},讓模板直接存取 obj 的屬性
  • 可以設計成返回 render 函式本身而非轉化結果,這樣外部能快取生成的函式以提升效能
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved