整合营销服务商

电脑端+手机端+微信端=数据同步管理

免费咨询热线:

JavaScript模板引擎原理与用法

篇文章主要介绍了JavaScript模板引擎原理与用法,结合实例形式详细分析了javascript模版引擎相关概念、原理、定义及使用方法,写的十分的全面细致,具有一定的参考价值,对此有需要的朋友可以参考学习下。如有不足之处,欢迎批评指正。

一、前言

什么是模板引擎,说的简单点,就是一个字符串中有几个变量待定。比如:

var tpl = 'Hei, my name is <%name%>, and I\'m <%age%> years old.';

通过模板引擎函数把数据塞进去,

var data = {
 "name": "Barret Lee",
 "age": "20"
};
var result = tplEngine(tpl, data);
//Hei, my name is Barret Lee, and I'm 20 years old.

那这玩意儿有什么作用呢?其实他就是一个预处理器(preprocessor),搞php开发的童鞋对Smarty必然是十分熟悉,Smarty是一个php模板引擎,tpl中待处理的字符通过数据匹配然后输出相应的html代码,加之比较给力的缓存技术,其速度和易用性是非常给力的!JS Template也是一样的,我们的数据库里保存着数以千万计的数据,而每一条数据都是通过同一种方式输入,就拿上面的例子来说,我们不可能在数据库里存几千条"Hei, my name...",而是只保存对应的name和age,通过模板输出结果。

JS模板引擎应该做哪些事情?看看下面一串代码:

var tpl = '<% for(var i = 0; i < this.posts.length; i++) {' + 
 'var post = posts[i]; %>' +
 '<% if(!post.expert){ %>' +
 '<span>post is null</span>' +
 '<% } else { %>' +
 '<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" ><% post.expert %> at <% post.time %></a>' +
 '<% } %>' +

一个基本的模板引擎至少可以保证上面的代码可以正常解析。如送入的数据是:

var data = {
 "posts": [{
 "expert": "content 1",
 "time": "yesterday"
 },{
 "expert": "content 2",
 "time": "today"
 },{
 "expert": "content 3",
 "time": "tomorrow"
 },{
 "expert": "",
 "time": "eee"
 }]
};

可以输出

<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >content 1 at yesterday</a>
<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >content 2 at today</a>
<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >content 3 at tomorrow</a>
<span>post is null</span>

下面就具体说说这个模板引擎的原理是啥样的。

二、JS模板引擎的实现原理

1.正则抠出要匹配的内容 针对这一串代码,通过正则获取内容

var tpl = 'Hei, my name is <%name%>, and I\'m <%age%> years old.';
var data = {
 "name": "Barret Lee",
 "age": "20"
};

最简单的方式就是通过replace函数了:

var result = tpl.replace(/<%([^%>]+)?%>/g, function(s0, s1){
 return data[s1];
});

通过正则替换,我们很轻松的拿到了result,你可以去试一试,他正是我们想要的结果。但是这里又有了一个问题,改一下data和tpl,

var tpl = 'Hei, my name is <%name%>, and I\'m <%info.age%> years old.';
var data = {
 "name": "Barret Lee",
 "info": { age": "20"}
};

再用上面的方式去获取结果,呵呵,不行了吧~ 这里data["info.age"]本身就是undefined,所以我们需要换一种方式来处理这个问题,那就是将它转换成真正的JS代码。如:

return 'Hei, my name is ' + data.name + ', and I\'m ' + data.info.age' + ' years old.'

但是接着又有一个问题来了,当我们的代码中出现for循环和if的时候,上面的转换明显是不起作用的,如:

var tpl = 'Posts: ' +
 '<% for(var i = 0; i < post.length; i++) {'+
 '<a href="#" 

如果继续采用上面的方式,得到的结果便是:

return 'Posts: ' +
 for(var i = 0; i < post.length; i++) { +
 '<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >' + post[i].exper + '</a>' +
 }

这显然不是我们愿意看到的,稍微观察一下上面的结构,如果可以返回一个这样的结果也挺不错哦:

'Posts: '
for(var i = 0; i < post.length; i++) {
 '<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >' + post[i].exper + '</a>'
}

但是我们需要得到的是一个字符串,而不是上面这样零散的片段,因此可以把这些东西装入数组中。

2.装入数组

var r = [];
r.push('Posts: ' );
r.push(for(var i = 0; i < post.length; i++) {);
r.push('<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >');
r.push(post[i].exper);
r.push('</a>');
r.push(});

有人看到上面的代码就要笑了,第三行和最后一行代码的逻辑明显是不正确的嘛,那肿么办呢?呵呵,很简单,不放进去就行了呗,

var r = [];
r.push('Posts: ' );
for(var i = 0; i < post.length; i++) {
 r.push('<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" >');
 r.push(post[i].exper);
 r.p

这样的逻辑就十分完善了,不存在太多的漏洞,但是这个转化的过程是如何实现的?我们必须还是要写一个解析的模板函数出来。 3.分辨js逻辑部分

var r = [];
tpl.replace(/<%([^%>]+)?%>/g, function(s0, s1){
 //完蛋了,这里貌似又要回到上面那可笑的逻辑有错误的一步啦... 该怎么处理比较好?
});

完蛋了,这里貌似又要回到上面那可笑的逻辑有错误的一步啦... 该怎么处理比较好?我们知道,JS给我们提供了构造函数的“类”,

var fn = new Function("data",
 "var r = []; for(var i in data){ r.push(data[i]); } return r.join(' ')");
fn({"name": "barretlee", "age": "20"}); // barretlee 20

道了这个就好办了,我们可以把逻辑部分和非逻辑部分的代码链接成一个字符串,然后利用类似fn的函数直接编译代码。而/<%([^%>]+)?%>/g,这一个正则只能把逻辑部分匹配出来,要想把所有的代码都组合到一起,必须还得匹配非逻辑部分代码。replace函数虽然很强大,他也可以完成这个任务,但是实现的逻辑比较晦涩,所以我们换另外一种方式

var reg = /<%([^%>]+)?%>/g;
var tpl = 'Hei, my name is <%name%>, and I\'m <%age%> years old.';
var match = reg.exec(tpl);
console.log(match);

看到的是:

[
 0: "<%name%>",
 1: name,
 index: 16,
 input: "Hei, my name is <%name%>, and I'm <%age%> years old."
 length: 2
]

这。。。我们可是想得到所有的匹配啊,他竟然只获取了name而忽略了后面的age,好吧,对正则稍微熟悉点的童鞋一定会知道应该这样处理:

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

关于正则表达式的内容就不在这里细说了,有兴趣的同学可以多去了解下match,exec,search等正则的相关函数。这里主要是靠match的index属性来定位遍历位置,然后利用while循环获取所有的内容。

4.引擎函数

所以我们的引擎函数雏形差不多就出来了:

var tplEngine = function(tpl, data){
 var reg = /<%([^%>]+)?%>/g,
 code = 'var r=[];\n',
 cursor = 0; //主要的作用是定位代码最后一截
 var add = function(line) {
 code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
 };
 while(match = reg.exec(tpl)) {
 add(tpl.slice(cursor, match.index)); //添加非逻辑部分
 add(match[1]); //添加逻辑部分 match[0] = "<%" + match[1] + "%>";
 cursor = match.index + match[0].length;
 }
 add(tpl.substr(cursor, tpl.length - cursor)); //代码的最后一截 如:" years old."
 code += 'return r.join("");'; // 返回结果,在这里我们就拿到了装入数组后的代码
 console.log(code);
 return tpl;
};

这样一来,测试一个小demo:

var tpl = '<% for(var i = 0; i < this.posts.length; i++) {' + 
 'var post = posts[i]; %>' +
 '<% if(!post.expert){ %>' +
 '<span>post is null</span>' +
 '<% } else { %>' +
 '<a href="#" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" ><% post.expert %> at <% post.time %></a>' +
 '<% } %>' +
 '<% } %>';
tplEngine(tpl, data);

返回的结果让人很满意:

var r=[];
r.push("");
r.push(" for(var i = 0; i < this.posts.length; i++) {var post = posts[i]; ");
r.push("");
r.push(" if(!post.expert){ ");
r.push("<span>post is null</span>");
r.push(" } else { ");
r.push("<a href=\"#\">");
r.push(" post.expert ");
r.push(" at ");
r.push(" post.time ");
r.push("</a>");
r.push(" } ");
r.push("");
r.push(" } ");
r.push("");

不过我们并需要for,if,switch等这些东西也push到r数组中去,所以呢,还得改善下上面的代码,如果在line中发现了包含js逻辑的代码,我们就不应该让他进门:

regOut = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g;
var add = function(line, js) {
 js? code += line.match(regOut) ? line + '\n' : 'r.push(' + line + ');\n' :
 c

所以我们只剩下最后一步工作了,把data扔进去!

5.把data扔进去

没有比完成这东西更简单的事情啦,通过上面对Function这个函数的讲解,大家应该也知道怎么做了。

return new Function(code).apply(data);

使用apply的作用就是让code中的一些变量作用域绑定到data上,不然作用域就会跑到global上,这样得到的数据索引就会出问题啦~ 当然我们可以再优化一下:

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

把回车换行以及tab键都给匹配掉,让代码更加干净一点。那么最终的代码就是:

var tplEngine = function(tpl, data) {
 var reg = /<%([^%>]+)?%>/g,
 regOut = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,
 code = 'var r=[];\n',
 cursor = 0;
 var add = function(line, js) {
 js? (code += line.match(regOut) ? line + '\n' : 'r.push(' + line + ');\n') :
 (code += line != '' ? 'r.push("' + line.replace(/"/g, '\\"') + '");\n' : '');
 return add;
 }
 add(tpl.slice(cursor, match.index))(match[1], true);
 cursor = match.index + match[0].length;
 }
 add(tpl.substr(cursor, tpl.length - cursor));
 code += 'return r.join("");';
 return new Function(code.replace(/[\r\t\n]/g, '')).apply(data);
};

三、应用场景

毕竟是前端代码,所以写出来是要为前端服务的,平时我们处理的一般是一个html的模板,通常的情况下,模板代码是放在script标签或者textarea中,所以首先是要获取到这里头的东西,然后再来做解析。

var barretTpl = function(str, data) {
 //获取元素
 var element = document.getElementById(str);
 if (element) {
 //textarea或input则取value,其它情况取innerHTML
 var html = /^(textarea|input)$/i.test(element.nodeName) ? element.value : element.innerHTML;
 return tplEngine(html, data);
 } else {
 //是模板字符串,则生成一个函数
 //如果直接传入字符串作为模板,则可能变化过多,因此不考虑缓存
 return tplEngine(str, data);
 }
 var tplEngine = function(tpl, data) {
 // content above
 };
};

这样一来就更加简单了,使用方式就是 barretTpl(str, data), 这里的str可以是模板代码,也可以是一个DOM元素的id~

四、优化以及功能拓展

总共就三四十行代码,完成的东西肯定是一个简洁版的,不过对于一个简单的页面而言,这几行代码已经足够使用了,如果还想对他做优化,可以从这几个方面考虑:

  • 优化获取的模板代码,比如去掉行尾空格等
  • 符号转义,如果我们想输出<span>hehe</span>类似这样的源代码,在push之前必须进行转义 代码缓存,如果一个模板会经常使用,可以将它用一个数组缓存在barretTpl闭包内
  • 用户自己设置分隔符

结语

感谢您的观看,如有不足之处,欢迎批评指正。

CSS有非常多的属性,每个属性又有很多很多的值,好的书写顺序给人眼前一亮的感觉,同时也方便了日后的维护,那么什么样的顺序才合适呢?其实不需要死记硬背,我们可以把CSS书写的先后顺序比作为一个人的自我简历,当我们做介绍时基本顺序是:家庭地址,姓名、身高、体重,家庭情况,学历、工作简历,特长爱好等,那么CSS书写顺序也跟这个类似,如下:

1、布局位置属性:display position float clear visibility top right overflow z-index 等;

2、自身属性:width height margin padding 等;

3、 背景边框:border background 等;

4、文本属性: font color text-decoration text-align vertical-align white- space break-word 等;

5、其他属性:content cursor border-radius box-shadow text-shadow animation transition等。

是不是跟个人简历顺序基本相同?当写CSS时联想一下自己简历顺序就出来了!

下面两段CSS截取国内知名网站,基本都是按照上面顺序书写!

.site-header .logo {

position: relative;

display: block;

width: 55px;

height: 55px;

overflow: hidden;

background-color: #ff6700;

*background: url(/i/logo.png) no-repeat 50% 50%;

}

们要先了解一下什么是浏览器兼容性,

  • 指因为不同的浏览器对同一段代码有不同的解析,造成页面显示效果不统一的情况。(JS、html、css的兼容性)

  • 在网站的设计和制作中,做好浏览器兼容,才能够让网站在不同的浏览器下都正常显示。

具体指的是以下两方面的不兼容:

a) 不同的浏览器对CSS解释不同

b) 不同的浏览器的默认值表现差别

说到浏览器的兼容性,那我们要了解一下有那些浏览器和浏览器的历史了。

A. Netscape Navigator

Netscape Navigator 网景,开始时是收费的。为IE的崛起留下了后患。

B. IE浏览器

  • 1995年 IE浏览器第一个版本首发

  • 1997年IE4版本发布,再后来2001年8月IE6浏览器独占鳌头

  • 2006年10月IE7发布

  • 2009年3月IE8发布

  • 2011年3月IE9发布

  • 2011年4月IE10发布

C. 2004年11月Firefox1.0首发

D. 2008年 谷歌浏览器发布

E. 1995年4月 opera浏览器发布

做好浏览器的兼容性,也就是我们写的代码要符合一种标准,再让浏览器都符合这种标准也就实现了浏览器的兼容了。

首先我们来看一下我们写的代码要符合那种标准,也就是W3C标准。

W3C—World Wide Web Consortium 万维网联盟,万维网联盟创建于1994年,是WEB技术领域最具有权威和影响力的国际中立性技术标准机构。Web标准是一系列标准的集合。网页主要由三部分组成:结构(Structure)也就是HTML、表现(Presentation)也就是CSS、行为(Behavior)也就是JS。那怎样让我们的代码做到符合WEB标准呢?

HTML标准

1. 每个文档必须加上DOCTYPE声明

2. 定义语言编码

3. 图片的alt="" 属性必须每张图片都加上,而且对齐属性用CSS来定义

4. 标签的链接属性加上JAVASCRIPT事件时必须为#空链,不能为javascript:;或javascript:void(null);

5. 同一个页面当中,同名的ID会产生冲突

6. 标签属性不可省略双引号或单引号,尽量使用双引号

7. 标签之间不可交叉嵌套

8. 所有的标签都使用小写

9. 闭合。双标签必须闭合,单标签(自关闭标签)不闭合

10. 所有的样式全部写在外部文件

11. 页面上的一些特殊字符必须用HTML代码来标识.如“&”写成“&“

o 任何小于号(<),不是标签的一部分,都必须被编码为

o 任何大于号(>),不是标签的一部分,都必须被编码为

o 任何与号(&),不是实体的一部分的,都必须被编码为

12. 栏目标题部分使用h标签

13. 对于SEO优化的标签有二个比较重要的Strong和Em的。它们的权重是很高的,Strong有重点,突出之意,em有强调 提醒之意

14. 使用表格时不要给表格指定高度,

15. 使用<label>标签包裹radio或checkbox和他们的文字

16. 省略type属性。使用style、link、script,不用指定type属性,因为 text/css 和 text/javascript 分别是他们的默认值。

17. 省略Boolean属性值。Boolean属性不用添加取值,disabled,checked,selected等

18. 详尽注释但是不建议块状注释

CSS标准

1. 不建议CSS中嵌套的层次太多,建议三次为佳

2. 建议把具有共性的CSS提成全局的这样每个需要使用的标签可以去继承;减少CSS代码会提高加载效率

3. 在书写CSS时,建议使用全小写字母

4. 在写CSS属性时,能写复合属性的写复合属性

书写代码原则

1. 规范 。保证您的代码规范,趋html5,远xhtml,保证结构表现行为相互分离

2. 简洁。保证代码的最简化,避免多余的空格、空行,保持代码的语义化,尽量使用具有语义的元素,避免使用样式属性和行为属性。任何时候都要用尽量简单、尽量少的元素解决问题。

3. 实用。遵循标准,但是不能以牺牲实用性为代价

4. 忠诚。选择一套规范,然后始终遵循。不管代码由多少人参与,都应该看起来像一个人写的一样。

以上也是我们书写代码时注意事项。

了解以上的知识点之后我们来看一下如何做到写的代码浏览器兼容吧及常见问题及解决方案

√ CSS Hack(修改)

√ 常见问题(bug)及解决方法

√ 经验与技巧

一、 CSS Hack

1. 什么是CSS Hack

由于不同的浏览器,甚至同一浏览器的不同版本对CSS的解析认识不一样,导致生成的页面效果不一致,写出针对不同浏览器CSS code就称为CSS hack

2. CSS Hack的分类

  • IE条件注释Hack

  • CSS选择符Hack

  • CSS属性Hack

  • !important

  • Css3新增属性及选择器hack

注:css hack的书写顺序:总结出的规律就是:先一般,再特殊 。

好,我们CSS Hack分别讲解一下吧!

2.1 IE条件注释Hack

为什么使用IE条件注释法呢,因为IE的版本不断的更新,还有一部分用户在使用老版本的浏览器,浏览器的版本之间也存在着浏览器的兼容问题,所以要做好浏览器的兼容性。就像现在,如果我们写代码要把IE浏览器兼容好的话,我们要做兼容IE6、IE7、IE8、IE9、IE10、IE11;但是我们知道IE6、IE7几乎没有人使用了,所以我们做页面不需要考虑IE6和IE7了。但是我们对于以前的知识点还是要掌握的。

在这里大家要装一下IE Tester这个集成浏览器。这个软件将所有的IE版本的浏览器集成到了一起,测试不同版本的浏览器兼容性比较方便。

语法:

a):针对CSS添加的条件注释法,根据代码具有注释的版本识别的CSS样式。

<!--[if IE]><!-- 如果是IE浏览器,调用css.css样式表 -->

<link rel="stylesheet" type="text/css" href="css.css" />

<![endif]-->

HTML代码:

CSS代码:

IE浏览器的显示效果:

其它浏览器版本显示的都一样,这里就不一一截图了!

非IE浏览器的显示效(因为是专门对IE浏览器的,所以其它浏览器就不会有效果了):

所以我们可针对不同的IE浏览器那一部分的CSS存在兼容的问题,可以单独去写相关的CSS代码。如果还可以专门指定是那个版本,也可以再加上相关的修饰符,我们这里只演示一个(lt),其它的使用方式都一样。来看一下效果。

HTML代码:

CSS代码:

显示效果: