1、入門實例
首先我們來看一個簡單模板:
<script type="template" id="template">
<h2>
<a href="{{href}}">
{{title}}
</a>
</h2>
<img src="{{imgSrc}}" alt="{{title}}">
</script>
其中被{{ xxx }}包含的就是我們要替換的變量。
接著我們可能通過ajax或者其他方法獲得數據。這裡我們自己定義了數據,具體如下:
var data = [
{
title: "Create a Sticky Note Effect in 5 Easy Steps with CSS3 and HTML5",
href: "http://net.tutsplus.com/tutorials/html-css-techniques/create-a-sticky-note-effect-in-5-easy-steps-with-css3-and-html5/",
imgSrc: "https://d2o0t5hpnwv4c1.cloudfront.net/771_sticky/sticky_notes.jpg"
},
{
title: "Nettuts+ Quiz #8",
href: "http://net.tutsplus.com/articles/quizzes/nettuts-quiz-8-abbreviations-darth-sidious-edition/",
imgSrc: "https://d2o0t5hpnwv4c1.cloudfront.net/989_quiz2jquerybasics/quiz.jpg"
}
];
ok,現在的問題就是我們怎麼把數據導入到模板裡面呢?
第一種大家會想到的就是采用replace直接替換裡面的變量:
template = document.querySelector('#template').innerHTML,
result = document.querySelector('.result'),
i = 0, len = data.length,
fragment = '';
for ( ; i < len; i++ ) {
fragment += template
.replace( /\{\{title\}\}/, data[i].title )
.replace( /\{\{href\}\}/, data[i].href )
.replace( /\{\{imgSrc\}\}/, data[i].imgSrc );
}
result.innerHTML = fragment;
第二種的話,相對第一種比較靈活,采用的是正則替換,對於初級前端,很多人對正則掌握的並不是很好,一般也用的比較少。具體實現如下:
template = document.querySelector('#template').innerHTML,
result = document.querySelector('.result'),
attachTemplateToData;
// 將模板和數據作為參數,通過數據裡所有的項將值替換到模板的標簽上(注意不是遍歷模板標簽,因為標簽可能不在數據裡存在)。
attachTemplateToData = function(template, data) {
var i = 0,
len = data.length,
fragment = '';
// 遍歷數據集合裡的每一個項,做相應的替換
function replace(obj) {
var t, key, reg;
//遍歷該數據項下所有的屬性,將該屬性作為key值來查找標簽,然後替換
for (key in obj) {
reg = new RegExp('{{' + key + '}}', 'ig');
t = (t || template).replace(reg, obj[key]);
}
return t;
}
for (; i < len; i++) {
fragment += replace(data[i]);
}
return fragment;
};
result.innerHTML = attachTemplateToData(template, data);
與第一種相比較,第二種代碼看上去多了,但是功能實則更為強大了。第一種我們需要每次重新編寫變量名,如果變量名比較多的話,會比較麻煩,且容易出錯。第二種的就沒有這些煩惱。
2、模板引擎相關知識
通過上面的例子,大家對模板引擎應該有個初步的認識了,下面我們來講解一些相關知識。
2.1 模板存放
模板一般都是放置到 textarea/input 等表單控件,或者 script 等標簽中。比如上面的例子,我們就是放在 script 標簽上的。
2.2 模板獲取
一般都是通過ID來獲取,document.getElementById(“ID”):
//textarea或input則取value,其它情況取innerHTML
var html = /^(textarea|input)$/i.test(element.nodeName) ? element.value : element.innerHTML;
上面的是通用的模板獲取方法,這樣不管你是放在 textarea/input 還是 script 標簽下都可以獲取到。
2.3 模板函數
一般都是templateFun("id", data);其中id為存放模板字符串的元素id,data為需要裝載的數據。
2.4 模板解析編譯
模板解析主要是指將模板中 JavaScript 語句和 html 分離出來,編譯的話將模板字符串編譯成最終的模板。上面的例子比較簡單,還沒有涉及到模板引擎的核心。
2.5 模板解析編譯
要指出的是,不同的模板引擎所用的分隔符可能是不一樣,上面的例子用的是{{ }},而Jquery tmpl 使用的是<% %>。
3、jQuery tmpl 實現原理解析
jQuery tmpl是由jQuery的作者寫的,代碼短小精悍。總共20多行,功能卻比我們上面的強大很多。我們先來看一看源碼:
(function(){
var cache = {};
this.tmpl = function tmpl(str, data){
var fn = !/\W/.test(str) ?
cache[str] = cache[str] ||
tmpl(document.getElementById(str).innerHTML) :
new Function("obj",
"var p=[],print=function(){p.push.apply(p,arguments);};" +
"with(obj){p.push('" +
str
.replace(/[\r\t\n]/g, " ")
.split("<%").join("\t")
.replace(/((^|%>)[^\t]*)'/g, "$1\r")
.replace(/\t=(.*?)%>/g, "',$1,'")
.split("\t").join("');")
.split("%>").join("p.push('")
.split("\r").join("\\'")
+ "');}return p.join('');");
return data ? fn( data ) : fn;
};
})();
初看是不是覺得有點懵,完全不能理解的代碼。沒事,後面我們會對源碼進行解釋的,我們還是先看一下所用的模板
<ul>
<% for ( var i = 0; i < users.length; i++ ) { %>
<li><a href="<%=users[i].url%>"><%=users[i].name%></a></li>
<% } %>
</ul>
可以發現,這個模板比入門例子的模板更為復雜,因為裡面還夾雜著 JavaScript 代碼。JavaScript 代碼采用 <% %> 包含。而要替換的變量則是用 <%= %> 分隔開的。
下面我再來對代碼做個注釋。不過即使看了注釋,你也不一定能很快理解,最好的辦法是自己實際動手操作一遍。
// 代碼整個放在一個立即執行函數裡面
(function(){
// 用來緩存,有時候一個模板要用多次,這時候,我們直接用緩存就會很方便
var cache = {};
// tmpl綁定在this上,這裡的this值得是window
this.tmpl = function tmpl(str, data){
// 只有模板才有非字母數字字符,用來判斷傳入的是模板id還是模板字符串,
// 如果是id的話,判斷是否有緩存,沒有緩存的話調用tmpl;
// 如果是模板的話,就調用new Function()解析編譯
var fn = !/\W/.test(str) ?
cache[str] = cache[str] ||
tmpl(document.getElementById(str).innerHTML) :
new Function("obj",
// 注意這裡整個是字符串,通過 + 號拼接
"var p=[],print=function(){p.push.apply(p,arguments);};" +
"with(obj){p.push('" +
str
// 去除換行制表符\t\n\r
.replace(/[\r\t\n]/g, " ")
// 將左分隔符變成 \t
.split("<%").join("\t")
// 去掉模板中單引號的干擾
.replace(/((^|%>)[^\t]*)'/g, "$1\r")
// 為 html 中的變量變成 ",xxx," 的形式, 如:\t=users[i].url%> 變成 ',users[i].url,'
// 注意這裡只有一個單引號,還不配對
.replace(/\t=(.*?)%>/g, "',$1,'")
// 這時候,只有JavaScript 語句前面才有 "\t", 將 \t 變成 ');
// 這樣就可把 html 標簽添加到數組p中,而javascript 語句 不需要 push 到裡面。
.split("\t").join("');")
// 這時候,只有JavaScript 語句後面才有 "%>", 將 %> 變成 p.push('
// 上一步我們再 html 標簽後加了 ');, 所以要把 p.push(' 語句放在 html 標簽放在前面,這樣就可以變成 JavaScript 語句
.split("%>").join("p.push('")
// 將上面可能出現的干擾的單引號進行轉義
.split("\r").join("\\'")
// 將數組 p 變成字符串。
+ "');}return p.join('');");
return data ? fn( data ) : fn;
};
})();
上面代碼中,有一個要指出的就是new Function 的使用 方法。給 new Function() 傳一個字符串作為函數的body來構造一個 JavaScript函數。編程中並不經常用到,但有時候應該是很有用的。
下面是 new Function 的基本用法:
// 最後一個參數是函數的 body(函數體),類型為 string;
// 前面的參數都是 索要構造的函數的參數(名字)
var myFunction = new Function('users', 'salary', 'return users * salary');
最後的字符串就是下面這種形式:
var p = [],
print = function() {
p.push.apply(p, arguments);
};
with(obj) {
p.push(' <ul> ');
for (var i = 0; i < users.length; i++) {
p.push(' <li><a href="', users[i].url, '">', users[i].name, '</a></li> ');
}
p.push(' </ul> ');
}
return p.join('');
裡面的 print 函數 在我們的模板裡面是沒有用到的。
要指出的是,采用 push 的方法在 IE6-8 的浏覽器下會比 += 的形式快,但是在現在的浏覽器裡面, += 是拼接字符串最快的方法。實測表明現代浏覽器使用 += 會比數組 push 方法快,而在 v8 引擎中,使用 += 方式比數組拼接快 4.7 倍。所以 目前有些更高級的模板引擎會 根據 javascript 引擎特性采用了兩種不同的字符串拼接方式。
下面的代碼是摘自騰訊的 artTemplate 的, 根據浏覽器的類型來選擇不同的拼接方式。功能越強大,所考慮的問題也會更多。
var isNewEngine = ''.trim;// '__proto__' in {}
var replaces = isNewEngine
? ["$out='';", "$out+=", ";", "$out"]
: ["$out=[];", "$out.push(", ");", "$out.join('')"];
挑戰:有興趣的可以改用 += 來實現上面的代碼。
總結
模板引擎原理總結起來就是:先獲取html中對應的id下得innerHTML,利用開始標簽和關閉標簽進行字符串切分,其實是將模板劃分成兩部份內容,一部分是html部分,一部分是邏輯部分,通過區別一些特殊符號比如each、if等來將字符串拼接成函數式的字符串,將兩部分各自經過處理後,再次拼接到一起,最後將拼接好的字符串采用new Function()的方式轉化成所需要的函數。
目前模板引擎的種類繁多,功能也越來越強大,不同模板間實現原理大同小異,各有優缺,請按需選擇。