只有20行Javascript代码！手把手教你写一个页面模板引擎

不知道你有木有听说过一个基于Javascript的Web页面预处理器，叫做AbsurdJS。 我是它的作者，目前我还在不断地完善它。最初我只是打算写一个CSS的预处理器，不过后来扩展到了CSS和HTML，可以用来把Javascript代码 转成CSS和HTML代码。当然，由于可以生成HTML代码，你也可以把它当成一个模板引擎，用于在标记语言中填充数据。

于是我又想着能不能写一些简单的代码来完善这个模板引擎，又能与其它现有的逻辑协同工作。AbsurdJS本身主要是以NodeJS的模块的形式发 布的，不过它也会发布客户端版本。考虑到这些，我就不能直接使用现有的引擎了，因为它们大部分都是在NodeJS上运行的，而不能跑在浏览器上。我需要的 是一个小巧的，纯粹以Javascript编写的东西，能够直接运行在浏览器上。当我某天偶然发现John Resig的这篇博客，我惊喜地发现，这不正是我苦苦寻找的东西嘛！我稍稍做了一些修改，代码行数差不多20行左右。其中的逻辑非常有意思。在这篇文章中我会一步一步重现编写这个引擎的过程，如果你能一路看下去的话，你就会明白John的这个想法是多么犀利！

最初我的想法是这样子的：

1. varTemplateEngine=function(tpl,data){
2. //magichere...
3. }
4. vartemplate='<p>Hello,mynameis<%name%>.I\'m<%age%>yearsold.</p>';
5. console.log(TemplateEngine(template,{
6. name:"Krasimir",
7. age:29
8. }));

一个简单的函数，输入是我们的模板以及数据对象，输出么估计你也很容易想到，像下面这样子：

1. <p>Hello,mynameisKrasimir.I'm29yearsold.</p>

其中第一步要做的是寻找里面的模板参数，然后替换成传给引擎的具体数据。我决定使用正则表达式来完成这一步。不过我不是最擅长这个，所以写的不好的话欢迎随时来喷。

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

这句正则表达式会捕获所有以<%开头，以%>结尾的片段。末尾的参数g（global）表示不只匹配一个，而是匹配所有符合的片段。Javascript里面有很多种使用正则表达式的方法，我们需要的是根据正则表达式输出一个数组，包含所有的字符串，这正是exec所做的。

1. varre=/<%([^%>]+)?%>/g;
2. varmatch=re.exec(tpl);

如果我们用console.log把变量match打印出来，我们会看见：

1. [
2. "<%name%>",
3. "name",
4. index:21,
5. input:
6. "<p>Hello,mynameis<%name%>.I\'m<%age%>yearsold.</p>"
7. ]

不过我们可以看见，返回的数组仅仅包含第一个匹配项。我们需要用while循环把上述逻辑包起来，这样才能得到所有的匹配项。

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

如果把上面的代码跑一遍，你就会看见<%name%> 和 <%age%>都被打印出来了。

下面，有意思的部分来了。识别出模板中的匹配项后，我们要把他们替换成传递给函数的实际数据。最简单的办法就是使用replace函数。我们可以像这样来写：

1. varTemplateEngine=function(tpl,data){
2. varre=/<%([^%>]+)?%>/g;
3. while(match=re.exec(tpl)){
4. tpl=tpl.replace(match[0],data[match[1]])
5. }
6. returntpl;
7. }

好了，这样就能跑了，但是还不够好。这里我们以data["property"]的方式使用了一个简单对象来传递数据，但是实际情况下我们很可能需要更复杂的嵌套对象。所以我们稍微修改了一下data对象：

1. {
2. name:"KrasimirTsonev",
3. profile:{age:29}bUq0Nli>
4. }

不过直接这样子写的话还不能跑，因为在模板中使用<%profile.age%>的话，代码会被替换成data[‘profile.age’]，结果是undefined。这样我们就不能简单地用replace函数，而是要用别的方法。如果能够在<%和%>之间直接使用Javascript代码就最好了，这样就能对传入的数据直接求值，像下面这样：

1. vartemplate='<p>Hello,mynameis<%this.name%>.I\'m<%this.profile.age%>yearsold.</p>';

你可能会好奇，这是怎么实现的？这里John使用了new Function的语法，根据字符串创建一个函数。我们不妨来看个例子：

1. varfn=newFunction("arg","console.log(arg+1);");
2. fn(2);//outputs3

fn可是一个货真价实的函数。它接受一个参数，函数体是console.log(arg + 1);。上述代码等价于下面的代码：

1. varfn=function(arg){
2. console.log(arg+1);
3. }
4. fn(2);//outputs3

通过这种方法，我们可以根据字符串构造函数，包括它的参数和函数体。这不正是我们想要的嘛！不过先别急，在构造函数之前，我们先来看看函数体是什么样子 的。按照之前的想法，这个模板引擎最终返回的应该是一个编译好的模板。还是用之前的模板字符串作为例子，那么返回的内容应该类似于：

1. return
2. "<p>Hello,mynameis"+
3. this.name+
4. ".I\'m"+
5. this.profile.age+
6. "yearsold.</p>";

当然啦，实际的模板引擎中，我们会把模板切分为小段的文本和有意义的Javascript代码。前面你可能看见我使用简单的字符串拼接来达到想要的效果， 不过这并不是100%符合我们要求的做法。由于使用者很可能会传递更加复杂的Javascript代码，所以我们这儿需要再来一个循环，如下：

1. vartemplate=
2. 'Myskills:'+
3. '<%for(varindexinthis.skills){%>'+
4. '<ahref=""><%this.skills[index]%></a>'+
5. '<%}%>';

如果使用字符串拼接的话，代码就应该是下面的样子：

1. return
2. 'Myskills:'+
3. for(varindexinthis.skills){+
4. '<ahref="">'+
5. this.skills[index]+
6. '</a>'+
7. }

当然，这个代码不能直接跑，跑了会出错。于是我用了John的文章里写的逻辑，把所有的字符串放在一个数组里，在程序的最后把它们拼接起来。

1. varr=[];
2. r.push('Myskills:');
3. for(varindexinthis.skills){
4. r.push('<ahref="">');jbl2cpan>
5. r.push(this.skills[index]);
6. r.push('</a>');
7. }
8. returnr.join('');

下一步就是收集模板里面不同的代码行，用于生成函数。通过前面介绍的方法，我们可以知道模板中有哪些占位符（译者注：或者说正则表达式的匹配项）以及它们的位置。所以，依靠一个辅助变量（cursor，游标），我们就能得到想要的结果。

1. varTemplateEngine=function(tpl,data){
2. varre=/<%([^%>]+)?%>/g,
3. code='varr=[];\n',
4. cursor=0;
5. varadd=function(line){
6. code+='r.push("'+line.replace(/"/g,'\\"')+'");\n';
7. }
8. while(match=re.exec(tpl)){
9. add(tpl.slice(cursor,match.index));
10. add(match[1]);
11. cursor=match.index+match[0].length;
12. }
13. add(tpl.substr(cursor,tpl.length-cursor));
14. code+='returnr.join("");';//<--returntheresult
15. console.log(code);
16. returntpl;
17. }
18. vartemplate='<p>Hello,mynameis<%this.name%>.I\'m<%this.profile.age%>yearsold.</p>';
19. console.log(TemplateEngine(template,{
20. name:"KrasimirTsonev",
21. profile:{age:29}
22. }));

上述代码中的变量code保存了函数体。开头的部分定义了一个数组。游标cursor告诉我们当前解析到了模板中的哪个位置。我们需要依靠它来遍历整个模板字符串。此外还有个函数add，它负责把解析出来的代码行添加到变量code中去。有一个地方需要特别注意，那就是需要把code包含的双引号字符进行转义（escape）。否则生成的函数代码会出错。如果我们运行上面的代码，我们会在控制台里面看见如下的内容：

1. varr=[];
2. r.push("<p>Hello,mynameis");
3. r.push("this.name");
4. r.push(".I'm");
5. r.push("this.profile.age");
6. returnr.join("");

等等，貌似不太对啊，this.name和this.profile.age不应该有引号啊，再来改改。

1. varadd=function(line,js){
2. js?code+='r.push('+line+');\n':
3. code+='r.push("'+line.replace(/"/g,'\\"')+'");\n';
4. }
5. while(match=re.exec(tpl)){
6. add(tpl.slice(cursor,match.index));
7. 76DC5s="alt">add(match[1],true);//<--saythatthisisactuallyvalidjs
8. cursor=match.index+match[0].length;
9. }

占位符的内容和一个布尔值一起作为参数传给add函数，用作区分。这样就能生成我们想要的函数体了。

1. varr=[];
2. r.push("<p>Hello,mynameis");
3. r.push(this.name);
4. r.push(".I'm");
5. r.push(this.profile.age);
6. returnr.join("");

剩下来要做的就是创建函数并且执行它。因此，在模板引擎的最后，把原本返回模板字符串的语句替换成如下的内容：

1. returnnewFunction(code.replace(/[\r\t\n]/g,'')).apply(data);

我们甚至不需要显式地传参数给这个函数。我们使用apply方法来调用它。它会自动设定函数执行的上下文。这就是为什么我们能在函数里面使用this.name。这里this指向data对象。

模板引擎接近完成了，不过还有一点，我们需要支持更多复杂的语句，比如条件判断和循环。我们接着上面的例子继续写。

1. vartemplate=
2. 'Myskills:'+
3. '<%for(varindexinthis.skills){%>'+
4. '<ahref="#"><%this.skills[index]%></a>'+
5. '<%}%>';
6. console.log(TemplateEngine(template,{
7. skills:["js","html","css"]
8. }));

这里会产生一个异常，Uncaught SyntaxError: Unexpected token for。如果我们调试一下，把code变量打印出来，我们就能发现问题所在。

1. varr=[];
2. r.push("Myskills:");
3. r.push(for(varindexinthis.skills){);
4. r.push("<ahref=\"\">");
5. r.push(this.skills[index]);
6. r.push("</a>");
7. r.push(});
8. r.push("");
9. returnr.join("");

带有for循环的那一行不应该被直接放到数组里面，而是应该作为脚本的一部分直接运行。所以我们在把内容添加到code变量之前还要多做一个判断。

1. varre=/<%([^%>]+)?%>/g,
2. reExp=/(^()?(if|for|else|switch|case|break|{|}))(.*)?/g,
3. code='varr=[];\n',
4. cursor=0;
5. varadd=function(line,js){
6. js?code+=line.match(reExp)?line+'\n':'r.push('+line+');\n':
7. code+='r.push("'+line.replace(/"/g,'\\"')+'");\n';
8. }

这里我们新增加了一个正则表达式。它会判断代码中是否包含if、for、else等等关键字。如果有的话就直接添加到脚本代码中去，否则就添加到数组中去。运行结果如下：

1. varr=[];
2. r.push("Myskills:");
3. for(varindexinthis.skills){
4. r.push("<ahref=\"#\">");
5. r.push(this.skills[index]);
6. r.push("</a>");
7. }
8. r.push("");
9. returnr.join("");

当然，编译出来的结果也是对的。

1. Myskills:<ahref="#">js</a><ahref="#">html</a><ahref="#">css</a>

最后一个改进可以使我们的模板引擎更为强大。我们可以直接在模板中使用复杂逻辑，例如：

1. vartemplate=
2. 'Myskills:'+
3. '<%if(this.showSkills){%>'+
4. '<%for(varindexinthis.skills){%>'+
5. '<ahref="#"><%this.skills[index]%></a>'+
6. '<%}%>'+
7. '<%}else{%>'+
8. '<p>none</p>'+
9. '<%}%>';
10. console.log(TemplateEngine(template,{
11. skills:["js","html","css"],
12. showSkills:true
13. }));

除了上面说的改进，我还对代码本身做了些优化，最终版本如下：

1. varTemplateEngine=function(html,options){
2. varre=/<%([^%>]+)?%>/g,reExp=/(^()?(if|for|else|switch|case|break|{|}))(.*)?/g,code='varr=[];\n',cursor=0;
3. varadd=function(line,js){
4. js?(code+=line.match(reExp)?line+'\n':'r.push('+line+');\n'):
5. (code+=line!=''?'r.push("'+line.replace(/"/g,'\\"')+'");\n':'');
6. returnadd;
7. }
8. while(match=re.exec(html)){
9. add(html.slice(cursor,match.index))(match[1],true);
10. cursor=match.index+match[0].length;
11. }
12. add(html.substr(cursor,html.length-cursor));
13. code+='returnr.join("");';
14. returnnewFunction(code.replace(/[\r\t\n]/g,'')).apply(options);
15. }

代码比我预想的还要少，只有区区15行！

这篇文章中所有涉及的源代码都可以在这里找到。

原文链接：http://tech.pro/tutorial/1743/javascript-template-engine-in-just-20-lines

译文链接：http://blog.jobbole.com/56689/

【编辑推荐】