编写javascript模板引擎的几个步骤

catpl
catpl

先推荐一个我自己写的模板引擎catpl,项目地址:https://github.com/liyu365/catpl
项目中有详细的注释,代码易读,本项目借鉴自artTemplate、juicer、laytpl等诸多项目,在学习这些项目的过程中编写而成,并遵守以下几个步骤,可以对照此项目代码进行了解。

下面就是总结的编写javascript模板引擎的几个步骤

例如一个模板为:

<h2><%= title %></h2>
<ul>
<% for(var i = 0 ; i < sports.length ; i++ ) { %>
    <li><% i + 1 %> - <% sports[i].name %></li>
<% } %>
</ul>

最终会编译成为一个函数:

function anonymous($data, $methods) {
    var title = $data.title, sports = $data.sports, $escape = $methods.$escape;
    var $out = '';
    $out += '<h2>';
    $out += $escape(title);
    $out += '</h2><ul>';
    for(var i = 0 ; i < sports.length ; i++ ) {
        $out += '<li>';
        $out += $escape(i + 1);
        $out += ' - ';
        $out += $escape(sports[i].name);
        $out += '</li>';
    }
    $out += '</ul>';
    return $out;
}

可以观察到模板中的所有的变量名都被指定成了参数$data对象的属性,并且该函数自始至终只做了一件事,就是构建$out字符串,并将其返回。下面来梳理一下将模板编译为函数的过程:

步骤1. 确立模板中逻辑表达式的openTag和closeTag

在上面的例子中<%%>就是openTag和closeTag。

任何的HTML模板都包括两个部分:

  • HTML语句
  • 逻辑表达式语句

openTag和closeTag的作用就是划分出这两个部分区别对待。<%%>包裹着的为逻辑表达式语句,在其之外的是普通的HTML语句。

步骤2. 拆分"HTML语句"和"逻辑表达式语句"

methods.$foreach(source.split(options.openTag), function (code) {
    var arr = code.split(options.closeTag);
    if (arr.length === 1) {
        code_body += handle_html(arr[0]);
    } else {
        code_body += handle_logic(arr[0]);
        if (arr[1]) {
            code_body += handle_html(arr[1]);
        }
    }
});

可以看到这一步利用openTag和closeTag把模板源码中的HTML语句传给了handle_html()函数,把逻辑表达式语句传给了handle_logic()函数。这两个函数会把返回的代码拼接给一个统一的变量。

步骤3. 处理模板中的"HTML语句"

对应上面提到的handle_html()函数。

这一步很好理解,只要原样输出就好。

步骤4. 处理模板中的"逻辑表达式语句"

对应上面提到的handle_logic()函数,这一步的核心就是分析逻辑表达式语句中的变量名,函数名,识别的方式很简单,只要不是js中的关键字、保留字都视为是一个变量名。

逻辑表达式语句又分为两种:

1)赋值语句,形如<%= title %>

直接把title视为是一个变量名,在函数的开始处声明title为$data.title的引用。然后对title这个字符串原样输出。因为$data.title对应的值可能带有html中的特殊字符,所以在title外面包裹了$escape函数的调用。$escape函数是一个我们预先编写好的函数,存放在methods对象中,然后传和data一样传入到编译函数中。

  1. 逻辑控制语句,形如for(var i = 0 ; i < sports.length ; i++ ) {

依然要分析变量名,例如这里的sports,注意分析变量名时一定要忽略.length这样的对象属性。

步骤5.生成编译函数

利用Function构造函数生成一个函数:

var fun = new Function('$data', '$method', code);

这里的code当然就是handle_html()handle_logic()两个方法翻译后的标准js代码拼接而成的。
fun函数还需要进一步封装,毕竟$method还没有值。第四部已经提到,methods其实是我们模板引擎内部的对象,存放一些模板引擎的工具方法,我们应该自己把它传给编译好的函数。其实给模板引擎注册helper方法也是一样的,需要我们自己把helper对象传进编译函数。包装代码如下:

return function (data) {
    return fun(data, methods, helpers);
};

此时返回的函数就是用户实际拿到的函数。

步骤6.进一步优化"逻辑表达式语句"的语法

其实做到第五步已经是一个具备基本功能的模板引擎了,但是模板中逻辑表达式不够简洁,例如:

<% for(var i = 0 ; i < sports.length ; i++ ) { %>

这种表达式其实还是原生的js语法,我们可以自己定义模板引擎的语法,例如:

<% foreach sports %>

这其实不难做到,只是在第四部开始之前利用正则把foreach sports再变为for(var i = 0 ; i < sports.length ; i++ ) {,之后还是一样的流程。

catpl项目中有一个options.syntax_hook方法就是用来定义自己的模板语法的,可以将options.syntax_hook的值设为null来在自定义语法和原生js语法之间切换。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容