absurdjs 作者寫的一篇教程，一步步教你怎樣用 javascript 實作一個純用戶端的模闆引擎。整個引擎實作隻有不到 20 行代碼。如果你能從頭看到尾的話，還能有不少收獲的。你甚至可以跟随大牛的腳步也自己動手寫一個引擎。以下是全文。
不知道你有木有聽說過一個基于javascript的web頁面預處理器，叫做absurdjs。我是它的作者，目前我還在不斷地完善它。最初我隻是打算寫一個css的預處理器，不過後來擴充到了css和html，可以用來把javascript代碼轉成css和html代碼。當然，由于可以生成html代碼，你也可以把它當成一個模闆引擎，用于在标記語言中填充資料。
于是我又想着能不能寫一些簡單的代碼來完善這個模闆引擎，又能與其它現有的邏輯協同工作。absurdjs本身主要是以nodejs的子產品的形式釋出的，不過它也會釋出用戶端版本。考慮到這些，我就不能直接使用現有的引擎了，因為它們大部分都是在nodejs上運作的，而不能跑在浏覽器上。我需要的是一個小巧的，純粹以javascript編寫的東西，能夠直接運作在浏覽器上。當我某天偶然發現john
resig的這篇部落格，我驚喜地發現，這不正是我苦苦尋找的東西嘛!我稍稍做了一些修改，代碼行數差不多20行左右。其中的邏輯非常有意思。在這篇文章中我會一步一步重制編寫這個引擎的過程，如果你能一路看下去的話，你就會明白john的這個想法是多麼犀利!
最初我的想法是這樣子的：
var templateengine = function(tpl, data) {
// magic here ...
}
var template = '<p>hello, my name is <%name%>. i\'m <%age%> years old.</p>';
console.log(templateengine(template, {
name: "krasimir",
age: 29
}));
一個簡單的函數，輸入是我們的模闆以及資料對象，輸出麼估計你也很容易想到，像下面這樣子：
<p>hello, my name is krasimir. i'm 29 years old.</p>
其中第一步要做的是尋找裡面的模闆參數，然後替換成傳給引擎的具體資料。我決定使用正規表達式來完成這一步。不過我不是最擅長這個，是以寫的不好的話歡迎随時來噴。
var re = /<%([^%>]+)?%>/g;
這句正規表達式會捕獲所有以<%開頭，以%>結尾的片段。末尾的參數g(global)表示不隻比對一個，而是比對所有符合的片段。javascript裡面有很多種使用正規表達式的方法，我們需要的是根據正規表達式輸出一個數組，包含所有的字元串，這正是exec所做的。
var match = re.exec(tpl);
如果我們用console.log把變量match列印出來，我們會看見：
[
"<%name%>",
" name ",
index: 21,
input:
"<p>hello, my name is <%name%>. i\'m <%age%> years old.</p>"
]
不過我們可以看見，傳回的數組僅僅包含第一個比對項。我們需要用while循環把上述邏輯包起來，這樣才能得到所有的比對項。
while(match = re.exec(tpl)) {
console.log(match);
}
如果把上面的代碼跑一遍，你就會看見<%name%> 和 <%age%>都被列印出來了。
下面，有意思的部分來了。識别出模闆中的比對項後，我們要把他們替換成傳遞給函數的實際資料。最簡單的辦法就是使用replace函數。我們可以像這樣來寫：
var re = /<%([^%>]+)?%>/g;
while(match = re.exec(tpl)) {
tpl = tpl.replace(match[0], data[match[1]])
}
return tpl;
好了，這樣就能跑了，但是還不夠好。這裡我們以data["property"]的方式使用了一個簡單對象來傳遞資料，但是實際情況下我們很可能需要更複雜的嵌套對象。是以我們稍微修改了一下data對象：
{
name: "krasimir tsonev",
profile: { age: 29 }
不過直接這樣子寫的話還不能跑，因為在模闆中使用<%profile.age%>的話，代碼會被替換成data[‘profile.age’]，結果是undefined。這樣我們就不能簡單地用replace函數，而是要用别的方法。如果能夠在<%和%>之間直接使用javascript代碼就最好了，這樣就能對傳入的資料直接求值，像下面這樣：
var template = '<p>hello, my name is <%this.name%>. i\'m <%this.profile.age%> years old.</p>';
你可能會好奇，這是怎麼實作的?這裡john使用了new function的文法，根據字元串建立一個函數。我們不妨來看個例子：
var fn = new function("arg", "console.log(arg + 1);");
fn(2); // outputs 3
fn可是一個貨真價實的函數。它接受一個參數，函數體是console.log(arg + 1);。上述代碼等價于下面的代碼：
var fn = function(arg) {
console.log(arg + 1);
通過這種方法，我們可以根據字元串構造函數，包括它的參數和函數體。這不正是我們想要的嘛!不過先别急，在構造函數之前，我們先來看看函數體是什麼樣子的。按照之前的想法，這個模闆引擎最終傳回的應該是一個編譯好的模闆。還是用之前的模闆字元串作為例子，那麼傳回的内容應該類似于：
return
"<p>hello, my name is " +
this.name +
". i\'m " +
this.profile.age +
" years old.</p>";
當然啦，實際的模闆引擎中，我們會把模闆切分為小段的文本和有意義的javascript代碼。前面你可能看見我使用簡單的字元串拼接來達到想要的效果，不過這并不是100%符合我們要求的做法。由于使用者很可能會傳遞更加複雜的javascript代碼，是以我們這兒需要再來一個循環，如下：
var template =
'my skills:' +
'<%for(var index in this.skills) {%>' +
'<a href=""><%this.skills[index]%></a>' +
'<%}%>';
如果使用字元串拼接的話，代碼就應該是下面的樣子：
for(var index in this.skills) { +
'<a href="">' +
this.skills[index] +
'</a>' +
當然，這個代碼不能直接跑，跑了會出錯。于是我用了john的文章裡寫的邏輯，把所有的字元串放在一個數組裡，在程式的最後把它們拼接起來。
var r = [];
r.push('my skills:');
for(var index in this.skills) {
r.push('<a href="">');
r.push(this.skills[index]);
r.push('</a>');
return r.join('');
下一步就是收集模闆裡面不同的代碼行，用于生成函數。通過前面介紹的方法，我們可以知道模闆中有哪些占位符(譯者注：或者說正規表達式的比對項)以及它們的位置。是以，依靠一個輔助變量(cursor，遊标)，我們就能得到想要的結果。
var re = /<%([^%>]+)?%>/g,
code = 'var r=[];\n',
cursor = 0;
var add = function(line) {
code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
add(tpl.slice(cursor, match.index));
add(match[1]);
cursor = match.index + match[0].length;
add(tpl.substr(cursor, tpl.length - cursor));
code += 'return r.join("");'; // <-- return the result
console.log(code);
name: "krasimir tsonev",
profile: { age: 29 }
上述代碼中的變量code儲存了函數體。開頭的部分定義了一個數組。遊标cursor告訴我們目前解析到了模闆中的哪個位置。我們需要依靠它來周遊整個模闆字元串。此外還有個函數add，它負責把解析出來的代碼行添加到變量code中去。有一個地方需要特别注意，那就是需要把code包含的雙引号字元進行轉義(escape)。否則生成的函數代碼會出錯。如果我們運作上面的代碼，我們會在控制台裡面看見如下的内容：
var r=[];
r.push("<p>hello, my name is ");
r.push("this.name");
r.push(". i'm ");
r.push("this.profile.age");
return r.join("");
等等，貌似不太對啊，this.name和this.profile.age不應該有引号啊，再來改改。
var add = function(line, js) {
js? code += 'r.push(' + line + ');\n' :
while(match = re.exec(tpl)) {
add(tpl.slice(cursor, match.index));
add(match[1], true); // <-- say that this is actually valid js
cursor = match.index + match[0].length;
占位符的内容和一個布爾值一起作為參數傳給add函數，用作區分。這樣就能生成我們想要的函數體了。
r.push(this.name);
r.push(this.profile.age);
return r.join("");
剩下來要做的就是建立函數并且執行它。是以，在模闆引擎的最後，把原本傳回模闆字元串的語句替換成如下的内容：
return new function(code.replace(/[\r\t\n]/g, '')).apply(data);
我們甚至不需要顯式地傳參數給這個函數。我們使用apply方法來調用它。它會自動設定函數執行的上下文。這就是為什麼我們能在函數裡面使用this.name。這裡this指向data對象。
模闆引擎接近完成了，不過還有一點，我們需要支援更多複雜的語句，比如條件判斷和循環。我們接着上面的例子繼續寫。
'<a href="#"><%this.skills[index]%></a>' +
'<%}%>';
skills: ["js", "html", "css"]
這裡會産生一個異常，uncaught syntaxerror: unexpected token for。如果我們調試一下，把code變量列印出來，我們就能發現問題所在。
r.push("my skills:");
r.push(for(var index in this.skills) {);
r.push("<a href=\"\">");
r.push(this.skills[index]);
r.push("</a>");
r.push(});
r.push("");
帶有for循環的那一行不應該被直接放到數組裡面，而是應該作為腳本的一部分直接運作。是以我們在把内容添加到code變量之前還要多做一個判斷。
var re = /<%([^%>]+)?%>/g,
reexp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,
code = 'var r=[];\n',
cursor = 0;
js? code += line.match(reexp) ? line + '\n' : 'r.push(' + line + ');\n' :
code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
這裡我們新增加了一個正規表達式。它會判斷代碼中是否包含if、for、else等等關鍵字。如果有的話就直接添加到腳本代碼中去，否則就添加到數組中去。運作結果如下：
r.push("<a href=\"#\">");
r.push("</a>");
當然，編譯出來的結果也是對的。
my skills:<a href="#">js</a><a href="#">html</a><a href="#">css</a>
最後一個改進可以使我們的模闆引擎更為強大。我們可以直接在模闆中使用複雜邏輯，例如：
'<%if(this.showskills) {%>' +
'<%}%>' +
'<%} else {%>' +
'<p>none</p>' +
skills: ["js", "html", "css"],
showskills: true
除了上面說的改進，我還對代碼本身做了些優化，最終版本如下：
var templateengine = function(html, options) {
var re = /<%([^%>]+)?%>/g, reexp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = 'var r=[];\n', cursor = 0;
var add = function(line, js) {
js? (code += line.match(reexp) ? line + '\n' : 'r.push(' + line + ');\n') :
(code += line != '' ? 'r.push("' + line.replace(/"/g, '\\"') + '");\n' : '');
return add;
while(match = re.exec(html)) {
add(html.slice(cursor, match.index))(match[1], true);
add(html.substr(cursor, html.length - cursor));
code += 'return r.join("");';
return new function(code.replace(/[\r\t\n]/g, '')).apply(options);
代碼比我預想的還要少，隻有區區15行!
作者：佚名
來源：51cto