JavaScript模板引擎应用场景及实现原理详解


Posted in Javascript onDecember 14, 2018

本文实例讲述了JavaScript模板引擎应用场景及实现原理。分享给大家供大家参考,具体如下:

一、应用场景

以下应用场景可以使用模板引擎:

1、如果你有动态ajax请求数据并需要封装成视图展现给用户,想要提高自己的工作效率。
2、如果你是拼串族或者数组push族,迫切的希望改变现有的书写方式。
3、如果你在页面布局中,存在共性模块和布局,你可以提取出公共模板,减少维护的数量。

二、实现原理

不同模板间实现原理大同小异,各有优缺,请按需选择,以下示例以artTemplate模板引擎来分析。

2.1 模板存放

模板一般都是放置到textarea/input等表单控件,或者script[type="text/html"]等标签中,如下:

<script id="test" type="text/html">
 {{if isAdmin}}
 <h1>{{title}}</h1>
 <ul>
   {{each user as name i}}
     <li> {{i + 1}} :{{name}}</li>
   {{/each}}
 </ul>
 {{/if}}
</script>
//textarea或input则取value,其它情况取innerHTML

2.2 模板函数

一般都是templateFun("id", data);其中id为存放模板字符串的元素id,data为需要装载的数据。

2.3 模板获取

一般都是通过ID来获取,document.getElementById("ID"):

//textarea或input则取value,其它情况取innerHTML
var html = /^(textarea|input)$/i.test(element.nodeName) ? element.value : element.innerHTML;

2.4 模板解析——处理html语句和逻辑语句及其他格式化处理

这步的主要操作其实多余的空格,解析出html元素和逻辑语句及关键字。例如:artTemplate.js中的代码实现:

defaults.parser = function (code, options) {
  // var match = code.match(/([\w\$]*)(\b.*)/);
  // var key = match[1];
  // var args = match[2];
  // var split = args.split(' ');
  // split.shift();
  //if isAdmin
  code = code.replace(/^\s/, '');
  //["if", "isAdmin"]
  var split = code.split(' ');
  //if
  var key = split.shift();
  //isAdmin
  var args = split.join(' ');
  switch (key) {
    case 'if':
      //if(isAdmin){
      code = 'if(' + args + '){';
      break;
    case 'else':
      if (split.shift() === 'if') {
        split = ' if(' + split.join(' ') + ')';
      } else {
        split = '';
      }
      code = '}else' + split + '{';
      break;
    case '/if':
      code = '}';
      break;
    case 'each':
      var object = split[0] || '$data';
      var as   = split[1] || 'as';
      var value = split[2] || '$value';
      var index = split[3] || '$index';
      var param  = value + ',' + index;
      if (as !== 'as') {
        object = '[]';
      }
      code = '$each(' + object + ',function(' + param + '){';
      break;
    case '/each':
      code = '});';
      break;
    case 'echo':
      code = 'print(' + args + ');';
      break;
    case 'print':
    case 'include':
      code = key + '(' + split.join(',') + ');';
      break;

例如上例中:”{{if isAdmin}}”最终被解析成”if(isAdmin){”,”{{/if}}“被解析成“}”。

2.5 模板编译——字符串拼接成生成函数的过程

这步的主要操作就是字符串的拼接成生成函数,看看artTemplate的部分源码:

function compiler (source, options) {
  /*
  openTag: '<%',  // 逻辑语法开始标签
  closeTag: '%>',  // 逻辑语法结束标签
  escape: true,   // 是否编码输出变量的 HTML 字符
  cache: true,   // 是否开启缓存(依赖 options 的 filename 字段)
  compress: false, // 是否压缩输出
  parser: null   // 自定义语法格式器 @see: template-syntax.js
  */
  var debug = options.debug;
  var openTag = options.openTag;
  var closeTag = options.closeTag;
  var parser = options.parser;
  var compress = options.compress;
  var escape = options.escape;
  var line = 1;
  var uniq = {$data:1,$filename:1,$utils:1,$helpers:1,$out:1,$line:1};
  //isNewEngin在6-8返回undefined
  var isNewEngine = ''.trim;// '__proto__' in {}
  var replaces = isNewEngine
  ? ["$out='';", "$out+=", ";", "$out"]
  : ["$out=[];", "$out.push(", ");", "$out.join('')"];
  var concat = isNewEngine
    ? "$out+=text;return $out;"
    : "$out.push(text);";
  var print = "function(){"
  +   "var text=''.concat.apply('',arguments);"
  +    concat
  + "}";
  var include = "function(filename,data){"
  +   "data=data||$data;"
  +   "var text=$utils.$include(filename,data,$filename);"
  +    concat
  +  "}";
  var headerCode = "'use strict';"
  + "var $utils=this,$helpers=$utils.$helpers,"
  + (debug ? "$line=0," : "");
  var mainCode = replaces[0];
  var footerCode = "return new String(" + replaces[3] + ");"
  // html与逻辑语法分离
  forEach(source.split(openTag), function (code) {
    code = code.split(closeTag);
    var $0 = code[0];
    var $1 = code[1];
    // code: [html]
    if (code.length === 1) {
      mainCode += html($0);
    // code: [logic, html]
    } else {
      mainCode += logic($0);
      if ($1) {
        mainCode += html($1);
      }
    }
  });
  var code = headerCode + mainCode + footerCode;

上例中模板中的模板字符串代码会被拼接成如下字符串:

'use strict';
var $utils  = this,
 $helpers = $utils.$helpers,
 isAdmin = $data.isAdmin,
 $escape = $utils.$escape,
 title  = $data.title,
 $each  = $utils.$each,
 user   = $data.user,
 name   = $data.name,
 i    = $data.i,
 $out   = '';
if (isAdmin) {
 $out += '\n\n <h1>';
 $out += $escape(title);
 $out += '</h1>\n <ul>\n   ';
 $each(user, function(name, i) {
 $out += '\n     <li>';
 $out += $escape(i + 1);
 $out += ' :';
 $out += $escape(name);
 $out += '</li>\n   ';
 });
 $out += '\n </ul>\n\n ';
}
return new String($out);

然后会被生成如下函数:

var Render = new Function("$data", "$filename", code);
/*Outputs:
function anonymous($data, $filename) {
 'use strict';
 var $utils  = this,
 $helpers = $utils.$helpers,
 isAdmin = $data.isAdmin,
 $escape = $utils.$escape,
 title  = $data.title,
 $each  = $utils.$each,
 user   = $data.user,
 name   = $data.name,
 i    = $data.i,
 $out   = '';
 if (isAdmin) {
 $out += '\n\n <h1>';
 $out += $escape(title);
 $out += '</h1>\n <ul>\n   ';
 $each(user, function(name, i) {
  $out += '\n     <li>';
  $out += $escape(i + 1);
  $out += ' :';
  $out += $escape(name);
  $out += '</li>\n   ';
 });
 $out += '\n </ul>\n\n ';
 }
 return new String($out);
}
 */
console.log(Render);

2.5 装载数据,视图呈现

/*Outputs:
<h1>User lists</h1>
<ul>
  <li>1 :zuojj</li>
  <li>2 :Benjamin</li>
  <li>3 :John</li>
  <li>4 :Rubby</li>
  <li>5 :Handy</li>
  <li>6 :CIMI</li>
</ul>
*/
console.log(new Render(data, filename) + '');
//对象转换为字符串
return new Render(data, filename) + '';

三、常见JavaScript模板引擎及测试对比

更多关于JavaScript相关内容可查看本站专题:《javascript面向对象入门教程》、《JavaScript查找算法技巧总结》、《JavaScript错误与调试技巧总结》、《JavaScript数据结构与算法技巧总结》、《JavaScript遍历算法与技巧总结》及《JavaScript数学运算用法总结》

希望本文所述对大家JavaScript程序设计有所帮助。

Javascript 相关文章推荐
Array栈方法和队列方法的特点说明
Jan 24 Javascript
JS对象转换为Jquery对象示例
Jan 26 Javascript
在javascript中随机数 math random如何生成指定范围数值的随机数
Oct 21 Javascript
Javascript中Date类型和Math类型详解
Feb 27 Javascript
完美解决JS文件页面加载时的阻塞问题
Dec 18 Javascript
详解vue嵌套路由-query传递参数
May 23 Javascript
template.js前端模板引擎使用详解
Oct 10 Javascript
解决Angular4项目部署到服务器上刷新404的问题
Aug 31 Javascript
原生JS实现简单的无缝自动轮播效果
Sep 26 Javascript
基于vue.js组件实现分页效果
Dec 29 Javascript
vue实现百度搜索功能
Dec 28 Javascript
vue实践---根据不同环境,自动转换请求的url地址操作
Sep 21 Javascript
详解React 服务端渲染方案完美的解决方案
Dec 14 #Javascript
JS/HTML5游戏常用算法之路径搜索算法 A*寻路算法完整实例
Dec 14 #Javascript
JS实现的A*寻路算法详解
Dec 14 #Javascript
详解vue项目接入微信JSSDK的坑
Dec 14 #Javascript
微信小程序实现动态显示和隐藏某个控件功能示例
Dec 14 #Javascript
javascript中的event loop事件循环详解
Dec 14 #Javascript
如何在Vue中使用CleaveJS格式化你的输入内容
Dec 14 #Javascript
You might like
一个用php3编写的简单计数器
2006/10/09 PHP
Yii2使用自带的UploadedFile实现的文件上传
2016/06/20 PHP
laravel入门知识点整理
2020/09/15 PHP
图片上传即时显示缩略图的js代码
2009/05/27 Javascript
javascript instanceof,typeof的区别
2010/03/24 Javascript
根据出生日期自动取得星座的js代码
2010/07/20 Javascript
浅谈Javascript面向对象编程
2011/11/15 Javascript
Javascript判断对象是否相等实现代码
2013/03/18 Javascript
node.js [superAgent] 请求使用示例
2015/03/13 Javascript
c#程序员对TypeScript的认识过程
2015/06/19 Javascript
总结在前端排序中遇到的问题
2016/07/19 Javascript
用AngularJS来实现监察表单按钮的禁用效果
2016/11/02 Javascript
基于JavaScript实现复选框的全选和取消全选
2017/02/09 Javascript
Node.js中.pfx后缀文件的处理方法
2017/03/10 Javascript
node操作mysql数据库实例详解
2017/03/17 Javascript
Node.js利用debug模块打印出调试日志的方法
2017/04/25 Javascript
基于zepto.js实现手机相册功能
2017/07/11 Javascript
轻松学习JavaScript函数中的 Rest 参数
2019/05/30 Javascript
微信小程序Echarts覆盖正常组件问题解决
2019/07/13 Javascript
小程序登录之支付宝授权的实现示例
2019/12/13 Javascript
jquery实现直播视频弹幕效果
2020/02/25 jQuery
[01:16:50]DOTA2-DPC中国联赛 正赛 Phoenix vs CDEC BO3 第一场 3月7日
2021/03/11 DOTA
tensorflow 输出权重到csv或txt的实例
2018/06/14 Python
Python中GIL的使用详解
2018/10/03 Python
利用python实现简易版的贪吃蛇游戏(面向python小白)
2018/12/30 Python
Python 使用 Pillow 模块给图片添加文字水印的方法
2019/08/30 Python
python 内置函数汇总详解
2019/09/16 Python
python ffmpeg任意提取视频帧的方法
2020/02/21 Python
python+selenium+PhantomJS抓取网页动态加载内容
2020/02/25 Python
加拿大女装网上购物:Reitmans
2016/10/20 全球购物
西班牙国家航空官方网站:Iberia
2017/11/16 全球购物
销售行业个人求职自荐信
2013/09/25 职场文书
机械设计专业应届生求职信
2013/11/21 职场文书
厨师长岗位职责
2014/03/02 职场文书
渠道运营商合作协议书范本
2014/10/06 职场文书
重阳节慰问信
2015/02/15 职场文书