##一、baiduTemplate 简介
####baiduTemplate希望创造一个用户觉得“简单好用”的JS模板引擎
###1、应用场景: 前端使用的模板系统 或 后端Javascript环境发布页面
###2、功能概述: 提供一套模板语法,用户可以写一个模板区块,每次根据传入的数据, 生成对应数据产生的HTML片段,渲染不同的效果。
###3、特性: 1、语法简单,学习成本极低,开发效率提升很大,性价比较高(使用Javascript原生语法); 2、默认HTML转义(防XSS攻击),并且支持包括URL转义等多种转义; 3、变量未定义自动输出为空,防止页面错乱; 4、功能强大,如分隔符可自定等多种功能;
##二、基本用法
###0、引入文件:
####baiduTemplate使用仅需引入baiduTemplate.js文件,未压缩是考虑大家调错阅读等方便,上线前请自行压缩代码。
<script type="text/javascript" src="./baiduTemplate.js"></script>
####如果想要在nodejs环境中使用,可以通过npm安装
//注意名字全部小写
npm install baidutemplate
###1、放置模板片段:
####页面中,模板块可以放在 <script> 中,设置type属性为text/template或text/html,用id标识,如:
<script id='tpl' type="text/template">
<!-- 模板部分 -->
<!-- 模板结束 -->
</script>
####或者存放在 <textarea> 中,一般情况设置其CSS样式display:none来隐藏掉textarea,同样用id标识,如:
<textarea id='tpl' style='display:none;'>
<!-- 模板部分 -->
<!-- 模板结束 -->
</textarea>
####模板也可以直接存储在一个变量中
var tpl = "<!-- 模板开始 --> 模板内容 <!-- 模板结束 -->";
###2、调用引擎方式
####数据结构是一个JSON,如:
var data={
title:'baiduTemplate',
list:['test1','test2','test3']
}
####baiduTemplate占用baidu.template命名空间
//可以付值给一个短名变量使用
var bt = baidu.template;
####tpl是传入的模板(String类型),可以是模板的id,可以是一个模板片段字符串,传入模板和对应数据返回对应的HTML片段
var html0 = baidu.template(tpl,data);
####或者可以只传入tpl,这时返回的是一个编译后的函数,可以把这个函数缓存下来,传入不同的data就可以生成不同的HTML片段
var fun = baidu.template(tpl);
var html1 = fun(data1);
var html2 = fun(data2);
####最后将他们插入到一个容器中即可
document.getElementById('result0').innerHTML=html0;
document.getElementById('result1').innerHTML=html1;
document.getElementById('result2').innerHTML=html2;
###3、模板基本语法(默认分隔符为<% %>,也可以自定义)
####分隔符内语句为js语法,如:
<% var test = function(){
//函数体
};
if(1){}else{};
function testFun(){
return;
};
%>
####假定事先设置数据为
var data={
title:'baiduTemplate',
list:['test1<script>','test2','test3']
}
####注释
<!-- 模板中可以用HTML注释 --> 或 <%* 这是模板自带注释格式 *%>
<% //分隔符内支持JS注释 %>
####输出一个变量
//默认HTML转义,如果变量未定义输出为空
<%=title%>
//不转义
<%:=title%> 或 <%-title%>
//URL转义,UI变量使用在模板链接地址URL的参数中时需要转义
<%:u=title%>
//UI变量使用在HTML页面标签onclick等事件函数参数中需要转义
//“<”转成“<”、“>”转成“>”、“&”转成“&”、“'”转成“\'”
//“"”转成“\"”、“\”转成“\\”、“/”转成“\/”、\n转成“\n”、\r转成“\r”
<%:v=title%>
//HTML转义(默认自动)
<%=title%> 或 <%:h=title%>
####判断语句
<%if(list.length){%>
<h2><%=list.length%></h2>
<%}else{%>
<h2>list长度为0<h2>
<%}%>
####循环语句
<%for(var i=0;i<list.length;i++){%>
<li><%=list[i]%></li>
<%}%>
###4、不推荐使用功能
####用户可以自定义分隔符,默认为 <% %>,如:
//设置左分隔符为 <!
baidu.template.LEFT_DELIMITER = '<!';
//设置右分隔符为 <!
baidu.template.RIGHT_DELIMITER = '!>';
####用户可以自定义是否自动HTML转义
//设置默认是否自动HTML转义,true为自动转义,false为默认不转义
baidu.template.ESCAPE = false;
##三、使用举例
//index.html
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title>test</title>
<!-- 引入baiduTemplate -->
<script type="text/javascript" src="./baiduTemplate.js"></script>
</head>
<body>
<div id='result'></div>
<!-- 模板1开始,可以使用script(type设置为text/html)来存放模板片段,并且用id标示 -->
<script id="t:_1234-abcd-1" type="text/html">
<div>
<!-- 我是注释,语法均为Javascript原生语法,默认分割符为 <% %> ,也可以自定义,参见API部分 -->
<!-- 输出变量语句,输出title -->
<h1>title:<%=title%></h1>
<!-- 判断语句if else-->
<%if(list.length>1) { %>
<h2>输出list,共有<%=list.length%>个元素</h2>
<ul>
<!-- 循环语句 for-->
<%for(var i=0;i<5;i++){%>
<li><%=list[i]%></li>
<%}%>
</ul>
<%}else{%>
<h2>没有list数据</h2>
<%}%>
</div>
</script>
<!-- 模板1结束 -->
<!-- 使用模板 -->
<script type="text/javascript">
var data={
"title":'欢迎使用baiduTemplate',
"list":[
'test1:默认支持HTML转义,如输出<script>,也可以关掉,语法<:=value> 详见API',
'test2:',
'test3:',
'test4:list[5]未定义,模板系统会输出空'
]
};
//使用baidu.template命名空间
var bt=baidu.template;
//可以设置分隔符
//bt.LEFT_DELIMITER='<!';
//bt.RIGHT_DELIMITER='!>';
//最简使用方法
var html=bt('t:_1234-abcd-1',data);
//渲染
document.getElementById('result').innerHTML=html;
</script>
</body>
</html>
##四、change log
###1.0.5: 修改可能造成内存泄露的变量及方法直接挂在baidu.template命名空间下
###1.0.4: 经过第三方测试反馈,进行对编译后产生的函数性能优化,性能提高1/3以上
###1.0.3: 通过产品线反馈,经过讨论增加自定义是否默认转义接口 baidu.template.ESCAPE
###1.0.2: 优化正则,提升性能,修复bug,支持nodejs,支持npm install baidutemplate可以安装
###1.0.1: 优化正则,提升性能,修复bug