JavaScript轻量级模板引擎Juicer使用指南

作者:纸飞机时间:2026-10-28 12:34:39浏览:346

本文详细介绍JavaScript轻量级模板引擎Juicer的使用方法。涵盖基础渲染、编译缓存机制、默认配置修改及自定义函数注册。重点解析${}变量输出、转义处理、循环遍历及条件判断等核心语法,并提供完整的HTML与JavaScript代码示例,帮助开发者快速上手Juicer进行前端页面渲染。

Juicer基础使用方法

调用方式

对模板进行编译并基于指定数据即时生成渲染结果


juicer(tpl, data);

仅执行模板编译操作而不立即渲染,返回一个可复用的编译后函数


 var compiled_tpl = juicer(tpl);

利用提供的数据对已编译的模板执行渲染操作


 var complied_tpl = juicer(tpl);
 var html = complied_tpl.render(data);

注册或注销自定义函数(对象)


juicer.register(‘function_name', function);
juicer.unregister(‘function_name');

默认参数配置说明


 {
   cache: true [false];
   script: true [false];
   error handling: true [false];
   detection: true [false];
 }

修改默认配置,支持逐条修改


 juicer.set('cache', false);

修改默认配置,支持批量修改


 juicer.set({
      'script': false,
      'cache': false
 })

Juicer 默认启用编译后模板缓存机制,旨在避免同一模板在多次数据渲染时重复编译带来的时间消耗。除非有特殊需求,否则强烈建议不要关闭默认参数中的 cache 选项,因为关闭缓存会导致 Juicer 缓存机制失效,进而降低整体性能。

Juicer核心语法详解

语法规范

* ${变量}

- 使用 ${} 输出变量,其中 _ 代表对数据源的引用(如 ${_})。该语法支持调用自定义函数。


${name}
${name|function}
${name|function, arg1, arg2} 

 var = links: [{href: 'http://juicer.name', alt: 'Juicer'},
            {href: 'http://benben.cc', alt: 'Benben'},
            {href: 'http://ued.taobao.com', alt: 'Taobao UED'}  
           ]};
 var tpl = [ '{@each links as item}',
         '${item|links_build} <br />',  
         '{@/each}'].join('');
 var links = function(data) {    
   return '<a href="' + data.href + '" alt="' + data.alt + '" />';
};
juicer.register('links_build', links); //注册自定义函数
juicer(tpl, json);

* 转义与避免转义处理

- ${变量} 在输出前会自动对其内容进行转义处理。若希望输出结果不被转义,可使用 $${变量} 来禁用此行为。


 var json = {
    value: '<strong>juicer</strong>'
 };
 var escape_tpl='${value}';
 var unescape_tpl='$${value}';
 juicer(escape_tpl, json); //输出 '<strong>juicer</strong>'
 juicer(unescape_tpl, json); //输出 '<strong>juicer</strong>' 

* 循环遍历语法 {@each} ... {@/each}

- 用于遍历数组,其中 ${index} 表示当前遍历的索引值


 {@each list as item, index}
     ${item.prop}
     ${index} //当前索引
 {@/each}

* 条件判断语法 {@if} ... {@else if} ... {@else} ... {@/if}

* 注释语法 {# 注释内容}

{# 这里是注释内容} * 辅助循环语法 {@each i in range(m, n)}


 {@each i in range(5, 10)}
     ${i}; //输出 5;6;7;8;9;
 {@/each}

* 子模板嵌套语法 {@include tpl, data}

- 子模板嵌套功能不仅支持引入数据中指定的子模板,还允许通过指定字符串 `#id` 来使用定义在 `script` 标签内的模板代码。

- HTML 代码示例:


<script type="text/juicer" id="subTpl">
   I'm sub content, ${name}
</script>

- Javascript 代码示例:


var tpl = 'Hi, {@include "#subTpl", subData}, End.';

juicer(tpl, {
subData: {
name: 'juicer'
}
});

//输出 Hi, I'm sub content, juicer, End.
 //或者通过数据引入子模板,下述代码也将会有相同的渲染结果:
 
 var tpl = 'Hi, {@include subTpl, subData}, End.';
 
 juicer(tpl, {
     subTpl: "I'm sub content, ${name}",
     subData: {
        name: 'juicer'
     }
 });

Juicer完整应用示例

一个完整的综合示例

HTML 代码部分:


 <script id="tpl" type="text/template">
   <ul>
     {@each list as it,index}
       <li>${it.name} (index: ${index})</li>
     {@/each}
     {@each blah as it}
       <li>
         num: ${it.num} <br />
         {@if it.num==3}
           {@each it.inner as it2}
             ${it2.time} <br />
           {@/each}
         {@/if}
       </li>
     {@/each}
   </ul>
 </script>

Javascript 代码部分:


 var data = {
   list: [
     {name:' guokai', show: true},
     {name:' benben', show: false},
     {name:' dierbaby', show: true}
   ],
   blah: [
     {num: 1},
     {num: 2},
     {num: 3, inner:[
       {'time': '15:00'},
       {'time': '16:00'},
       {'time': '17:00'},
       {'time': '18:00'}
     ]},
     {num: 4}
   ]
 };
 
 var tpl = document.getElementById('tpl').innerHTML;
 var html = juicer(tpl, data);
作者最新文章