jQuery-tmpl基于jQuery简单实用的模板引擎

矫情吗；* 2022-06-04 09:51 182阅读 0赞

jQuery-tmpl是一个简单的模板引擎，能够实现动态的修改DOM数据，使用简单易懂的语法结构，通过JSON的格式传递和绑定数据，这个也是jQuery官方团队维护的模板引擎，很不幸的是这个项目将不在提供维护更新，将由JsRender替代。 如果你还是喜欢使用jQuery-tmpl，这篇文章将为你详细的介绍如何使用jQuery-tmpl。 前言 动态请求数据来更新页面是现在非常常用的方法，比如博客评论的分页动态加载，微博的滚动加载和定时请求加载等，这些情况下，动态请求返回的数据一般不是已拼好的 HTML 就是 JSON 或 XML，总之不在浏览器端拼数据就在服务器端拼数据。不过从传输量方面来看，返回 HTML 不划算，而在 Web 传输方面，现在更多的是使用 JSON 而不是 XML。 浏览器端根据 JSON 生成 HTML 有个很苦恼的地方就是，结构不复杂的时候还好，结构一复杂，就想死了，需要很小心很小心地写出几乎无法维护的 JavaScript 代码。 因此一些用模版生成HTML的的框架相继出现jQuery-tmpl 就是其中的一种，下面我们来详细介绍下jQuery.tmpl的用法和语法结构，以及一些使用的示例。 在Ajax横道的今天，我们在页面交互上有了更高的要求，动态生成HTML毫无疑问是其中的一种。动态生成HTML的方式多种多样，其核心不外乎在前段 （JS）或者后端（C#/PHP）将数据组装成我们想要的模版，最终通过一定的方法输出给用户（innerHTML、documentWrite等方式）。 jQuery-tmpl这个插件能够很好的满足了我们的需求。使用这种新型的模版技术仅仅需要引入jQuery-tmpl这个插件而已。该插件十分小巧（5.97KB），对于性能的影响并不大。 jQuery-tmpl jQuery-tmpl的几种常用标签分别有：
     
      
       ${}
       { {each}}
       { {if}}
       { {else}}
       { {html}}
      不常用标签是：
     
      
       { {=}}
       { {tmpl}}
       { {wrap}}
      ${}等同与{
       {=}}是输出变量 ${}里面还可以放表达式 （=和变量之间一定要有空格，否则无效） <div id="div_demo"></div>
    <script id="demo" type="text/x-jquery-tmpl">
        <div style="margin-bottom:10px;">
        　　<span>${ID}</span>
        　　<span style="margin-left:10px;">{
       {= Name}}</span>
        　　<span style="margin-left:10px;">${Number(Num)+1}</span>
        　　<span style="margin-left:10px;">${Status}</span>
        </div>
    </script>
    <script type="text/javascript">
    　　var users = [{ ID: 'think8848', Name: 'Joseph Chan', Num: '1', Status: 1 }, { ID: 'aCloud', Name: 'Mary Cheung', Num: '2'}];
    　　$("#demo").tmpl(users).appendTo('#div_demo');
    </script> 语法介绍 {
       {each}} 提供循环逻辑，$value访问迭代变量 也可以自定义迭代变量(i,value) <div id="div_each"></div>
    <script id="each" type="text/x-jquery-tmpl"> 
        <h3>users</h3>
        {
       {each(i,user) users}}
            <div>${i+1}:{
       {= user.name}}</div>
            {
       {if i==0}}
                <h4>group</h4>
                {
       {each(j,group) groups}}
                    <div>${group.name}</div>
                {
       {/each}}
            {
       {/if}}
        {
       {/each}}
        <h3>depart</h3>
        {
       {each departs}}
            <div>{
       {= $value.name}}</div>
        {
       {/each}}
    </script> 
    <script type="text/javascript">
    　　var eachData = { users: [{ name: 'jerry' }, { name: 'john'}], groups: [{ name: 'mingdao' }, { name: 'meihua' }, { name: 'test'}], departs: [{ name: 'IT'}] };
    　　$("#each").tmpl(eachData).appendTo('#div_each');
    </script> {
       {if }} {
       {else}} 提供了分支逻辑 {
       {else}} 相当于else if <div id="div_ifelse"></div>
    <script id="ifelse" type="text/x-jquery-tmpl"> 
        <div style="margin-bottom:10px;"><span>${ID}</span><span style="margin-left:10px;">{
       {= Name}}</span>
            {
       {if Status}}
                <span>Status${Status}</span>
            {
       {else App}}
                <span>App${App}</span>
            {
       {else}}
                <span>None</span>
            {
       {/if}}
        </div>
    </script> 
    <script type="text/javascript">
    　　var users = [{ ID: 'think8848', Name: 'Joseph Chan', Status: 1, App: 0 }, { ID: 'aCloud', Name: 'Mary Cheung', App: 1 }, { ID: 'bMingdao', Name: 'Jerry Jin'}];
        $("#ifelse").tmpl(users).appendTo('#div_ifelse');
    </script>
    {
       {html}} 输出变量html,但是没有html编码，适合输出html代码
    <div id="div_html"></div>
    <script id="html" type="text/x-jquery-tmpl"> 
        <div style="margin-bottom:10px;">
    　　　　<span>${ID}</span>
    　　　　<span style="margin-left:10px;">{
       {= Name}}</span>
        　　${html}
        　　{
       {html html}}
        </div>
    </script> 
    <script type="text/javascript">
    　　var user = { ID: 'think8848', Name: 'Joseph Chan', html: '<button>html</button>' };
      　$("#html").tmpl(user).appendTo('#div_html');
    </script> {
       {tmpl}} 嵌套模版 <div id="tmpl"></div>
    <script id="tmpl1" type="text/x-jquery-tmpl">
        <div style="margin-bottom:10px;">
        　　<span>${ID}</span>
        　　<span style="margin-left:10px;">{
       {tmpl($data) '#tmpl2'}}</span>
        </div>     
    </script>
    <script id="tmpl2" type="type/x-jquery-tmpl">
        {
       {each Name}}${$value}  {
       {/each}}   
    </script>
    <script type="text/javascript">
    　　var users = [{ ID: 'think8848', Name: ['Joseph', 'Chan'] }, { ID: 'aCloud', Name: ['Mary', 'Cheung']}];
       $("#tmpl1").tmpl(users).appendTo('#tmpl');
    </script> {
       {wrap}} 包装器 <div id="wrapDemo"></div>
    <script id="myTmpl" type="text/x-jquery-tmpl">
        The following wraps and reorders some HTML content:
        {
       {wrap "#tableWrapper"}}
            <h3>One</h3>
            <div>
                First <b>content</b>
            </div>
            <h3>Two</h3>
            <div>
                And <em>more</em> <b>content</b>...
            </div>
        {
       {/wrap}}
        </script>
    <script id="tableWrapper" type="text/x-jquery-tmpl">
        <table cellspacing="0" cellpadding="3" border="1"><tbody>
            <tr>
                {
       {each $item.html("h3", true)}}
                    <td>
                        ${$value}
                    </td>
                {
       {/each}}
            </tr>
            <tr>
                {
       {each $item.html("div")}}
                    <td>
                        {
       {html $value}}
                    </td>
                {
       {/each}}
            </tr>
        </tbody></table>
        </script>
    <script type="text/javascript">
    $(function () {
        $('#myTmpl').tmpl().appendTo('#wrapDemo');
    });
    </script> $data和$item $item代表当前的模板；$data代表当前的数据。 <div id="div_item_data"></div>
    <script id="item_data" type="text/x-jquery-tmpl"> 
         <div style="margin-bottom:10px;">
    　　　　<span>${$data.ID}</span>
    　　　　<span style="margin-left:10px;">${$item.getName(" ")}</span>
    　　　</div>
    </script> 
    <script type="text/javascript">
    var users = [{ ID: 'think8848', Name: ['Joseph', 'Chan'] }, { ID: 'aCloud', Name: ['Mary', 'Cheung']}];
    $("#item_data").tmpl(users,
        {
        getName: function (spr) {
           return this.data.Name.join(spr);
        }
        }).appendTo('#div_item_data');
    </script> $.tmplItem() 使用这个方法，可以获取从render出来的元素上重新获取$item <script type="text/javascript">
    　　$('#demo').delegate('div', 'click', function () {
            var item = $.tmplItem(this);
            alert(item.data.Name);
        });
    </script> 最后总结 其实在使用过程当中并不会经常运用到模版的一些高级功能，本文章也仅仅是介绍了一些关于jQuery-tmpl的基础性的东西。使用这个插件能够给我们带来的好处实在不少。 之前我在动态输出HTML代码段的时候（在JS文件中拼接字符串）经常修改了前台页面而忘记修改JS中的拼接字符串，导致经常出些莫名其妙的错误，而且在多个分支判断下拼接字符串的劣处体现的更加明显，现在的话我会把Tmpl模版的代码就放在前台页面要生成代码的地方，这样就大大减少了错误的发生啦！ 相关链接
     
      
       Github地址：https://github.com/BorisMoore/jquery-tmpl
      
     
      
      
       
     
      
     
      
       
      原文地址：http://www.uedsc.com/jquery-tmpl.html