只用20行Javascript代碼就寫出一個頁面模板引擎的大神是AbsurdJS的作者，下面是他分享的全文，轉需。

不知道你有木有聽說過一個基於Javascript的Web頁面預處理器，叫做AbsurdJS。我是它的作者，目前我還在不斷地完善它。最初我只是打算寫一個CSS的預處理器，不過後來擴展到了CSS和HTML，可以用來把Javascript代碼轉成CSS和HTML代碼。當然，由於可以生成HTML代碼，你也可以把它當成一個模板引擎，用於在標記語言中填充數據。

於是我又想著能不能寫一些簡單的代碼來完善這個模板引擎，又能與其它現有的邏輯協同工作。AbsurdJS本身主要是以NodeJS的模塊的形式發布的，不過它也會發布客戶端版本。考慮到這些，我就不能直接使用現有的引擎了，因為它們大部分都是在NodeJS上運行的，而不能跑在瀏覽器上。

我需要的是一個小巧的，純粹以Javascript編寫的東西，能夠直接運行在瀏覽器上。當我某天偶然發現John Resig的這篇博客，我驚喜地發現，這不正是我苦苦尋找的東西嘛!我稍稍做了一些修改，代碼行數差不多20行左右。其中的邏輯非常有意思。在這篇文章中我會一步一步重現編寫這個引擎的過程，如果你能一路看下去的話，你就會明白John的這個想法是多麽犀利!

最初我的想法是這樣子的：

1. var TemplateEngine = function(tpl, data) {

3. // magic here ...

5. }

7. var template = ‘<p>Hello, my name is <%name%>. I\‘m <%age%> years old.</p>‘;

9. console.log(TemplateEngine(template, {

11. name: "Krasimir",

13. age: 29

15. }));

一個簡單的函數，輸入是我們的模板以及數據對象，輸出麽估計你也很容易想到，像下面這樣子：

1. <p>Hello, my name is Krasimir. I‘m 29 years old.</p>

其中第一步要做的是尋找裏面的模板參數，然後替換成傳給引擎的具體數據。我決定使用正則表達式來完成這一步。不過我不是最擅長這個，所以寫的不好的話歡迎隨時來噴。

1. var re = /<%([^%>]+)?%>/g;

這句正則表達式會捕獲所有以<%開頭，以%>結尾的片段。末尾的參數g(global)表示不只匹配一個，而是匹配所有符合的片段。Javascript裏面有很多種使用正則表達式的方法，我們需要的是根據正則表達式輸出一個數組，包含所有的字符串，這正是exec所做的。

1. var re = /<%([^%>]+)?%>/g;

3. var match = re.exec(tpl);

如果我們用console.log把變量match打印出來，我們會看見：

1. [

3. "<%name%>",

5. " name ",

7. index: 21,

9. input:

11. "<p>Hello, my name is <%name%>. I\‘m <%age%> years old.</p>"

13. ]

不過我們可以看見，返回的數組僅僅包含第一個匹配項。我們需要用while循環把上述邏輯包起來，這樣才能得到所有的匹配項。

1. var re = /<%([^%>]+)?%>/g;

3. while(match = re.exec(tpl)) {

5. console.log(match);

7. }

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

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

1. var TemplateEngine = function(tpl, data) {

3. var re = /<%([^%>]+)?%>/g;

5. while(match = re.exec(tpl)) {

7. tpl = tpl.replace(match[0], data[match[1]])

9. }

11. return tpl;

13. }

好了，這樣就能跑了，但是還不夠好。這裏我們以data["property"]的方式使用了一個簡單對象來傳遞數據，但是實際情況下我們很可能需要更復雜的嵌套對象。所以我們稍微修改了一下data對象：

1. {

3. name: "Krasimir Tsonev",

5. profile: { age: 29 }

7. }

不過直接這樣子寫的話還不能跑，因為在模板中使用<%profile.age%>的話，代碼會被替換成data[‘profile.age’]，結果是undefined。這樣我們就不能簡單地用replace函數，而是要用別的方法。如果能夠在<%和%>之間直接使用Javascript代碼就最好了，這樣就能對傳入的數據直接求值，像下面這樣：

1. var template = ‘<p>Hello, my name is <%this.name%>. I\‘m <%this.profile.age%> years old.</p>‘;

你可能會好奇，這是怎麽實現的?這裏John使用了new Function的語法，根據字符串創建一個函數。我們不妨來看個例子：

1. var fn = new Function("arg", "console.log(arg + 1);");

3. fn(2); // outputs 3

fn可是一個貨真價實的函數。它接受一個參數，函數體是console.log(arg + 1);。上述代碼等價於下面的代碼：

1. var fn = function(arg) {

3. console.log(arg + 1);

5. }

7. fn(2); // outputs 3

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

1. return

3. "<p>Hello, my name is " +

5. this.name +

7. ". I\‘m " +

9. this.profile.age +

11. " years old.</p>";

當然啦，實際的模板引擎中，我們會把模板切分為小段的文本和有意義的Javascript代碼。前面你可能看見我使用簡單的字符串拼接來達到想要的效果，不過這並不是100%符合我們要求的做法。由於使用者很可能會傳遞更加復雜的Javascript代碼，所以我們這兒需要再來一個循環，如下：

1. var template =

3. ‘My skills:‘ +

5. ‘<%for(var index in this.skills) {%>‘ +

7. ‘<a href=""><%this.skills[index]%></a>‘ +

9. ‘<%}%>‘;

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

1. return

3. ‘My skills:‘ +

5. for(var index in this.skills) { +

7. ‘<a href="">‘ +

9. this.skills[index] +

11. ‘</a>‘ +

13. }

當然，這個代碼不能直接跑，跑了會出錯。於是我用了John的文章裏寫的邏輯，把所有的字符串放在一個數組裏，在程序的最後把它們拼接起來。

1. var r = [];

3. r.push(‘My skills:‘);

5. for(var index in this.skills) {

7. r.push(‘<a href="">‘);

9. r.push(this.skills[index]);

11. r.push(‘</a>‘);

13. }

15. return r.join(‘‘);

下一步就是收集模板裏面不同的代碼行，用於生成函數。通過前面介紹的方法，我們可以知道模板中有哪些占位符(譯者註：或者說正則表達式的匹配項)以及它們的位置。所以，依靠一個輔助變量(cursor，遊標)，我們就能得到想要的結果。

1. var TemplateEngine = function(tpl, data) {

3. var re = /<%([^%>]+)?%>/g,

5. code = ‘var r=[];\n‘,

7. cursor = 0;

9. var add = function(line) {

11. code += ‘r.push("‘ + line.replace(/"/g, ‘\\"‘) + ‘");\n‘;

13. }

15. while(match = re.exec(tpl)) {

17. add(tpl.slice(cursor, match.index));

19. add(match[1]);

21. cursor = match.index + match[0].length;

23. }

25. add(tpl.substr(cursor, tpl.length - cursor));

27. code += ‘return r.join("");‘; // <-- return the result

29. console.log(code);

31. return tpl;

33. }

35. var template = ‘<p>Hello, my name is <%this.name%>. I\‘m <%this.profile.age%> years old.</p>‘;

37. console.log(TemplateEngine(template, {

39. name: "Krasimir Tsonev",

41. profile: { age: 29 }

43. }));

上述代碼中的變量code保存了函數體。開頭的部分定義了一個數組。遊標cursor告訴我們當前解析到了模板中的哪個位置。我們需要依靠它來遍歷整個模板字符串。此外還有個函數add，它負責把解析出來的代碼行添加到變量code中去。有一個地方需要特別註意，那就是需要把code包含的雙引號字符進行轉義(escape)。否則生成的函數代碼會出錯。如果我們運行上面的代碼，我們會在控制臺裏面看見如下的內容：

1. var r=[];

3. r.push("<p>Hello, my name is ");

5. r.push("this.name");

7. r.push(". I‘m ");

9. r.push("this.profile.age");

11. return r.join("");

等等，貌似不太對啊，this.name和this.profile.age不應該有引號啊，再來改改。

1. var add = function(line, js) {

3. js? code += ‘r.push(‘ + line + ‘);\n‘ :

5. code += ‘r.push("‘ + line.replace(/"/g, ‘\\"‘) + ‘");\n‘;

7. }

9. while(match = re.exec(tpl)) {

11. add(tpl.slice(cursor, match.index));

13. add(match[1], true); // <-- say that this is actually valid js

15. cursor = match.index + match[0].length;

17. }

占位符的內容和一個布爾值一起作為參數傳給add函數，用作區分。這樣就能生成我們想要的函數體了。

1. var r=[];

3. r.push("<p>Hello, my name is ");

5. r.push(this.name);

7. r.push(". I‘m ");

9. r.push(this.profile.age);

11. return r.join("");

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

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

我們甚至不需要顯式地傳參數給這個函數。我們使用apply方法來調用它。它會自動設定函數執行的上下文。這就是為什麽我們能在函數裏面使用this.name。這裏this指向data對象。

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

1. var template =

3. ‘My skills:‘ +

5. ‘<%for(var index in this.skills) {%>‘ +

7. ‘<a href="#"><%this.skills[index]%></a>‘ +

9. ‘<%}%>‘;

11. console.log(TemplateEngine(template, {

13. skills: ["js", "html", "css"]

15. }));

這裏會產生一個異常，Uncaught SyntaxError: Unexpected token for。如果我們調試一下，把code變量打印出來，我們就能發現問題所在。

1. var r=[];

3. r.push("My skills:");

5. r.push(for(var index in this.skills) {);

7. r.push("<a href=\"\">");

9. r.push(this.skills[index]);

11. r.push("</a>");

13. r.push(});

15. r.push("");

17. return r.join("");

帶有for循環的那一行不應該被直接放到數組裏面，而是應該作為腳本的一部分直接運行。所以我們在把內容添加到code變量之前還要多做一個判斷。

1. var re = /<%([^%>]+)?%>/g,

3. reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,

5. code = ‘var r=[];\n‘,

7. cursor = 0;

9. var add = function(line, js) {

11. js? code += line.match(reExp) ? line + ‘\n‘ : ‘r.push(‘ + line + ‘);\n‘ :

13. code += ‘r.push("‘ + line.replace(/"/g, ‘\\"‘) + ‘");\n‘;

15. }

這裏我們新增加了一個正則表達式。它會判斷代碼中是否包含if、for、else等等關鍵字。如果有的話就直接添加到腳本代碼中去，否則就添加到數組中去。運行結果如下：

1. var r=[];

3. r.push("My skills:");

5. for(var index in this.skills) {

7. r.push("<a href=\"#\">");

9. r.push(this.skills[index]);

11. r.push("</a>");

13. }

15. r.push("");

17. return r.join("");

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

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

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

1. var template =

3. ‘My skills:‘ +

5. ‘<%if(this.showSkills) {%>‘ +

7. ‘<%for(var index in this.skills) {%>‘ +

9. ‘<a href="#"><%this.skills[index]%></a>‘ +

11. ‘<%}%>‘ +

13. ‘<%} else {%>‘ +

15. ‘<p>none</p>‘ +

17. ‘<%}%>‘;

19. console.log(TemplateEngine(template, {

21. skills: ["js", "html", "css"],

23. showSkills: true

25. }));

除了上面說的改進，我還對代碼本身做了些優化，最終版本如下：

1. var TemplateEngine = function(html, options) {

3. var re = /<%([^%>]+)?%>/g, reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = ‘var r=[];\n‘, cursor = 0;

5. var add = function(line, js) {

7. js? (code += line.match(reExp) ? line + ‘\n‘ : ‘r.push(‘ + line + ‘);\n‘) :

9. (code += line != ‘‘ ? ‘r.push("‘ + line.replace(/"/g, ‘\\"‘) + ‘");\n‘ : ‘‘);

11. return add;

13. }

15. while(match = re.exec(html)) {

17. add(html.slice(cursor, match.index))(match[1], true);

19. cursor = match.index + match[0].length;

21. }

23. add(html.substr(cursor, html.length - cursor));

25. code += ‘return r.join("");‘;

27. return new Function(code.replace(/[\r\t\n]/g, ‘‘)).apply(options);

29. }

代碼比我預想的還要少，只有區區15行!

學習提升web前端知識，入行升職加薪的選擇--知海匠庫互聯網學院：http://www.zhihaijiangku.com

大神手把手教你寫一個頁面模板引擎，只需20行Javascript代碼！