资讯专栏INFORMATION COLUMN

上云采购季！| 2核2G4M爆款云服务器低至59元/年，更有多台、长期优惠，快来选购！

立即前往
首页/文章专栏/js简单前端模板引擎实现

js简单前端模板引擎实现

asoren / 634人阅读

摘要：简单前端模板引擎实现本身主要是以的模块的形式发布的，不过它也会发布客户端版本。按照之前的想法，这个模板引擎最终返回的应该是一个编译好的模板。最后一个改进可以使我们的模板引擎更为强大。

简单前端模板引擎实现

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

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

JavaScript

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
}));

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
}));

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

XHTML

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


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

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

XHTML

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

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

JavaScript

var re = /<%([^%>]+)?%>/g;
var match = re.exec(tpl);
var re = /<%([^%>]+)?%>/g;
var match = re.exec(tpl);

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

JavaScript

[
    "<%name%>",
    " name ", 
    index: 21,
    input: 
    "
Hello, my name is <%name%>. I"m <%age%> years old.
"
]
[
    "<%name%>",
    " name ", 
    index: 21,
    input: 
    "
Hello, my name is <%name%>. I"m <%age%> years old.
"
]

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

JavaScript

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

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

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

JavaScript

var TemplateEngine = function(tpl, data) {
    var re = /<%([^%>]+)?%>/g;
    while(match = re.exec(tpl)) {
        tpl = tpl.replace(match[0], data[match[1]])
    }
    return tpl;
}

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对象：

JavaScript

{
    name: "Krasimir Tsonev",
    profile: { age: 29 }
}
{
    name: "Krasimir Tsonev",
    profile: { age: 29 }
}

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

JavaScript

var template = "
Hello, my name is <%this.name%>. I"m <%this.profile.age%> years old.
";
var template = "
Hello, my name is <%this.name%>. I"m <%this.profile.age%> years old.
";

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

JavaScript

var fn = new Function("arg", "console.log(arg + 1);");
fn(2); // outputs 3
var fn = new Function("arg", "console.log(arg + 1);");
fn(2); // outputs 3

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

JavaScript

var fn = function(arg) {
    console.log(arg + 1);
}
fn(2); // outputs 3
var fn = function(arg) {
    console.log(arg + 1);
}
fn(2); // outputs 3

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

JavaScript

return 
"
Hello, my name is " + 
this.name + 
". I"m " + 
this.profile.age + 
" years old.
";
return 
"
Hello, my name is " + 
this.name + 
". I"m " + 
this.profile.age + 
" years old.
";

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

JavaScript

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

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

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

JavaScript

return
"My skills:" + 
for(var index in this.skills) { +
"" + 
this.skills[index] +
"" +
}

return
"My skills:" + 
for(var index in this.skills) { +
"" + 
this.skills[index] +
"" +
}

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

JavaScript

var r = [];
r.push("My skills:"); 
for(var index in this.skills) {
r.push("");
r.push(this.skills[index]);
r.push("");
}
return r.join("");

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，游标），我们就能得到想要的结果。

JavaScript

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

var TemplateEngine = function(tpl, data) {
    var re = /<%([^%>]+)?%>/g,
        code = "var r=[];
",
        cursor = 0;
    var add = function(line) {
        code += "r.push("" + line.replace(/"/g, """) + "");
";
    }
    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 = "
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）。否则生成的函数代码会出错。如果我们运行上面的代码，我们会在控制台里面看见如下的内容：

JavaScript

var r=[];
r.push("
Hello, my name is ");
r.push("this.name");
r.push(". I"m ");
r.push("this.profile.age");
return r.join("");
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不应该有引号啊，再来改改。

JavaScript

var add = function(line, js) {
    js? code += "r.push(" + line + ");
" :
        code += "r.push("" + line.replace(/"/g, """) + "");
";
}
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;
}
var add = function(line, js) {
    js? code += "r.push(" + line + ");
" :
        code += "r.push("" + line.replace(/"/g, """) + "");
";
}
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函数，用作区分。这样就能生成我们想要的函数体了。

JavaScript

var r=[];
r.push("
Hello, my name is ");
r.push(this.name);
r.push(". I"m ");
r.push(this.profile.age);
return r.join("");
var r=[];
r.push("
Hello, my name is ");
r.push(this.name);
r.push(". I"m ");
r.push(this.profile.age);
return r.join("");

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

JavaScript

return new Function(code.replace(/[
	
]/g, "")).apply(data);
return new Function(code.replace(/[
	
]/g, "")).apply(data);

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

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

JavaScript

var template = 
"My skills:" + 
"<%for(var index in this.skills) {%>" + 
"<%this.skills[index]%>" +
"<%}%>";
console.log(TemplateEngine(template, {
    skills: ["js", "html", "css"]
}));
var template = 
"My skills:" + 
"<%for(var index in this.skills) {%>" + 
"<%this.skills[index]%>" +
"<%}%>";
console.log(TemplateEngine(template, {
    skills: ["js", "html", "css"]
}));

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

JavaScript

var r=[];
r.push("My skills:");
r.push(for(var index in this.skills) {);
r.push("");
r.push(this.skills[index]);
r.push("");
r.push(});
r.push("");
return r.join("");
var r=[];
r.push("My skills:");
r.push(for(var index in this.skills) {);
r.push("");
r.push(this.skills[index]);
r.push("");
r.push(});
r.push("");
return r.join("");

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

JavaScript

var re = /<%([^%>]+)?%>/g,
    reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,
    code = "var r=[];
",
    cursor = 0;
var add = function(line, js) {
    js? code += line.match(reExp) ? line + "
" : "r.push(" + line + ");
" :
        code += "r.push("" + line.replace(/"/g, """) + "");
";
}
var re = /<%([^%>]+)?%>/g,
    reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,
    code = "var r=[];
",
    cursor = 0;
var add = function(line, js) {
    js? code += line.match(reExp) ? line + "
" : "r.push(" + line + ");
" :
        code += "r.push("" + line.replace(/"/g, """) + "");
";
}

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

JavaScript

var r=[];
r.push("My skills:");
for(var index in this.skills) {
r.push("");
r.push(this.skills[index]);
r.push("");
}
r.push("");
return r.join("");
var r=[];
r.push("My skills:");
for(var index in this.skills) {
r.push("");
r.push(this.skills[index]);
r.push("");
}
r.push("");
return r.join("");

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

JavaScript

My skills:jshtmlcss
My skills:jshtmlcss

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

JavaScript

var template = 
"My skills:" + 
"<%if(this.showSkills) {%>" +
    "<%for(var index in this.skills) {%>" + 
    "<%this.skills[index]%>" +
    "<%}%>" +
"<%} else {%>" +
    "
none
" +
"<%}%>";
console.log(TemplateEngine(template, {
    skills: ["js", "html", "css"],
    showSkills: true
}));
var template = 
"My skills:" + 
"<%if(this.showSkills) {%>" +
    "<%for(var index in this.skills) {%>" + 
    "<%this.skills[index]%>" +
    "<%}%>" +
"<%} else {%>" +
    "
none
" +
"<%}%>";
console.log(TemplateEngine(template, {
    skills: ["js", "html", "css"],
    showSkills: true
}));

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

JavaScript

var TemplateEngine = function(html, options) {
    var re = /<%([^%>]+)?%>/g, reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = "var r=[];
", cursor = 0;
    var add = function(line, js) {
        js? (code += line.match(reExp) ? line + "
" : "r.push(" + line + ");
") :
            (code += line != "" ? "r.push("" + line.replace(/"/g, """) + "");
" : "");
        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(/[
	
]/g, "")).apply(options);
var TemplateEngine = function(html, options) {
    var re = /<%([^%>]+)?%>/g, reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = "var r=[];
", cursor = 0;
    var add = function(line, js) {
        js? (code += line.match(reExp) ? line + "
" : "r.push(" + line + ");
") :
            (code += line != "" ? "r.push("" + line.replace(/"/g, """) + "");
" : "");
        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(/[
	
]/g, "")).apply(options);
}

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

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

GPU云服务器 云服务器 js模板引擎数据绑定 js实现的简单特效 模板引擎 简单html表格模板

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/84349.html

相关文章

  • 浅谈web中前端模板引擎的使用

    摘要：置换型模板引擎的优点实现简单，缺点效率低，无法满足高负载的应用请求。用途百度词条模板引擎可以让网站程序实现界面与数据分离，业务代码与逻辑代码的分离，提升开发效率，良好的设计也提高了代码的复用性。前端模板的出现使得前后端分离成为可能。 模板引擎 模板引擎-百度词条 什么是模板引擎？（百度词条） 模板引擎（这里特指用于Web开发的模板引擎）是为了使用户界面与业务数据分离而产生的，它可以生成...

    妤锋シ 评论0 收藏0

  • 基于TmodJS的前端模板工程化解决方案

    摘要：原作者唐斌腾讯什么原名是一个简单易用的前端模板预编译工具。本文作者为来自腾讯团队的唐斌，他在本文中为我们分析了传统前端模板内嵌的弊端，如开发调试效率低下自动化构建复杂度比较高等特点，并针对目前现状给出了较好的解决方案。 原作者: 唐斌（腾讯）| TmodJS什么 TmodJS（原名atc）是一个简单易用的前端模板预编译工具。它通过预编译技术让前端模板突破浏览器限制，实现后端模板一样的同...

    zhaochunqi 评论0 收藏0

  • 浅谈 Web 中前后端模板引擎的使用

    摘要：前端模板的出现使得前后端分离成为可能。总结本文简单介绍了模板引擎在前后端的使用，下文我们回到，重点分析下的使用方式以及源码原理。楼主对于模板引擎的认识比较浅显，有不正之处希望指出感谢 前言 这篇文章本来不打算写的，实话说楼主对前端模板的认识还处在非常初级的阶段，但是为了整个 源码解读系列 的完整性，在深入 Underscore _.template 方法源码后，觉得还是有必要记下此文，...

    chenjiang3 评论0 收藏0

  • js模版引擎介绍

    摘要：使用方法编译模板并根据所给的数据立即渲染出结果仅编译模版暂不渲染，它会返回一个可重用的编译后的函数根据给定的数据，对之前编译好的模板进行数据渲染参考资料模板引擎概述 js模版引擎介绍 JavaScript 模板是将 HTML 结构从包含它们的内容中分离的方法。模板系统通常会引入一些新语法，但通常是非常简单的，一个要注意的有趣的点是，替换标记通常是由双花括号({ {……} })表示，这也...

    duan199226 评论0 收藏0

  • Web前端模板引擎の字符串模板

    摘要：这是一个系列文章，将会介绍目前前端领域里用到的三种模板引擎技术，它们分别是基于字符串的模板基于操作的模板基于虚拟的模板本文是这个系列的第一篇，着重介绍基于字符串的模板引擎的实现原理，分析它的优点缺点以及使用的场景。 这是一个系列文章，将会介绍目前Web前端领域里用到的三种模板引擎技术，它们分别是： 基于字符串的模板 基于Dom操作的模板 基于虚拟Dom的模板 本文是这个系列的第一篇...

    Pluser 评论0 收藏0

  • 字符串与JavaScript之间的魔术—前端模板的原理及简单实现

    摘要：大多数模板实现原理基本一致模板字符串首先通过各种手段剥离出普通字符串和模板语法字符串生成抽象语法树然后针对模板语法片段进行编译，期间模板变量均去引擎输入的变量中查找模板语法片段生成出普通片段，与原始普通字符串进行拼接输出。 前端模板的发展 模板可以说是前端开发最常接触的工具之一。将页面固定不变的内容抽出成模板，服务端返回的动态数据装填到模板中预留的坑位，最后组装成完整的页面html字符...

    Steve_Wang_ 评论0 收藏0

发表评论

登陆后可评论

0条评论

asoren

男|高级讲师
我要私信

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<