只有20行Javascript程式碼！手把手教你寫一個頁面模板引擎

　　不知道你有木有聽說過一個基於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 re = /<%([^%>]+)?%>/g;
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迴圈把上述邏輯包起來，這樣才能得到所有的匹配項。

var re = /<%([^%>]+)?%>/g;
while(match = re.exec(tpl)) {
    console.log(match);
}

　　如果把上面的程式碼跑一遍，你就會看見<%name%> 和 <%age%>都被列印出來了。

　　下面，有意思的部分來了。識別出模板中的匹配項後，我們要把他們替換成傳遞給函式的實際資料。最簡單的辦法就是使用replace函式。我們可以像這樣來寫：

var TemplateEngine = function(tpl, data) {
    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);
}
fn(2); // outputs 3

　　通過這種方法，我們可以根據字串建構函式，包括它的引數和函式體。這不正是我們想要的嘛！不過先別急，在建構函式之前，我們先來看看函式體是什麼樣子的。按照之前的想法，這個模板引擎最終返回的應該是一個編譯好的模板。還是用之前的模板字串作為例子，那麼返回的內容應該類似於：

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>' +
'<%}%>';

　　如果使用字串拼接的話，程式碼就應該是下面的樣子：

return
'My skills:' + 
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 TemplateEngine = function(tpl, data) {
    var re = /<%([^%>]+)?%>/g,
        code = 'var r=[];\n',
        cursor = 0;
    var add = function(line) {
        code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
    }
    while(match = re.exec(tpl)) {
        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);
    return tpl;
}
var template = '<p>Hello, my name is <%this.name%>. I\'m <%this.profile.age%> years old.</p>';
console.log(TemplateEngine(template, {
    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' :
        code += 'r.push("' + line.replace(/"/g, '\\"') + '");\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函式，用作區分。這樣就能生成我們想要的函式體了。

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("");

　　剩下來要做的就是建立函式並且執行它。因此，在模板引擎的最後，把原本返回模板字串的語句替換成如下的內容：

return new Function(code.replace(/[\r\t\n]/g, '')).apply(data);

　　我們甚至不需要顯式地傳引數給這個函式。我們使用apply方法來呼叫它。它會自動設定函式執行的上下文。這就是為什麼我們能在函式裡面使用this.name。這裡this指向data物件。

　　模板引擎接近完成了，不過還有一點，我們需要支援更多複雜的語句，比如條件判斷和迴圈。我們接著上面的例子繼續寫。

var template = 
'My skills:' + 
'<%for(var index in this.skills) {%>' + 
'<a href="#"><%this.skills[index]%></a>' +
'<%}%>';
console.log(TemplateEngine(template, {
    skills: ["js", "html", "css"]
}));

　　這裡會產生一個異常，Uncaught SyntaxError: Unexpected token for。如果我們除錯一下，把code變數列印出來，我們就能發現問題所在。

var r=[];
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("");
return r.join("");

　　帶有for迴圈的那一行不應該被直接放到陣列裡面，而是應該作為指令碼的一部分直接執行。所以我們在把內容新增到code變數之前還要多做一個判斷。

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 += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
}

　　這裡我們新增加了一個正規表示式。它會判斷程式碼中是否包含if、for、else等等關鍵字。如果有的話就直接新增到指令碼程式碼中去，否則就新增到陣列中去。執行結果如下：

var r=[];
r.push("My skills:");
for(var index in this.skills) {
r.push("<a href=\"#\">");
r.push(this.skills[index]);
r.push("</a>");
}
r.push("");
return r.join("");

　　當然，編譯出來的結果也是對的。

My skills:<a href="#">js</a><a href="#">html</a><a href="#">css</a>

　　最後一個改進可以使我們的模板引擎更為強大。我們可以直接在模板中使用複雜邏輯，例如：

var template = 
'My skills:' + 
'<%if(this.showSkills) {%>' +
    '<%for(var index in this.skills) {%>' + 
    '<a href="#"><%this.skills[index]%></a>' +
    '<%}%>' +
'<%} else {%>' +
    '<p>none</p>' +
'<%}%>';
console.log(TemplateEngine(template, {
    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);
        cursor = match.index + match[0].length;
    }
    add(html.substr(cursor, html.length - cursor));
    code += 'return r.join("");';
    return new Function(code.replace(/[\r\t\n]/g, '')).apply(options);
}

　　程式碼比我預想的還要少，只有區區15行！

　　這篇文章中所有涉及的原始碼都可以在這裡找到。

　　原文連結： Tech.pro   翻譯： 伯樂線上 - njuyz