专栏名称: 前端大全
分享 Web 前端相关的技术文章、工具资源、精选课程、热点资讯
目录
相关文章推荐
前端早读课  ·  【早阅】Parcel v2.14.0 发布 ·  13 小时前  
云峰早点报  ·  3岁萌娃“拿捏”5位数以内加减法 ·  20 小时前  
云峰早点报  ·  3岁萌娃“拿捏”5位数以内加减法 ·  20 小时前  
前端大全  ·  历时 5 ... ·  2 天前  
前端早读课  ·  工作阶段性迷茫,怎么办 ·  昨天  
吉林市场监管  ·  3·15优化消费环境 市场监管在行动 ⑦|辉南县 ·  2 天前  
吉林市场监管  ·  3·15优化消费环境 市场监管在行动 ⑦|辉南县 ·  2 天前  
51好读  ›  专栏  ›  前端大全

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

前端大全  · 公众号  · 前端  · 2017-07-17 20:30

正文

(点击 上方公众号 ,可快速关注)


编译:伯乐在线/njuyz

http://web.jobbole.com/56689/

如有好文章投稿,请点击 → 这里了解详情


【伯乐在线导读】: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 = '

Hello, my name is name %> . I\'m age %> years old.

' ;

console . log ( TemplateEngine ( template , {

name : "Krasimir" ,

age : 29

}));


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


Hello, my name is Krasimir. I'm 29 years old.


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


var re = /]+)?%>/g;


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


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

var match = re . exec ( tpl );


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


[

" name %> " ,

" name " ,

index : 21 ,

input :

"

Hello, my name is name %> . I\'m age %> years old.

"

]


不过我们可以看见,返回的数组仅仅包含第一个匹配项。我们需要用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 = '

Hello, my name is this . name %> . I\'m this . profile . age %> years old.

' ;


你可能会好奇,这是怎么实现的?这里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

"

Hello, my name is "

+

this . name +

". I\'m " +

this . profile . age +

" years old.

" ;


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


var template =

'My skills:' +

' for ( var index in this . skills ) { %> ' +

' this . skills [ index ] %> ' +

' } %> ' ;


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


return

'My skills:' +

for ( var index in this . skills ) { +

' ' +

this . skills [ index ] +

'' +

}


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


var r = [];

r . push ( 'My skills:' );

for ( var index in this . skills ) {

r . push ( ' ' );

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

r . push ( '' );

}

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

console . log ( code );

return tpl ;

}

var template = '

Hello, my name is this . name %> . I\'m this . profile . age %> years old.

' ;

console . log ( TemplateEngine ( template , {

name : "Krasimir Tsonev" ,

profile : { age : 29 }

}));


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


var r = [];

r . push ( "

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 +







请到「今天看啥」查看全文