這是我寫的第一個 jQuery 外掛。本來早寫完了,後來看到一份 jQuery 外掛模板(jquery.boilerplate.js),就拿過來套用,於是有了這個版本。
我的背景是 ASP.NET 開發,但公司裡包含美工在內好幾位同事對 JavaScript 並不熟。專案裡的 JS 到處改來改去,最後 myself 都頭大了——曾經有單一頁面寫出六百多行 JavaScript,全部按功能用面向過程硬寫,亂得不堪回首。於是萌生寫外掛的念頭,照著範本畫葫蘆,過程中也順帶把 JavaScript 的物件導向補起來,對語言特性和效能的認識都深了一層。
外掛取名為 AmSetPager,先來看長相:

這個外掛的用法有點另類:它是呼叫資料展示容器的元素,例如 $("#DataContent").AmSetPager({...}),然後在參數中指定分頁容器的 id。我後來看別人的外掛都是直接呼叫分頁元素,算是本例比較特別的地方。
(function ($, window, document, undefined) {
var pluginName = "AmSetPager",
defaults = {
pagerName: "pager", // 分頁的容器
viewCount: 5, // 每頁顯示幾筆
dataCount: 0, // 後台取資料時的總筆數
selectClass: "selectno", // 選中頁碼的樣式
listCount: 10, // 顯示幾個頁碼(不含上一頁、下一頁)
enablePrevNext: true, // 是否顯示上一頁/下一頁
enableFirst: true, // 只有一頁時是否仍顯示頁碼
template: "default", // 範本(目前只有 default)
mode: "static", // "url" 或 "ajax"
urlparameter: "", // url 模式下的既有參數,如 aa=1&bb=2
callback: null // 回呼函式,ajax 或自訂靜態處理時使用
};
註:listCount 在 default 範本下需設為 5 以上。
function Plugin(element, options) {
this.element = element;
this.options = $.extend({}, defaults, options);
this._name = pluginName;
this.init();
}
$.extend({}, defaults, options) 是外掛接參數的標準做法:以空物件為基底,先鋪預設值,再用使用者傳入的 options 覆蓋,且不會污染 defaults 本身。
// 取得網址參數
var getQueryString = function (name) {
var reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)", "i");
var r = window.location.search.substr(1).match(reg);
if (r != null) return unescape(r[2]);
return undefined;
};
// 靜態資料的顯示/隱藏
var Bind_StaticData = function ($content, minnum, maxnum) {
if (minnum > 0) {
$content.children(":gt(" + (minnum - 1) + "):lt(" + maxnum + ")")
.css("display", "block");
} else {
$content.children(":lt(" + maxnum + ")").css("display", "block");
}
$content.children(":lt(" + (minnum) + ")").css("display", "none");
$content.children(":gt(" + (maxnum - 1) + ")").css("display", "none");
};
var SetPager = function (options, pageCount) {
this.op = options;
this.pageCount = pageCount;
};
SetPager.prototype = {
// 格式化為 a 元素
FormatStr: function (pageNo, pageText) {
var href = this.op.mode == 'url'
? location.pathname + "?" + this.op.urlparameter + "&p=" + pageNo
: "javascript:void(0);";
if (typeof (pageText) == "number") {
return "<a href='" + href + "'>" + pageText + "</a>";
}
return "<a href='" + href + "' i='" + pageNo + "'>" + pageText + "</a>";
},
// 目前頁的樣式
FormatStrIndex: function (pageNo) {
return "<span class='" + this.op.selectClass + "'>" + pageNo + "</span>";
},
// 預設範本:初始化頁碼陣列
InitDefaultList: function (_pageIndex) {
if (this.op.listCount < 5)
throw new Error("listCount must be lager than 5");
var pageIndex = parseFloat(_pageIndex);
var ns = new Array();
var numList = new Array(this.op.listCount);
if (pageIndex >= this.op.listCount) {
numList[0] = 1;
numList[1] = "…";
var infront = 0, inback = 0;
var inflag = Math.floor((this.op.listCount - 2) / 2);
if (this.op.listCount % 2 == 0) {
infront = inflag - 1;
inback = inflag;
} else {
infront = inflag;
inback = inflag;
}
if (pageIndex + inback >= this.pageCount) {
for (i = this.pageCount - (this.op.listCount - 3); i < this.pageCount + 1; i++) {
ns.push(i);
}
for (j = 0; j <= (this.op.listCount - 3); j++) {
numList[j + 2] = ns[j];
}
}
for (i = pageIndex - infront; i <= pageIndex + inback; i++) {
ns.push(i);
}
for (j = 0; j < (this.op.listCount - 2); j++) {
numList[j + 2] = ns[j];
}
} else {
if (this.pageCount >= this.op.listCount) {
for (i = 0; i < this.op.listCount; i++) { numList[i] = i + 1; }
} else {
for (i = 0; i < this.pageCount; i++) { numList[i] = i + 1; }
}
}
return numList;
},
// 輸出頁碼
InitPager: function (pageIndex) {
$("#" + this.op.pagerName).html('');
if (this.op.enableFirst == false && this.pageCount <= 1) {
return null;
}
var array = new Array();
var $con = $("#" + this.op.pagerName);
switch (this.op.template) {
case 'default':
array = this.InitDefaultList(pageIndex, this.pageCount); break;
default:
array = this.InitDefaultList(pageIndex, this.pageCount);
}
if (!(array instanceof Array)) { throw new Error("is not array"); }
if (array.length != this.op.listCount) {
throw new Error("array.length error:" + array.length);
}
if (pageIndex > 1 && this.op.enablePrevNext) {
$con.append(this.FormatStr(pageIndex - 1, '上一頁'));
}
for (var i = 0; i < array.length; i++) {
if (typeof array[i] == 'undefined') { continue; }
if (pageIndex == array[i]) {
$con.append(this.FormatStrIndex(array[i]));
} else if (typeof array[i] == 'number') {
$con.append(this.FormatStr(array[i], array[i]));
} else {
$con.append(array[i]); // 省略號
}
}
if (pageIndex < this.pageCount && this.op.enablePrevNext) {
$con.append(this.FormatStr(pageIndex + 1, '下一頁'));
}
}
};
Plugin.prototype = {
init: function () {
var options = this.options;
var $thisbase = $(this.element);
var $content;
// 若容器帶有 tbody,資料範圍取其子元素;否則視容器本身為資料
if ($thisbase.is(':has(tbody)')) {
$content = $thisbase.children();
} else {
$content = $thisbase;
}
var count = options.mode == 'static'
? $content.children().length
: options.dataCount;
var eachcount = options.viewCount;
var totalpage = Math.ceil(count / eachcount);
var $pager = $("#" + options.pagerName);
var setpager = new SetPager(options, totalpage);
if (options.mode == 'url') {
var urlindex = getQueryString("p");
if (isNaN(urlindex)) {
setpager.InitPager(1);
} else {
setpager.InitPager(urlindex > totalpage ? totalpage : urlindex);
}
} else {
setpager.InitPager(1);
if (options.mode == 'static' && typeof options.callback != 'function') {
Bind_StaticData($content, 0, eachcount);
} else {
options.callback($content, 1, options.viewCount);
}
$pager.bind("click", function (e) {
if (e.target.tagName != 'A') return;
var $this = $(e.target);
$this.removeAttr("href").siblings().attr("href", "javascript:void(0);");
var indexnum = parseInt($this.html()) == $this.html()
? parseInt($this.html())
: parseInt($this.attr('i'));
var maxnum = indexnum * eachcount;
var minnum = (indexnum - 1) * eachcount;
if (options.mode != 'static' && options.mode != 'ajax') {
throw new Error("mode must be selected:static,url,ajax");
}
if (options.mode == 'static' && typeof options.callback != 'function') {
setpager.InitPager(indexnum);
Bind_StaticData($content, minnum, maxnum);
} else {
setpager.InitPager(indexnum);
options.callback($content, indexnum, options.viewCount);
}
});
}
}
};
$.fn[pluginName] = function (options) {
return this.each(function () {
if (!$.data(this, "plugin_" + pluginName)) {
$.data(this, "plugin_" + pluginName, new Plugin(this, options));
}
});
};
})(jQuery, window, document);
$.fn[pluginName] 是把外掛掛到 jQuery 原型上的關鍵一行;用 $.data() 記錄實例則能避免同一元素被重複初始化。這兩個寫法都直接來自 jquery.boilerplate.js 範本。
<style type="text/css">
.pager a {
text-decoration: none;
border: 1px solid #e7ecf0;
color: #15B;
}
.pager a:hover { background-color: #E6EBEF }
.pager a, .pager span {
display: inline-block;
padding: 0.1em 0.4em;
margin-right: 5px;
margin-bottom: 5px;
}
.selectno {
background: #26B;
color: #fff;
border: 1px solid #AAE;
}
</style>
模式一:靜態資料(static)——所有資料都在頁面上,靠顯示隱藏切頁。
<table id="tablepager" border="0" cellpadding="0" cellspacing="0"> <tr><td><p>1aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>2aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>3aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>4aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>5aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>6aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>7aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>8aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> <tr><td><p>9aaaaaaaaaaaaaaaaaaaaaa</p></td></tr> </table> <div id="pager" class="pager"></div>
$(function () {
$("#tablepager").AmSetPager({
"viewCount": 2,
"mode": "static",
"listCount": 6
});
});
靜態模式也可以自訂 callback,寫法與下面 ajax 模式相同。

模式二:ajax 分頁取資料——表格 initially 是空的,每頁向後端要資料。
<table id="tablepager" border="0" cellpadding="0" cellspacing="0"></table> <div id="pager" class="pager"></div>
後端範例(ASHX 一般處理常式):
public void ProcessRequest(HttpContext context) {
context.Response.ContentType = "text/plain";
int index = int.Parse(context.Request.QueryString["index"]);
int viewCount = int.Parse(context.Request.QueryString["viewCount"]);
List<string> list = new List<string>();
for (int i = 1; i <= viewCount; i++) {
list.Add(index + "_" + i + "....................");
}
JavaScriptSerializer ser = new JavaScriptSerializer();
context.Response.Write(ser.Serialize(list));
context.Response.End();
}
前端:
<script type="text/javascript">
$(function () {
$("#tablepager").AmSetPager({
"viewCount": 3,
"mode": "ajax",
"dataCount": 30,
"listCount": 6,
"callback": function (ev, indexnum, viewCount) {
// 三個參數分別為:資料容器物件、目前頁、每頁筆數
$.getJSON("Handler1.ashx", {
"index": indexnum,
"viewCount": viewCount
}, function (data) {
ev.html('');
for (var i = 0; i < data.length; i++) {
ev.append("<tr><td>" + data[i] + "</td></tr>");
}
});
}
});
});
</script>

模式三:網址參數分頁(url)——頁碼寫進網址,重新整理後仍停在同頁。
$(function () {
$("#tablepager").AmPager({
"viewCount": 5,
"dataCount": 50,
"mode": "url",
"listCount": 6,
"urlparameter": "ss=1&ee=2"
});
});
urlparameter 是原本網址上既有的參數,此外還必須設定每頁筆數與總筆數。點擊頁碼 3 之後,網址會變成 test.htm?ss=1&ee=2&p=3。
坦白說程式碼寫得有點臃腫,好幾處設計並不合理。例如 Bind_StaticData() 連續呼叫四次 children() 做顯示隱藏,其實可以合併成一次判斷;頁碼產生用了大量 new Array() 與手寫迴圈,用 $.map() 會短很多;把 a 的 href 寫成 javascript:void(0); 也不是好做法,改用 button 或加上 role 屬性對無障礙更友善。另外,靜態模式下的 parseInt($this.html()) 直接拿 innerHTML 當頁碼解析,一旦頁碼內容夾帶標籤就會出錯,用自訂屬性存頁碼才是穩健做法。
歡迎下載試用並給意見,讓一個菜鳥能慢慢成長。