推薦五款流行的JavaScript模板引擎及其工做原理

當你建立JavaScript應用時，你必然會用到JavaScript模板。當對HTML進行更新時，你可以使用模板來代替庫（如jQuery），使用模板能夠大大簡化你的代碼。該文將例舉當前較流行的一些模板庫。

1、前言

什麼是模板引擎，說的簡單點，就是一個字符串中有幾個變量待定。好比：
var tpl = 'Hei, my name is <%name%>, and I\'m <%age%> years old.';
經過模板引擎函數把數據塞進去，
 
var data = {
    "name": "Barret Lee",
    "age": "20"
};
 
var result = tplEngine(tpl, data);
//Hei, my name is Barret Lee, and I'm 20 years old.
那這玩意兒有什麼做用呢？其實他就是一個預處理器（preprocessor），搞php開發的童鞋對Smarty必然是十分熟悉，Smarty是一個php模板引擎，tpl中待處理的字符經過數據匹配而後輸出相應的html代碼，加之比較給力的緩存技術，其速度和易用性是很是給力的！JS Template也是同樣的，咱們的數據庫裏保存着數以千萬計的數據，而每一條數據都是經過同一種方式輸入，就拿上面的例子來講，咱們不可能在數據庫裏存幾千條"Hei, my name..."，而是隻保存對應的name和age，經過模板輸出結果。
 
JS模板引擎應該作哪些事情？看看下面一串代碼：
 
var tpl = '<% for(var i = 0; i < this.posts.length; i++) {' +
    'var post = posts[i]; %>' +
    '<% if(!post.expert){ %>' +
        '<span>post is null</span>' +
    '<% } else { %>' +
        '<a href="#"><% post.expert %> at <% post.time %></a>' +
    '<% } %>' +
'<% } %>';
一個基本的模板引擎至少能夠保證上面的代碼能夠正常解析。如送入的數據是：
 
var data = {
    "posts": [{
        "expert": "content 1",
        "time": "yesterday"
    },{
        "expert": "content 2",
        "time": "today"
    },{
        "expert": "content 3",
        "time": "tomorrow"
    },{
        "expert": "",
        "time": "eee"
    }]
};
 能夠輸出：
 
<a href="#">content 1 at yesterday</a>
<a href="#">content 2 at today</a>
<a href="#">content 3 at tomorrow</a>
<span>post is null</span>
先戳這個demo看看。
 
下面就具體說說這個模板引擎的原理是啥樣的。
 
 
 
2、JS模板引擎的實現原理
 
1.正則摳出要匹配的內容
 
針對這一串代碼，經過正則獲取內容
 
var tpl = 'Hei, my name is <%name%>, and I\'m <%age%> years old.';
var data = {
    "name": "Barret Lee",
    "age": "20"
};
 最簡單的方式就是經過replace函數了：
 
var result = tpl.replace(/<%([^%>]+)?%>/g, function(s0, s1){
    return data[s1];
});
 經過正則替換，咱們很輕鬆的拿到了result，你能夠去試一試，他正式咱們想要的結果。可是這裏又有了一個問題，改一下data和tpl，
 
var tpl = 'Hei, my name is <%name%>, and I\'m <%info.age%> years old.';
var data = {
    "name": "Barret Lee",
    "info": { age": "20"}
};
 再用上面的方式去獲取結果，呵呵，不行了吧~ 這裏data["info.age"]自己就是undefined，因此咱們須要換一種方式來處理這個問題，那就是將它轉換成真正的JS代碼。如：
 
return 'Hei, my name is ' + data.name + ', and I\'m ' + data.info.age' + ' years old.'
 可是接着又有一個問題來了，當咱們的代碼中出現for循環和if的時候，上面的轉換明顯是不起做用的，如：
 
var tpl = 'Posts: ' +
          '<% for(var i = 0; i < post.length; i++) {'+
            '<a href="#"><% post[i].expert %></a>' +
          '<% } %>'
 若是繼續採用上面的方式，獲得的結果即是：
 
return 'Posts: ' +
       for(var i = 0; i < post.length; i++) { +
         '<a href="#">' + post[i].exper + '</a>' +
       }
 這顯然不是咱們緣由看到的，稍微觀察一下上面的結構，若是能夠返回一個這樣的結果也挺不錯哦：
 
'Posts: '
for(var i = 0; i < post.length; i++) {
    '<a href="#">' + post[i].exper + '</a>'
}
 可是咱們須要獲得的是一個字符串，而不是上面這樣零散的片斷，所以能夠把這些東西裝入數組中。
 
2.裝入數組
 
var r = [];
r.push('Posts: ' );
r.push(for(var i = 0; i < post.length; i++) {);
r.push('<a href="#">');
r.push(post[i].exper);
r.push('</a>');
r.push(});
 有人看到上面的代碼就要笑了，第三行和最後一行代碼的邏輯明顯是不正確的嘛，那腫麼辦呢？呵呵，很簡單，不放進去就好了唄，
 
var r = [];
r.push('Posts: ' );
for(var i = 0; i < post.length; i++) {
    r.push('<a href="#">');
    r.push(post[i].exper);
    r.push('</a>');
}
 這樣的邏輯就十分完善了，不存在太多的漏洞，可是這個轉化的過程是如何實現的？咱們必須仍是要寫一個解析的模板函數出來。
 
3.分辨js邏輯部分
 
var r = [];
tpl.replace(/<%([^%>]+)?%>/g, function(s0, s1){
    //完蛋了，這裏貌似又要回到上面那好笑的邏輯有錯誤的一步啦... 該怎麼處理比較好？
});
 完蛋了，這裏貌似又要回到上面那好笑的邏輯有錯誤的一步啦... 該怎麼處理比較好？咱們知道，JS給咱們提供了構造函數的「類」，
 
var fn = new Function("data",
    "var r = []; for(var i in data){ r.push(data[i]); } return r.join(' ')");
fn({"name": "barretlee", "age": "20"}); // barretlee 20
 知道了這個就好辦了，咱們能夠把邏輯部分和非邏輯部分的代碼連接成一個字符串，而後利用相似fn的函數直接編譯代碼。而/<%([^%>]+)?%>/g，這一個正則只能把邏輯部分匹配出來，要想把全部的代碼都組合到一塊兒，必須還得匹配非邏輯部分代碼。replace函數雖然很強大，他也能夠完成這個任務，可是實現的邏輯比較晦澀，因此咱們換另一種方式來處理。
 
先看一個簡單的例子：
 
var reg = /<%([^%>]+)?%>/g;
var tpl = 'Hei, my name is <%name%>, and I\'m <%age%> years old.';
var match = reg.exec(tpl);
console.log(match);
 看到的是：
 
[
    0: "<%name%>",
    1: name,
    index: 16,
    input: "Hei, my name is <%name%>, and I'm <%age%> years old."
    length: 2
]
 這。。。咱們但是想獲得全部的匹配啊，他居然只獲取了name而忽略了後面的age，好吧，對正則稍微熟悉點的童鞋必定會知道應該這樣處理：
 
var reg = /<%([^%>]+)?%>/g;
while(match = reg.exec(tpl)) {
    console.log(match);
}
 關於正則表達式的內容就不在這裏細說了，有興趣的同窗能夠多去了解下match,exec,search等正則的相關函數。這裏主要是靠match的index屬性來定位遍歷位置，而後利用while循環獲取全部的內容。
 
4.引擎函數
 
因此咱們的引擎函數雛形差很少就出來了：
 
var tplEngine = function(tpl, data){
    var reg = /<%([^%>]+)?%>/g,
            code = 'var r=[];\n',
            cursor = 0;  //主要的做用是定位代碼最後一截
    var add = function(line) {
        code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
    };
 
    while(match = reg.exec(tpl)) {
        add(tpl.slice(cursor, match.index)); //添加非邏輯部分
        add(match[1]);  //添加邏輯部分 match[0] = "<%" + match[1] + "%>";
        cursor = match.index + match[0].length;
    }
 
    add(tpl.substr(cursor, tpl.length - cursor)); //代碼的最後一截 如:" years old."
 
    code += 'return r.join("");'; // 返回結果，在這裏咱們就拿到了裝入數組後的代碼
    console.log(code);
 
    return tpl;
};
 這樣一來，測試一個小demo:
 
 var tpl = '<% for(var i = 0; i < this.posts.length; i++) {' +
        'var post = posts[i]; %>' +
        '<% if(!post.expert){ %>' +
            '<span>post is null</span>' +
        '<% } else { %>' +
            '<a href="#"><% post.expert %> at <% post.time %></a>' +
        '<% } %>' +
    '<% } %>';
tplEngine(tpl, data);
 返回的結果讓人很滿意：
 
var r=[]; r.push(""); r.push(" for(var i = 0; i < this.posts.length; i++) {var post = posts[i]; "); r.push(""); r.push(" if(!post.expert){ "); r.push("<span>post is null</span>"); r.push(" } else { "); r.push("<a href=\"#\">"); r.push(" post.expert "); r.push(" at "); r.push(" post.time "); r.push("</a>"); r.push(" } "); r.push(""); r.push(" } "); r.push(""); return r.join("");   不過咱們並須要for，if，switch等這些東西也push到r數組中去，因此呢，還得改善下上面的代碼，若是在line中發現了包含js邏輯的代碼，咱們就不該該讓他進門：   regOut = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g; var add = function(line, js) {     js? code += line.match(regOut) ? line + '\n' : 'r.push(' + line + ');\n' :         code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n'; };  因此咱們只剩下最後一步工做了，把data扔進去！   5.把data扔進去   沒有比完成這東西更簡單的事情啦，經過上面對Function這個函數的講解，你們應該也知道怎麼作了。   return new Function(code).apply(data);  使用apply的做用就是讓code中的一些變量做用域綁定到data上，否則做用域就會跑到global上，這樣獲得的數據索引就會出問題啦~ 固然咱們能夠再優化一下：   return new Function(code.replace(/[\r\t\n]/g, '')).apply(data);  把回車換行以及tab鍵都給匹配掉，讓代碼更加乾淨一點。那麼最終的代碼就是：   var tplEngine = function(tpl, data) {     var reg = /<%([^%>]+)?%>/g,          regOut = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,          code = 'var r=[];\n',          cursor = 0;       var add = function(line, js) {         js? (code += line.match(regOut) ? line + '\n' : 'r.push(' + line + ');\n') :             (code += line != '' ? 'r.push("' + line.replace(/"/g, '\\"') + '");\n' : '');         return add;     }     while(match = reg.exec(tpl)) {         add(tpl.slice(cursor, match.index))(match[1], true);         cursor = match.index + match[0].length;     }     add(tpl.substr(cursor, tpl.length - cursor));     code += 'return r.join("");';     return new Function(code.replace(/[\r\t\n]/g, '')).apply(data); };    

3、應用場景   畢竟是前端代碼，因此寫出來是要爲前端服務的，平時咱們處理的通常是一個html的模板，一般的狀況下，模板代碼是放在script標籤或者textarea中，因此首先是要獲取到這裏頭的東西，而後再來作解析。  

var barretTpl = function(str, data) {       //獲取元素    

var element = document.getElementById(str);     if (element) {         //textarea或input則取value，其它狀況取innerHTML        

var html = /^(textarea|input)$/i.test(element.nodeName) ? element.value : element.innerHTML;         return tplEngine(html, data);     } else {         //是模板字符串，則生成一個函數         //若是直接傳入字符串做爲模板，則可能變化過多，所以不考慮緩存         return tplEngine(str, data);     }    

var tplEngine = function(tpl, data) {         // content above     }; };     這樣一來就更加簡單了，使用方式就是 barretTpl(str, data)， 這裏的str能夠是模板代碼，也能夠是一個DOM元素的id~ 能夠看看這兩段代碼：https://gist.github.com/barretlee/7765698, https://gist.github.com/barretlee/7765587   也能夠直接戳這個demo。      

4、優化以及功能拓展   總共就三四十行代碼，完成的東西確定是一個簡潔版的，不過對於一個簡單的頁面而言，這幾行代碼已經足夠使用了，若是還想對他作優化，能夠從這幾個方面考慮：   優化獲取的模板代碼，好比去掉行尾空格等 符號轉義，若是咱們想輸出<span>hehe</span>相似這樣的源代碼，在push以前必須進行轉義 代碼緩存，若是一個模板會常用，能夠將它用一個數組緩存在barretTpl閉包內 用戶本身設置分隔符。

最後推薦模板看轉帖。