导读：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 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);
}

假如把上面的代码跑一遍，你就会瞥见 和 都被打印出来了。

下面，有意思的部份来了。识别出模板中的婚配项后，我们要把他们替换成通报给函数的现实数据。最简朴的方法就是运用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 }
}

不过直接这模样写的话还不能跑，由于在模板中运用的话，代码会被替换成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行！

这篇文章中一切触及的源代码都可以在这里找到。

原文：Javascript template engine in just 20 lines
转载：伯乐在线 – njuyz