ASP.NET WebForm 的 Repeater 控制項相當好用:給一份 HTML 模板、丟一組資料進去,它就自動把每一筆渲染成一個項目。那麼在純前端、特別是 AJAX 情境中,能不能做出同樣的效果?這個 jQuery.Repeater 插件就是為此而生。
概念很單純:把項模板定義成 HTML,插件接收 JSON 資料源,讀取模板後為每一筆資料複製一份並填入對應欄位值。
<ul id='repeater1'>
<li class='itemtempplate'>{列名}</li>
</ul>
帶有 itemtempplate class 的元素就是模板本身,{列名} 是佔位符。渲染時插件會把模板隱藏起來作為樣板,實際輸出的是填好值的複製品。
{tablename:"表名", rows:[{"列1":"值1"}, {"列2":"值2"} ... {"列n":"值n"}]}
為了讓後續的佔位符替換寫起來順手,先為 String 加上兩個輔助方法:
// 擴充 String
String.prototype.trim = function() {
return this.replace(/(^\s*)|(\s*$)/g, "");
}
String.prototype.Replace = function (str1, str2){
var rs = this.replace(new RegExp(str1, "gm"), str2);
return rs;
}
// 將 json 資料轉為物件
function jsonStringToDataTable(jsondata){
try{
var table = eval("(" + jsondata + ")");
return table;
}
catch(ex){
return null;
}
}
由於部分瀏覽器(如 Firefox)不支援 outerHTML,特別寫了一個 toHTML 小插件來統一介面:
// 取自身 HTML 原始碼的插件
jQuery.fn.extend({
toHTML: function(){
var obj = $(this[0]);
if(obj[0].outerHTML){
return obj[0].outerHTML;
}
else{
if($('.houfeng-hidearea') == null || $('.houfeng-hidearea')[0] == null ){
$('body').append("<div class='houfeng-hidearea' style='display:none;'></div>");
}
$('.houfeng-hidearea').css('display','none');
$('.houfeng-hidearea').html('');
obj.clone(true).prependTo('.houfeng-hidearea');
var rs = $('.houfeng-hidearea').html();
$('.houfeng-hidearea').html('');
return rs;
}
}
});
思路是:把元素複製到一個隱藏的暫存容器裡,讀完 innerHTML 再清空。這樣就能在不依賴 outerHTML 的環境下取得相同結果。
jQuery.fn.extend({
Repeater: function(val, ItemCreatedCallBack){ // 設置或取得資料源
this.each(function(){
if(val == null || val == undefined){ // 參數為空則回傳既有資料
return $(this).data("_DataSrc");
}
else{ // 不為空則設置資料源
try{
var valtype = (typeof val).toString();
if(valtype == 'string')
val = jsonStringToDataTable(val).rows;
}catch(ex){ return ; }
var domtype = $(this).find(".itemtemplate").attr('nodeName'); // 找出元素類型
if($(this).data("_ItemTemplate") == null ){
$(this).data("_ItemTemplate", $(this).find(".itemtemplate").toHTML());
$(this).find(".itemtemplate").remove();
}
var TrContentTemplate = $(this).data("_ItemTemplate");
var fileds = ____FindFiled(TrContentTemplate); // 找出所有欄位
if(fileds == null) return false;
var filedscount = fileds.length;
$(this).data("_DataSrc", val); // 資料存入緩存
var count = val.length;
for(var i = 0; i < count; i++){
var NewTrContent = TrContentTemplate;
// 先把佔位符換成不會與內容衝突的中間形式
NewTrContent = NewTrContent.Replace("{{", "{#");
NewTrContent = NewTrContent.Replace("}}", "#}");
for( var j = 0; j < filedscount; j++){
NewTrContent = NewTrContent.Replace("{" + fileds[j] + "}", val[i][fileds[j].trim()]);
}
NewTrContent = NewTrContent.Replace("{#", "{");
NewTrContent = NewTrContent.Replace("#}", "}");
var area = $(this).find('tbody');
if(area == null) area = $(this);
area.append(NewTrContent);
if(ItemCreatedCallBack != null){
ItemCreatedCallBack($(this).find(domtype + ":last"));
}
}
$(this).RepeaterSetItemClass($(this).data("_class1"), $(this).data("_class2"), $(this).data("_hoverClass"));
}
});
},
RepeaterClear: function (){ // 清除資料
this.each(function(){
if($(this).data("_ItemTemplate") == null ){
$(this).data("_ItemTemplate", $(this).find(".itemtemplate").toHTML());
}
$(this).find(".itemtemplate").remove();
});
},
RepeaterSetItemClass: function (class1, class2, hoverClass){ // 列樣式
this.each(function(){
if(class1 == null || class2 == null || hoverClass == null) return;
$(this).data("_class1", class1);
$(this).data("_class2", class2);
$(this).data("_hoverClass", hoverClass);
if($(this).data("_DataSrc") != null ){
var domtype = $(this).find(".itemtemplate").attr('nodeName');
$(this).find(domtype).addClass(class1);
$(this).find(domtype + ":nth-child(even)").addClass(class2); // 隔行變色
// 滑鼠移入時的顏色變化
$(this).find(domtype).hover(
function(){ $(this).addClass(hoverClass); },
function(){ $(this).removeClass(hoverClass); }
);
}
});
}
});
// 找出欄位的公共方法
function ____FindFiled(str){
var myRegex = new RegExp("\{.+?\}", "gim");
var arr = str.match(myRegex);
if(arr == null) return null;
var count = arr.length;
for( var i = 0; i < count; i++)
{
arr[i] = arr[i].Replace("{", "").Replace("}", "");
}
return arr;
}
$('repeater1').Repeager(data, [ItemCreatedCallBack]);
ItemCreatedCallBack 是可選參數,相當於「項目建立完成」事件,每一筆渲染完就觸發一次,回傳剛建立好的那個項目。
答案就在 ItemCreatedCallBack 這個回呼裡。做法是:外層渲染完成每一項後,回呼會拿到該項的參照,接著在回呼中取出子層需要的資料,再對子容器呼叫一次 Repeater。模板上有個約定——每多一層巢狀,佔位符就多一層大括號,如此才能避免內外層的欄位名互相干擾。
Demo 模板:
<div id="repeager1">
<div class='itemtemplate'>
<b>{列名}</b>
<ul class="subrepeager">
<!-- 每多一層嵌套,就多一層大括號 -->
<li class='itemtemplate'>{{列名}}</li>
</ul>
</div>
</div>
Demo 腳本:
$(function(){
$('repeater1').Repeager(data, itemCreate);
});
function itemCreate(x){
// 在此綁定子 repeater
// 參數 x 是父 repeater 的項目參照,型別為 jQuery 物件
// 透過 x 取得子 repeater 要用的資料與資料源,然後在此綁定
}
這份程式碼寫得不算工整,但邏輯直白、註解齊全,作為理解「模板 + 資料 → DOM」這個通用模式相當合適。若要投入正式專案,建議把 eval() 換成 JSON.parse(),並留意 String.prototype 的擴充在多人協作時可能造成的命名衝突。
作者:houfeng 出處:https://houfeng.cnblogs.com