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

一点号启航之星6小时前

AbsurdJS 作者写的一篇教程,一步步教你怎样用 Javascript 实现一个纯客户端的模板引擎。整个引擎实现只有不到 20 行代码。如果你能从头看到尾的话,还能有不少收获的。你甚至可以跟随大牛的脚步也自己动手写一个引擎。以下是全文。不知道你有木有听说过一个基于Javascript的Web页面预处理器,叫做AbsurdJS。我是它的作者,目前我还在不断地完善它。最初我只是打算写一个CSS的预处理器,不过后来扩展到了CSS和HTML,可以用来把Javascript代码转成CSS和HTML代码。当然,由于可以生成HTML代码,你也可以把它当成一个模板引擎,用于在标记语言中填充数据。于是我又想着能不能写一些简单的代码来完善这个模板引擎,又能与其它现有的逻辑协同工作。AbsurdJS本身主要是以NodeJS的模块的形式发布的,不过它也会发布客户端版本。考虑到这些,我就不能直接使用现有的引擎了,因为它们大部分都是在NodeJS上运行的,而不能跑在浏览器上。我需要的是一个小巧的,纯粹以Javascript编写的东西,能够直接运行在浏览器上。当我某天偶然发现John Resig的这篇博客,我惊喜地发现,这不正是我苦苦寻找的东西嘛!我稍稍做了一些修改,代码行数差不多20行左右。其中的逻辑非常有意思。在这篇文章中我会一步一步重现编写这个引擎的过程,如果你能一路看下去的话,你就会明白John的这个想法是多么犀利!


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

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

var TemplateEngine = function(tpl, data) { // magic here ...}var template = &apos;<p>Hello, my name is <%name%>. I\&apos;m <%age%> years old.</p>&apos;;console.log(TemplateEngine(template, { name: "Krasimir", age: 29}));

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

<p>Hello, my name is Krasimir. I&apos;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\&apos;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 = &apos;<p>Hello, my name is <%this.name%>. I\&apos;m <%this.profile.age%> years old.</p>&apos;;

你可能会好奇,这是怎么实现的?这里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\&apos;m " +this.profile.age +" years old.</p>";

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

var template =&apos;My skills:&apos; +&apos;<%for(var index in this.skills) {%>&apos; +&apos;<a href=""><%this.skills[index]%></a>&apos; +&apos;<%}%>&apos;;

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

return&apos;My skills:&apos; +for(var index in this.skills) { +&apos;<a href="">&apos; +this.skills[index] +&apos;</a>&apos; +}

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

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

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

var TemplateEngine = function(tpl, data) { var re = /<%([^%>]+)?%>/g, code = &apos;var r=;\n&apos;, cursor = 0; var add = function(line) { code += &apos;r.push("&apos; + line.replace(/"/g, &apos;\\"&apos;) + &apos;");\n&apos;; } 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 += &apos;return r.join("");&apos;; // <-- return the result console.log(code); return tpl;}var template = &apos;<p>Hello, my name is <%this.name%>. I\&apos;m <%this.profile.age%> years old.</p>&apos;;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&apos;m ");r.push("this.profile.age");return r.join("");

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

var add = function(line, js) { js? code += &apos;r.push(&apos; + line + &apos;);\n&apos; : code += &apos;r.push("&apos; + line.replace(/"/g, &apos;\\"&apos;) + &apos;");\n&apos;;}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&apos;m ");r.push(this.profile.age);return r.join("");

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

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

我们甚至不需要显式地传参数给这个函数。我们使用apply方法来调用它。它会自动设定函数执行的上下文。这就是为什么我们能在函数里面使用this.name。这里this指向data对象。模板引擎接近完成了,不过还有一点,我们需要支持更多复杂的语句,比如条件判断和循环。我们接着上面的例子继续写。

var template =&apos;My skills:&apos; +&apos;<%for(var index in this.skills) {%>&apos; +&apos;<a href="#"><%this.skills[index]%></a>&apos; +&apos;<%}%>&apos;;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 = &apos;var r=;\n&apos;, cursor = 0;var add = function(line, js) { js? code += line.match(reExp) ? line + &apos;\n&apos; : &apos;r.push(&apos; + line + &apos;);\n&apos; : code += &apos;r.push("&apos; + line.replace(/"/g, &apos;\\"&apos;) + &apos;");\n&apos;;}

这里我们新增加了一个正则表达式。它会判断代码中是否包含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 =&apos;My skills:&apos; +&apos;<%if(this.showSkills) {%>&apos; + &apos;<%for(var index in this.skills) {%>&apos; + &apos;<a href="#"><%this.skills[index]%></a>&apos; + &apos;<%}%>&apos; +&apos;<%} else {%>&apos; + &apos;<p>none</p>&apos; +&apos;<%}%>&apos;;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 = &apos;var r=;\n&apos;, cursor = 0; var add = function(line, js) { js? (code += line.match(reExp) ? line + &apos;\n&apos; : &apos;r.push(&apos; + line + &apos;);\n&apos;) : (code += line != &apos;&apos; ? &apos;r.push("&apos; + line.replace(/"/g, &apos;\\"&apos;) + &apos;");\n&apos; : &apos;&apos;); 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 += &apos;return r.join("");&apos;; return new Function(code.replace(/[\r\t\n]/g, &apos;&apos;)).apply(options);}

代码比我预想的还要少,只有区区15行!这篇文章中所有涉及的源代码都可以在这里找到。

<END>

关注「启航IT精英汇」

看更多精彩

本文前端(javascript)相关术语:javascript是什么意思 javascript下载 javascript权威指南 javascript基础教程 javascript 正则表达式 javascript设计模式 javascript高级程序设计 精通javascript javascript教程

分页:12
转载请注明
本文标题:只有20行Javascript代码!手把手教你写一个页面模板引擎
本站链接:http://www.codesec.net/view/481761.html
分享请点击:


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 前端(javascript) | 评论(0) | 阅读(42)