js模板引擎mustache介绍及实例

121 篇文章 3 订阅

亲测可用,若有疑问请私信

在Javascript中 mustache.js是实现mustache模板系统。

Mustache是一种没有逻辑的模板语法。它可以应用于HTML、配置文件、源代码等任何地方。 它通过使用散列或对象中提供的值在模板中展开标记来工作。

我们称它为没有逻辑的模板,是因为它没有if语句、else子句和for循环,它只有标签。一些标签被替换为值或什么也没有或者一系列的值

不能在模板中使用else if做逻辑判断,我们可以在数据传入之前对数据做逻辑操作

我们在那使用mustache.js

你可以在任何可以使用JavaScript的地方使用mustache.js来渲染mustache模板。包括web浏览器、服务器环境(node)。

语法

  • 模板以{{}}包裹住内容,格式中写入的是模板的内容。 被替换的内容字段使用双花括号包裹起来。
  • 插值表达式:双花括号{{}} 包裹替换的字段
  • {{#prop-name}}{{/prop-name}}用作for循环渲染,当prop-name的值为非空数组时,mustach不会遍历该数组,渲染出个数和该数组长度相等的DOM元素
  • 也可以用作if-else判断。{{#prop-name}}{{/prop-name}}和{{^prop-name}}{{/prop-name}}两组标签结合使用,当prop-name的值存在且不为false时,会渲染{{#prop-name}}{{/prop-name}}的内容,否则渲染{{^prop-name}}{{/prop-name}}的内容
 
 
  1. <script id="template" type="x-tmpl-mustache">

  2. {{name}}

  3. </script>

  4. <script type="text/javascript">

  5. var template = $("#template").html();

  6. //name值为函数返回值

  7. var r = Mustache.render(template,{

  8. name:function(){

  9. return 'abc' //abc会替换双花括号内name

  10. }

  11. })

  12. //name值为字符串

  13. var r = Mustache.render(template,{name:'wan'}) //字符串wan会替换双花括号内的name

  14. </script>

我们注意到上面代码render的第二个参数都是一个对象(变量和函数都是对象),第二个参数我们通常都会使用对象类型,传入一个对象,在模板中书写对象属性,可以渲染出对象的值。 但也可以是其它类型如 数组、字符串类型、数字,如下:

 
 
  1. <script id="template" type="x-tmpl-mustache">

  2. {{.}}

  3. </script>

  4. <script type="text/javascript">

  5. function loadUser(){

  6. var template = $("#template").html();

  7. var r = Mustache.render(template,'wan') //渲染出wan

  8. //或

  9. var r = Mustache.render(template,[1,d,3]) //渲染出1,d,3

  10. //或

  11. var r = Mustache.render(template,1) //渲染出1

  12. }

  13. </script>

我们可以看到如果第二个参数是其它类型,那么在模板中双花括号内就用点.来表示,使用起来不方便。 一般在项目中很少会传入其它类型。

对象属性值为数组时 实现forEach遍历数组渲染DOM

 
 
  1. //页面部分

  2. <div id="target">Loading</div>

  3. //模板

  4. <script id="template" type="x-tmpl-mustache">

  5. <ul>

  6. {{#list}}

  7. <li>

  8. <span>{{name}}</span>

  9. <span>{{age}}</span>

  10. <span>{{job}}</span>

  11. </li>

  12. {{/list}}

  13. </ul>

  14. </script>

  15. //js部分

  16. <script type="text/javascript">

  17. var template = $("#template").html();

  18. var r = Mustache.render(template,{

  19. list:[

  20. {name:'wannianqing',age:18,job:'The Front End'},

  21. {name:'wangxiaosan',age:19,job:'java'},

  22. {name:'lixiaosi',age:20,job:'The Front End'},

  23. {name:'sunxiaowu',age:21,job:'java'}

  24. ]

  25. })

  26. $("#target").html(r)

  27. </script>

用作if-else,属性无论是显示还是隐式转换为boolean类型,true时渲染{{#prop-name}} false时渲染{{^prop-name}}

 
 
  1. //页面部分

  2. <div id="target">Loading</div>

  3. //模板

  4. <script id="template" type="x-tmpl-mustache">

  5. {{#isShow}}一{{/isShow}}

  6. {{^isShow}}二{{/isShow}}

  7. </script>

  8. //js部分

  9. <script type="text/javascript">

  10. var template = $("#template").html();

  11. var r = Mustache.render(template,{isShow:true}); //isShow存在且为布尔值true时,显示 “一”

  12. var r = Mustache.render(template,{isShow:false}); //isShow存在且为布尔值true时,显示 “二”

  13. var r = Mustache.render(template,{}); //isShow不存在时,显示 “二”

  14. var r = Mustache.render(template,{isShow:[]}); //isShow存在,为空数组时,显示 “二”

  15. var r = Mustache.render(template,{isShow:undefined}); //isShow存在,为undefined时,显示 “二”

  16. var r = Mustache.render(template,{isShow:null}); //isShow存在,为null时,显示 “二”

  17. $("#target").html(r)

  18. </script>

实际使用

用一个唯一id的script标签包裹模板内容,type类型为text/template

<script id="template" type="text/template"></script>

使用原生javascript方法或者jquery方法获得唯一id的script标签的html内容

var template = document.getElementById('template').innerHTML.trim();
//或
var template = $("#template").html();

使用mustache的render方法处理模板后填充到目标位置

var rendered = Mustache.render(template,obj);
$('#target').html(rendered)

完整代码如下:

 
 
  1. <!DOCTYPE html>

  2. <html lang="en">

  3. <head>

  4. <meta charset="UTF-8">

  5. <title>Document</title>

  6. </head>

  7. <body "loadUser()">

  8. <div id="target">Loading</div>

  9. <script id="template" type="x-tmpl-mustache">

  10. Hello {{}}~

  11. <ul>

  12. {{#list}}

  13. <li>{{name}}</li>

  14. {{/list}}

  15. </ul>

  16. </script>

  17. <script type="text/javascript" src="js/jquery-2.1.0.min.js"></script>

  18. <script type="text/javascript" src="js/mustache.js"></script>

  19. <script type="text/javascript">

  20. function loadUser(){

  21. var template = $("#template").html();

  22. var obj = {

  23. list:[

  24. {name:'wan'},

  25. {name:'wan'},

  26. {name:'wan'}

  27. ]

  28. }

  29. var rendered = Mustache.render(template,obj);

  30. $('#target').html(rendered)

  31. }

  32. </script>

  33. </body>

  34. </html>

上面示例是内部文件使用mustache模板引擎,我们还可以引入外部模板引擎来渲染页面。

首先我们在HTML文档中引入jquery.mustache.js文件配合mustache使用,jquery.mustache.js是jQuery做了一层封装,提供了集中方法让我们更方便使用mustache做模板渲染。 此处我们使用它的.load方法从指定路径加载模板文件,加载成功后使用$.Mustache.render()处理模板渲染页面。

$.Mustache
    .load('./mustache/demo2.mustache')
    .done(function(){
        $("#target").html($.Mustache.render('demo2',{name:'wan'}))
    })
下面我们来看一个完整的案例
 
 
  1. <!DOCTYPE html>

  2. <html lang="en">

  3. <head>

  4. <meta charset="UTF-8">

  5. <title>Document</title>

  6. </head>

  7. <body>

  8. <div id="target">Loading</div>

  9. <script type="text/javascript" src="js/jquery-2.1.0.min.js"></script>

  10. <script type="text/javascript" src="js/mustache.js"></script>

  11. <script type="text/javascript" src="js/jquery.mustache.js"></script>

  12. <script type="text/javascript">

  13. //要传入的数据

  14. var objData = {

  15. list:[

  16. {name:'wannianqing',age:18,job:'The Front End'},

  17. {name:'wangxiaosan',age:19,job:'java'},

  18. {name:'lixiaosi',age:20,job:'The Front End'},

  19. {name:'sunxiaowu',age:21,job:'java'}

  20. ]

  21. }

  22. //加载模板方法

  23. function loadTemplateMustache(mustacheName,targetId,templateId,data){

  24. //模板路径

  25. var mustacheDir = './mustache/'+mustacheName+'.mustache';

  26. //渲染目标容器

  27. var targetContainer = $(targetId);

  28. if(targetContainer.length > 0){

  29. $.Mustache

  30. .load(mustacheDir) //加载模板文件

  31. .done(function(){

  32. //渲染模板

  33. renderTarget(targetContainer,templateId,data)

  34. })

  35. }

  36. }

  37. //渲染模板方法

  38. function renderTarget(dom,templateId,data){

  39. var el = dom;

  40. el.html('');

  41. el.append($.Mustache.render(templateId,data));

  42. }

  43. loadTemplateMustache('demo4','#target','template',objData)

  44. </script>

  45. </body>

  46. </html>

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值