欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-06-22 16:38:21
本文实例讲述了javascript模板引擎应用场景及实现原理。分享给大家供大家参考,具体如下: 一、应用场景 以下应用场景可以使用模板引擎: 1、如果你有动态ajax...

本文实例讲述了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模板引擎及测试对比

arttemplate —— 高性能javascript模板引擎(腾讯cdc)
velocity.js —— 来自淘宝的js 模板引擎
javascript templates —— 轻量、快速、强大、无依赖模板引擎
juicer —— 高效、轻量的javascript模板引擎
mustache.js —— logic-less {{mustache}} templates with javascript

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

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