DIV CSS 佈局教程網

深入解析 MVC 分頁實踐:自製 shenniu.pager.js 外掛完整教學
編輯:關於JavaScript     

這段時間行程排得比較滿。先是忙公司手機端的接口專案,從開發、聯調到上線,目前基本已經穩定運行。雖然工作繁忙,但還是抽空推動了兩件自己覺得有價值的事情。

第一件是用 ASP.NET Core 做了一個個人線上專案,技術組合是 ASP.NET Core 1.0.0 + Redis + PostgreSQL,再搭配一個 TaskMainForm 服務。這個專案後續會整理開源,方便大家一起交流學習。第二件是正在開發的後台管理框架「一葉子」,剛好把其中的 JS 分頁外掛 shenniu.pager.js 寫完,整體效果自己還算滿意,這也是本文要分享的重點。

本文將涵蓋的內容

  • 為什麼選擇 JS 分頁,以及實際效果預覽
  • 在 View 中如何呼叫,並附上後台實作方法
  • 以開發者視角逐段解讀 shenniu.pager.js

接下來就一步一腳印地展開。

一、為什麼選 JS 分頁

先回顧 MVC 專案裡常見的兩種分頁思路:跳轉分頁與 Ajax 分頁。

跳轉分頁的做法是讓頁面重定向到指定 URL,並在網址上帶入分頁所需參數,後端取回資料後再用 Model 綁定呈現。這種方式每次翻頁都要重新載入整個頁面,體驗上打了折扣。

Ajax 分頁則是透過非同步請求呼叫接口,拿到資料後直接更新頁面上的表格區域,全程不刷新頁面,使用者感受自然順暢得多。本文的外掛走的正是這條路。

先看幾張實際畫面:

圖一:

圖二:

圖三:

靜態截圖能傳達的資訊有限,之後會補上動態圖。真正的關鍵還是在程式碼。

二、在 View 中使用,以及後台方法分享

為了讓畫面好看一些,樣式部分我選用了 Bootstrap 搭配 Ace 主題,效果就是上面幾張圖的樣子。外掛本身以 jQuery 撰寫,因此必須先引入 jquery.js;畫面上的日期選擇框用的是 bootstrap-datepicker.min.js 及其樣式 bootstrap-datepicker3.min.css,因為整體樣式基於 HTML5 設計。相關檔案如下圖:

接著就是本體。我們希望按下「查詢」鈕時呼叫外掛,由外掛去請求後台接口,再把回傳資料綁定到頁面上,程式碼如下:

 var snTool = new shenniuTool(); $("button[id='btnSearch']").on("click", function () { var data = { txtName: $("input[name='txtName']").val(), nStatus: $("select option:selected").val(), dOperateTime: $("input[name='dOperateTime']").val() }; snTool.listFun({ showId: "divShowResult", //內容顯示的div的Id url: "/Menu/Search", data: data, pageSize: 2, //每頁N條 headText: [ { nickName: "全選", name: "Id", colType: "checkbox" }, { nickName: "名稱", name: "Name", colType: "label", isModalHeadText: true }, { nickName: "鏈接", name: "Link" }, { nickName: "狀態", name: "EnableDes" }, { nickName: "操作人", name: "OperatorDes" }, { nickName: "操作時間", name: "OperateTime", format: "yyyy-MM-dd" }, { nickName: "操作", name: "Id", colType: "operate" } ], editeOption: { url: "/Menu/Edit", title: "編輯", height: 500 }, viewOption: { url: "/Menu/Details", title: "查看", height: 500 }, delOption: { url: "/Menu/Delete", title: "刪除", height: 500 }, modalExt: modalExt }); });

其中 url: "/Menu/Search" 指向的就是後台接口,看看後端怎麼寫:

 [HttpGet] public JsonResult Search() { var moPageResult = new StageModel.MoPageResult<dynamic>(); try { var txtName = Request.Params["txtName"]; var nStatus = string.IsNullOrWhiteSpace(Request.Params["nStatus"]) ? -1 : Convert.ToInt32(Request.Params["nStatus"]); var dOperateTime = string.IsNullOrWhiteSpace(Request.Params["dOperateTime"]) ? Convert.ToDateTime("1991-01-01") : Convert.ToDateTime(Request.Params["dOperateTime"]); var data = db.MoMenus.AsQueryable(); if (!string.IsNullOrWhiteSpace(txtName)) { data = data.Where(b => b.Name.Contains(txtName)); } if (nStatus >= 0) { data = data.Where(b => b.IsEnable == (nStatus == (int)StageEnumHelper.ComStatus.啟用)); } if (dOperateTime > Convert.ToDateTime("1991-01-01")) { data = data.Where(b => b.OperateTime >= dOperateTime && b.OperateTime < dOperateTime.AddDays(1)); } moPageResult.MoPageContent( data, b => b.OperateTime, b => new { Id = b.Id, Name = b.Name, Link = b.Link, Des = b.Des, IsEnable = b.IsEnable, Operator = b.Operator, OperatorDes = b.MoUserInfo.NickName, EnableDes = b.IsEnable ? "啟用" : "禁用", OperateTime = b.OperateTime }); } catch (Exception ex) { } return Json(moPageResult, JsonRequestBehavior.AllowGet); } 

後端透過 Request.Params 取到的幾個參數,正是前端這段所組裝的查詢條件:

 var data = { txtName: $("input[name='txtName']").val(), nStatus: $("select option:selected").val(), dOperateTime: $("input[name='dOperateTime']").val() }; 

分別對應畫面上的名稱、狀態與操作時間。仔細看會發現,後端並沒有出現取得當前頁碼與每頁筆數的程式碼——這些都被收進 MoPageResult 類別的 MoPageContent() 裡了:

 #region 分頁數據返回 public class MoPageResult<TResult> where TResult : class, new() { public MoPageResult() { } public IQueryable<TResult> MoResult; /// <summary> /// 總頁數 /// </summary> public int PageTotal { get; set; } /// <summary> /// 當前頁數 /// </summary> public int CurrentPage { get; set; } /// <summary> /// 分頁記錄數 /// </summary> public int PageSize { get; set; } /// <summary> /// 分頁方法 /// </summary> /// <typeparam name="TKey"></typeparam> /// <param name="query"></param> /// <param name="order_desc"></param> public void MoPageContent<T, TKey>(IQueryable<T> query, Expression<Func<T, TKey>> desc, Expression<Func<T, TResult>> selector = null, bool isDesc = true) where T : class,new() { if (HttpContext.Current == null) { return; } var Request = HttpContext.Current.Request; this.PageSize = string.IsNullOrWhiteSpace(Request.Params["pageSize"]) ? 15 : Convert.ToInt32(Request.Params["pageSize"]); this.CurrentPage = string.IsNullOrWhiteSpace(Request.Params["currentPage"]) ? 1 : Convert.ToInt32(Request.Params["currentPage"]); var nTotal = query.Count(); this.PageTotal = nTotal / this.PageSize + (nTotal % this.PageSize > 0 ? 1 : 0); if (selector != null) { if (isDesc) { query = query.OrderByDescending(desc); } else { query = query.OrderBy(desc); } this.MoResult = query. Skip((this.CurrentPage - 1) * this.PageSize). Take(this.PageSize). Select(selector); } } } #endregion 

MoPageContent() 預設會自動讀取 pageSize 與 currentPage 兩個參數,呼叫端不必自己處理,同時它還肩負了計算總頁數與下發分頁查詢的角色。請特別注意最後那句 Select(selector),selector 的型別是 Expression<Func<T, TResult>>,並帶有 where T : class, new() 的約束。我實際呼叫時傳入的 T 是 dynamic,單純因為匿名型別寫起來更省事。唯一的小遺憾是 Select 的輸出目前還無法直接對某個屬性呼叫方法。

另外還有一個容易踩到的細節:時間格式。如果後端不做處理,直接把 DateTime 交給 JSON 序列化,前端拿到的會是這種樣子:

這時候需要在 headText 裡為時間欄位指定格式:

{ nickName: "操作時間", name: "OperateTime", format: "yyyy-MM-dd" }

外掛支援的格式符號有 yyyy、MM、dd、HH、mm、ss,日常需求應該都能覆蓋。

三、開發者視角閱讀 shenniu.pager.js

先看外掛的預設設定區塊,註解已經寫得比較完整:

 var defOption = { showId: "divShowResult", //內容顯示的div url: "", //ajax數據來源地址 headText: [ { nickName: "A", colType: "checkbox", name: "Id" }, { nickName: "B", colType: "label", name: "Name", isModalHeadText: true } //isModalHeadText:是否是模式窗體頭部顯示的信息 ], data: {}, //查詢條件 editeOption: { url: "", title: "編輯", width: 500, height: 500 }, //編輯地址,不包括id viewOption: { url: "", title: "查看", width: 500, height: 500 }, //查看地址 delOption: { url: "", title: "刪除", width: 500, height: 500 }, //刪除地址 currentPage: 1, //當前頁數 pageSize: 15, //分頁記錄數 showPageTab: 6, //展示6個頁數 modalExt: null, //模式窗體對象 //可忽略 callback: function () { }, //回調函數 tabId: "tab001", loading: "努力加載中,等會吧...", //可以直接寫出<img src=''/> sucFun: function (data) { }, befFun: function () { }, errFun: function () { }, comFun: function () { }, timeout: 60000 //超時60S }; $.extend(defOption, option);

最後那行 $.extend(defOption, option) 的作用是把使用者傳入的參數與預設值合併,同名屬性會被使用者的值覆蓋。

再來看請求後台的方法:

 //請求後台 function ajaxFun(option) { if (option) { $.extend(defOption, option); } //獲取分頁參數 var hidPageSize = defOption.pageSize; var hidCurrentPage = defOption.currentPage; if ($("form input[name='pageSize']").val()) { hidPageSize = $("form input[name='pageSize']").val(); } if ($("form input[name='currentPage']").val()) { hidCurrentPage = $("form input[name='currentPage']").val(); } //合並用戶查詢條件和分頁參數條件 var searchData = { pageSize: hidPageSize, currentPage: hidCurrentPage }; $.extend(searchData, defOption.data); //請求後台數據 $.ajax({ url: defOption.url, type: "get", data: searchData, dataType: "json", timeout: defOption.timeout, async: true, beforeSend: defOption.befFun, success: defOption.sucFun, }); }

這個方法負責向接口要資料,預設從表單中讀取 pageSize 與 currentPage。這裡用的是 GET,改成 POST 也完全可以,只要後端同步支援即可。

接著是查詢列表方法:

 //查詢列表 listFun: function (option) { if (option) { $.extend(defOption, option); } //默認格式 var tab = []; tab.push('<table id="' + defOption.tabId + '" class="table table-bordered table-hover">'); tab.push('<thead><tr role="row">'); for (var i in defOption.headText) { var head = defOption.headText[i]; if (head.colType == "label") { tab.push('<th class="center" tabindex="0" rowspan="1" colspan="1">' + head.nickName + '</th>'); } else if (head.colType == "checkbox") { tab.push('<th class="center " rowspan="1" colspan="1" aria-label="">'); tab.push(' <label class="pos-rel">'); tab.push(' <input type="checkbox" name="cbAll" class="ace">'); tab.push(' <span class="lbl">' + head.nickName + '</span>'); tab.push(' </label>'); tab.push('</th>'); } else { tab.push('<th class="center" tabindex="0" rowspan="1" colspan="1">' + head.nickName + '</th>'); } } tab.push('</tr></thead>'); tab.push('<tbody><tr><td class="text-center" colspan="' + defOption.headText.length + '">' + defOption.loading + '</td></tr></tbody>'); tab.push('</table>'); tab.push('<div id="divPager" class="text-center"></div>'); $("#" + defOption.showId).html(tab.join('')); //全選事件 $("input[type='checkbox'][name='cbAll']").on("click", function () { var cbStatus = $(this).is(":checked"); if (cbStatus) { $("input[name='cb']:checkbox").prop("checked", true); } else { $("input[name='cb']:checkbox").prop("checked", false); } }); //數據返回成功處理 defOption.sucFun = function (data) { var head = $("table[id='" + defOption.tabId + "'] tbody"); if (data) { if (data.MoResult) { //遍歷table展示的數據 var rows = []; $.each(data.MoResult, function (i, item) { rows.push('<tr>'); var modalHeadText = ""; for (var h_i in defOption.headText) { var head = defOption.headText[h_i]; var item_val = item[head.name]; if (item_val && typeof (item_val) != "undefined") { } else { item_val = ""; } //時間格式化 if (head.format && item_val.length > 0) { console.log(item_val); var date = new Date(parseInt(item_val.replace("/Date(", "").replace(")/", ""), 10)); item_val = head.format. replace("yyyy", date.getFullYear()). replace("MM", date.getMonth() + 1). replace("dd", date.getDate()). replace("HH", date.getHours()). replace("mm", date.getMinutes()). replace("ss", date.getMilliseconds()); } //獲取模式窗體頭部信息 if (modalHeadText.length <= 0) { modalHeadText = head.isModalHeadText ? item_val : "" }; if (head.colType == "label") { rows.push('<td class="center">' + item_val + '</td>'); } else if (head.colType == "checkbox") { rows.push('<td class="center">'); rows.push(' <label class="pos-rel">'); rows.push(' <input type="checkbox" name="cb" value="' + item_val + '" class="ace">'); rows.push(' <span class="lbl"></span>'); rows.push(' </label>'); rows.push('</td>'); } else if (head.colType == "operate") { rows.push('<td class="center"><div class="hidden-sm hidden-xs action-buttons">'); if (defOption.editeOption.url.length > 0) { var editOption = $.extend({}, defOption.editeOption); editOption.url += "/" + item_val; editOption.title += modalHeadText.length > 0 ? "-" + modalHeadText : ""; var op = JSON.stringify(editOption); rows.push('<a class="blue" data-item=\'' + op + '\' href="javascript:;"><i class="ace-icon fa fa-pencil bigger-130"></i></a>'); } if (defOption.viewOption.url.length > 0) { var viewOption = $.extend({}, defOption.viewOption); viewOption.url += "/" + item_val; viewOption.title += modalHeadText.length > 0 ? "-" + modalHeadText : ""; var op = JSON.stringify(viewOption); rows.push('<a class="blue" data-item=\'' + op + '\' href="javascript:;"><i class="ace-icon fa fa-search-plus bigger-130"></i></a>'); } if (defOption.delOption.url.length > 0) { var delOption = $.extend({}, defOption.delOption); delOption.url += "/" + item_val; delOption.title += modalHeadText.length > 0 ? "-" + modalHeadText : ""; var op = JSON.stringify(delOption); rows.push('<a class="blue" data-item=\'' + op + '\' href="javascript:;"><i class="ace-icon fa fa-trash-o bigger-130"></i></a>'); } rows.push('</div></td>'); } else { rows.push('<td class="center">' + item_val + '</td>'); } } rows.push('</tr>'); }); //頁數展示 if (data.MoResult.length > 0) { var pager = []; pager.push('<div class="text-center">'); pager.push(' <ul class="pagination" style="margin-top:0px">'); var nPager = defOption.showPageTab;//每次展示6個分頁 //上一頁 var nprev = (data.CurrentPage - 1 >= 1 ? data.CurrentPage - 1 : 1); pager.push(' <li class="paginate_button previous" aria-controls="dynamic-table" tabindex="0" id="dynamic-table_previous">'); pager.push(' <a href="javascript:;" name="npager" data-page="' + nprev + '">上一頁</a>'); pager.push(' </li>'); //當前頁之前頁碼 var preTotal = data.CurrentPage - nPager >= 1 ? data.CurrentPage - nPager : 1; for (var i = preTotal; i < data.CurrentPage ; i++) { pager.push(' <li class="paginate_button ' + (i == data.CurrentPage ? "active disabled" : "") + '" aria-controls="dynamic-table">'); pager.push(' <a href="javascript:;" name="npager" data-page="' + i + '">' + i + '</a>'); pager.push(' </li>'); } //當前頁 pager.push(' <li class="paginate_button active disabled" aria-controls="dynamic-table">'); pager.push(' <a href="javascript:;" name="npager" data-page="' + data.CurrentPage + '">' + data.CurrentPage + '</a>'); pager.push(' </li>'); //當前頁以後頁碼 var nextTotal = data.CurrentPage + nPager > data.PageTotal ? data.PageTotal : data.CurrentPage + nPager; for (var i = data.CurrentPage + 1; i <= nextTotal; i++) { pager.push(' <li class="paginate_button ' + (i == data.CurrentPage ? "active disabled" : "") + '" aria-controls="dynamic-table">'); pager.push(' <a href="javascript:;" name="npager" data-page="' + i + '">' + i + '</a>'); pager.push(' </li>'); } //下一頁 var nnext = (data.PageTotal < data.CurrentPage + 1 ? data.PageTotal : data.CurrentPage + 1); pager.push(' <li class="paginate_button next" aria-controls="dynamic-table" tabindex="0" id="dynamic-table_next">'); pager.push(' <a href="javascript:;" name="npager" data-page="' + nnext + '">下一頁</a>'); pager.push(' </li>'); pager.push(' </ul>'); //分頁查詢條件 pager.push('<div style="display:none">'); pager.push(' <form>'); pager.push(' <input type="hidden" name="pageSize" value="' + defOption.pageSize + '"/>'); pager.push(' <input type="hidden" name="currentPage" value="' + defOption.currentPage + '"/>'); pager.push(' </form>'); pager.push('</div>'); pager.push('</div>'); //移除加載中 //head.html(""); //添加結果 head.html(rows.join('')); $("div[id='divPager']").html(pager.join('')); //操作按鈕事件 $("a[data-item]").on("click", function () { var data_Item = $(this).attr("data-item"); if (data_Item) { var data_Item_Obj = JSON.parse(data_Item); defOption.modalExt.modalFun({ width: data_Item_Obj.width, height: data_Item_Obj.height, url: data_Item_Obj.url, title: data_Item_Obj.title, callback: defOption.callback }); } }); //綁定分頁按鈕事件 $("a[name='npager']").on("click", function () { var nPager = $(this).attr("data-page"); if (nPager.length <= 0) { return; } $("form input[name='currentPage']").val(nPager); //執行請求後台 ajaxFun(defOption); }); } else { head.html("<tr><td class=\"text-center\" colspan=\"" + defOption.headText.length + "\">未能查詢到數據!</td></tr>"); $("div[id='divPager']").html(""); } } else { head.html("<tr><td class=\"text-center\" colspan=\"" + defOption.headText.length + "\">未能查詢到數據。</td></tr>"); $("div[id='divPager']").html(""); } } else { head.html("<tr><td class=\"text-center\" colspan=\"" + defOption.headText.length + "\">未能查詢到數據</td></tr>"); $("div[id='divPager']").html(""); } }; if (option) { $.extend(defOption, option); } //執行請求後台 ajaxFun(defOption); }

這段方法體最長,主流程可以濃縮成一句話:

先渲染表頭並顯示「載入中」提示 → 綁定全選事件 → 定義資料回來後的 sucFun() → 呼叫 ajaxFun() 發請求。

sucFun() 在資料到手後負責的事則是:

遍歷 JSON 結果並逐列填入 table(其中包含時間格式化、checkbox、label 與 operate 操作欄的處理)→ 輸出頁碼區塊並綁定事件(上一頁、當前頁前後頁碼、當前頁、下一頁,同時生成 pageSize 與 currentPage 的隱藏欄位作為翻頁查詢條件)。

以上就是 shenniu.pager.js 的全部內容,量不大、結構也算清楚,能整理出來分享給大家挺開心。範例中用到的 js 與 css 檔案可由此下載:https://xiazai.jb51.net/201612/yuanma/shenniu.pager_jb51.rar

希望這篇文章對你的學習或工作有些幫助。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved