KnockoutJS 是一個以 JavaScript 實作的 MVVM 框架,用起來相當順手。舉例來說,列表資料增減之後,不必重新刷新整塊控制項,也不必自己寫 JS 去增刪節點,只要預先定義好模板並依它的語法宣告屬性即可。簡單講,我們只需要專注在資料的讀取與寫入上。
公司系統最近要改版,新系統我打算用 KnockoutJS 來做 Web 前端。做的過程中遇到一個問題:該怎麼用 KnockoutJS 完成分頁?前一篇文章沒談到這塊,所以本篇就來補充 KnockoutJS 搭配 Bootstrap 的資料分頁顯示。
這裡示範兩種做法。第一種是一次把所有資料載入,再在前端切片分頁顯示;第二種是每次只請求部分資料,翻頁時重新打一次後端。
用 Razor 做分頁通常會採第二種;但對單頁應用程式來說,第一種也有它的好處——只要資料量不是特別龐大,後續翻頁完全不必等待,使用者體驗非常順。兩種都各有適用場景,所以下面分別實作。
後端沿用前一篇的程式碼,只是多塞了一些範例資料:
/// <summary>
/// Web API 服務,為 Web 前端提供數據服務
/// </summary>
public class TaskController : ApiController {
private readonly TaskRepository _taskRepository = TaskRepository.Current;
public IEnumerable<Task> GetAll() {
return _taskRepository.GetAll().OrderBy(a => a.Id);
}
[Route("api/task/GetByPaged")]
public PagedModel GetAll([FromUri]int pageIndex) {
const int pageSize = 3;
int totalCount;
var tasks = _taskRepository.GetAll(pageIndex, pageSize, out totalCount).OrderBy(a => a.Id);
var pageData = new PagedModel() {
PageIndex = pageIndex,
PagedData = tasks.ToList(),
TotalCount = totalCount,
PageCount = (totalCount + pageSize - 1) / pageSize
};
return pageData;
}
}
/// <summary>
/// 任務倉儲,封裝了所有關於數據庫的操作
/// </summary>
public class TaskRepository {
#region Static Filed
private static Lazy<TaskRepository> _taskRepository =
new Lazy<TaskRepository>(() => new TaskRepository());
public static TaskRepository Current {
get { return _taskRepository.Value; }
}
#endregion
#region Fields
private readonly List<Task> _tasks = new List<Task>() {
new Task { Id = 1, Name = "創建一個SPA程序", Description = "SPA(single page web application),優勢是少量帶寬、平滑體驗", Owner = "Learning hard" },
new Task { Id = 2, Name = "學習KnockoutJs", Description = "KnockoutJs是一個MVVM類庫,支持雙向綁定", Owner = "Tommy Li" },
new Task { Id = 3, Name = "學習AngularJS", Description = "AngularJs是MVVM框架,集MVVM和MVC於一體", Owner = "李志" },
new Task { Id = 4, Name = "學習ASP.NET MVC網站", Description = "Glimpse是一款.NET下的性能測試工具", Owner = "Tonny Li" },
new Task { Id = 5, Name = "測試任務1", Description = "測試任務1", Owner = "李志" },
new Task { Id = 6, Name = "測試任務2", Description = "測試任務2", Owner = "李志" },
new Task { Id = 7, Name = "測試任務3", Description = "測試任務3", Owner = "李志" },
};
#endregion
#region Public Methods
public IEnumerable<Task> GetAll() {
return _tasks;
}
public IEnumerable<Task> GetAll(int pageNumber, int pageSize, out int totalCount) {
var skip = (pageNumber - 1) * pageSize;
var take = pageSize;
totalCount = _tasks.Count;
return _tasks.Skip(skip).Take(take);
}
public Task Get(int id) {
return _tasks.Find(p => p.Id == id);
}
public Task Add(Task item) {
if (item == null) { throw new ArgumentNullException("item"); }
item.Id = _tasks.Count + 1;
_tasks.Add(item);
return item;
}
public void Remove(int id) {
_tasks.RemoveAll(p => p.Id == id);
}
public bool Update(Task item) {
if (item == null) { throw new ArgumentNullException("item"); }
var taskItem = Get(item.Id);
if (taskItem == null) { return false; }
_tasks.Remove(taskItem);
_tasks.Add(item);
return true;
}
#endregion
}
Web 前端部分:
@{
ViewBag.Title = "Index2";
Layout = "~/Views/Shared/_Layout.cshtml";
}
<div id="list2">
<h2>分頁第二種實現方式——任務列表</h2>
<div class="table-responsive">
<table class="table table-striped">
<thead>
<tr>
<th>編號</th>
<th>名稱</th>
<th>描述</th>
<th>負責人</th>
<th>創建時間</th>
<th>完成時間</th>
<th>狀態</th>
</tr>
</thead>
<tbody data-bind="foreach:pagedList">
<tr>
<td data-bind="text: id"></td>
<td><a data-bind="text: name"></a></td>
<td data-bind="text: description"></td>
<td data-bind="text: owner"></td>
<td data-bind="text: creationTime"></td>
<td data-bind="text: finishTime"></td>
<td data-bind="text: state"></td>
</tr>
</tbody>
<tbody data-bind="if: loadingState">
<tr>
<td colspan="8" class="text-center">
<img width="60" src="/images/loading.gif" />
</td>
</tr>
</tbody>
<tfoot data-bind="ifnot:loadingState">
<tr>
<td colspan="8">
<div class="pull-right">
<div>總共有<span data-bind="text: totalCount"></span>條記錄,每頁顯示:<span data-bind="text: pageSize"></span>條</div>
<div>
<ul class="pagination">
<li data-bind="css: { disabled: pageIndex() === 1 }"><a href="#" data-bind="click: previous">«</a></li>
</ul>
<ul data-bind="foreach: allPages" class="pagination">
<li data-bind="css: { active: $data.pageNumber === ($root.pageIndex()) }">
<a href="#" data-bind="text: $data.pageNumber, click: function() { $root.gotoPage($data.pageNumber); }"></a>
</li>
</ul>
<ul class="pagination">
<li data-bind="css: { disabled: pageIndex() === pageCount }"><a href="#" data-bind="click: next">»</a></li>
</ul>
</div>
</div>
</td>
</tr>
</tfoot>
</table>
</div>
</div>
對應的 JS:
// 實現分頁的第二種方式
var ListViewModel2 = function() {
// 用 self 保存 this,避免作用域混亂
var self = this;
self.loadingState = ko.observable(true);
self.pageSize = ko.observable(3);
this.pagedList = ko.observableArray(); // 數據
this.pageIndex = ko.observable(1); // 要訪問的頁碼
this.pageCount = ko.observable(1); // 總頁數
this.allPages = ko.observableArray(); // 頁碼集合
this.currengePage = ko.observable(1); // 當前頁
self.totalCount = ko.observable(1);
this.refresh = function() {
// 限制請求頁碼在有效範圍內
if (self.pageIndex() < 1) self.pageIndex(1);
if (self.pageIndex() > self.pageCount()) {
self.pageIndex(self.pageCount());
}
sendAjaxRequest("GET", function (data) {
// 載入新數據前,先移除舊數據
self.pagedList.removeAll();
self.allPages.removeAll();
self.totalCount(data.totalCount);
self.pageCount(data.pageCount);
self.loadingState(false);
for (var i = 1; i <= data.pageCount; i++) {
self.allPages.push({ pageNumber: i }); // 裝填頁碼
}
for (var i in data.pagedData) {
self.pagedList.push(data.pagedData[i]); // 裝填數據
}
}, 'GetByPaged', { 'pageIndex': self.pageIndex() });
};
this.first = function() { self.pageIndex(1); self.refresh(); };
this.next = function() { self.pageIndex(this.pageIndex() + 1); self.refresh(); };
this.previous = function() { self.pageIndex(this.pageIndex() - 1); self.refresh(); };
this.last = function() { self.pageIndex(this.pageCount() - 1); self.refresh(); };
this.gotoPage = function (data, event) {
self.pageIndex(data);
self.refresh();
};
};
function sendAjaxRequest(httpMethod, callback, url, reqData) {
$.ajax("/api/task" + (url ? "/" + url : ""), {
type: httpMethod,
success: callback,
data: reqData
});
}
$(document).ready(function () {
var viewModel = new ListViewModel2();
viewModel.refresh();
if ($('#list2').length) ko.applyBindings(viewModel, $('#list2').get(0));
});
把整個呼叫邏輯梳理一遍:
一、頁面載入完成後發起 Ajax 請求,非同步向 REST 服務索取部分資料。
二、把拿回的資料透過 KnockoutJS 綁定顯示。
三、把分頁資訊綁定到 Bootstrap 的分頁元件上。
四、使用者點擊翻頁時,再發一次 Ajax 請求異步取資料並更新畫面。
對照 JS 程式碼看這四步會更清楚。第二種實作到此完成。
接著看第一種寫法。這種方式的好處是使用者只會在第一次感覺到載入,後續翻頁毫無等待感;對資料量本身不大的情境來說,體驗確實更順暢。
核心思路是:不要一次把全部資料攤在頁面上,否則資料一多使用者反而眼花,分頁顯示讓閱讀更清晰。
具體的前端 JS 實作如下:
var ListViewModel = function () {
var self = this;
window.viewModel = self;
self.list = ko.observableArray();
self.pageSize = ko.observable(3);
self.pageIndex = ko.observable(0); // 要訪問的頁碼
self.totalCount = ko.observable(1); // 總記錄數
self.loadingState = ko.observable(true);
// 用 dependentObservable 做切片,pageSize 或 pageIndex 變動時自動重算
self.pagedList = ko.dependentObservable(function () {
var size = self.pageSize();
var start = self.pageIndex() * size;
return self.list.slice(start, start + size);
});
self.maxPageIndex = ko.dependentObservable(function () {
return Math.ceil(self.list().length / self.pageSize()) - 1;
});
self.previousPage = function () {
if (self.pageIndex() > 0) {
self.pageIndex(self.pageIndex() - 1);
}
};
self.nextPage = function () {
if (self.pageIndex() < self.maxPageIndex()) {
self.pageIndex(self.pageIndex() + 1);
}
};
self.allPages = ko.dependentObservable(function () {
var pages = [];
for (var i = 0; i <= self.maxPageIndex(); i++) {
pages.push({ pageNumber: (i + 1) });
}
return pages;
});
self.moveToPage = function (index) {
self.pageIndex(index);
};
};
var listViewModel = new ListViewModel();
function bindViewModel() {
sendAjaxRequest("GET", function (data) {
listViewModel.loadingState(false);
listViewModel.list(data);
listViewModel.totalCount(data.length);
if ($('#list').length) ko.applyBindings(listViewModel, $('#list').get(0));
}, null, null);
}
$(document).ready(function () {
bindViewModel();
});
這裡最值得留意的是 ko.dependentObservable:它把「切片」這件事宣告成一個資料的推導函式,於是 pageSize 或 pageIndex 一旦變動,畫面自動重算,完全不必手動呼叫渲染。這正是宣告式綁定相對於命令式操作 DOM 的價值所在。
前端頁面與前面類似:
@{
ViewBag.Title = "Index";
Layout = "~/Views/Shared/_Layout.cshtml";
}
<div id="list">
<h2>任務列表</h2>
<div class="table-responsive">
<table class="table table-striped">
<thead>
<tr>
<th>編號</th>
<th>名稱</th>
<th>描述</th>
<th>負責人</th>
<th>創建時間</th>
<th>完成時間</th>
<th>狀態</th>
</tr>
</thead>
<tbody data-bind="foreach:pagedList">
<tr>
<td data-bind="text: id"></td>
<td><a data-bind="text: name"></a></td>
<td data-bind="text: description"></td>
<td data-bind="text: owner"></td>
<td data-bind="text: creationTime"></td>
<td data-bind="text: finishTime"></td>
<td data-bind="text: state"></td>
</tr>
</tbody>
<tbody data-bind="if:loadingState">
<tr>
<td colspan="8" class="text-center">
<img width="60" src="/images/loading.gif" />
</td>
</tr>
</tbody>
<tfoot data-bind="ifnot:loadingState">
<tr>
<td colspan="8">
<div class="pull-right">
<div>總共有<span data-bind="text: totalCount"></span>條記錄,每頁顯示:<span data-bind="text: pageSize"></span>條</div>
<div>
<ul class="pagination">
<li data-bind="css: { disabled: pageIndex() === 0 }"><a href="#" data-bind="click: previousPage">«</a></li>
</ul>
<ul data-bind="foreach: allPages" class="pagination">
<li data-bind="css: { active: $data.pageNumber === ($root.pageIndex() + 1) }">
<a href="#" data-bind="text: $data.pageNumber, click: function() { $root.moveToPage($data.pageNumber-1); }"></a>
</li>
</ul>
<ul class="pagination">
<li data-bind="css: { disabled: pageIndex() === maxPageIndex() }"><a href="#" data-bind="click: nextPage">»</a></li>
</ul>
</div>
</div>
</td>
</tr>
</tfoot>
</table>
</div>
</div>
注意兩種寫法的索引基準不同:第二種 pageIndex 從 1 起算,第一種從 0 起算,所以樣板裡判斷 active 與 disabled 的條件式也要跟著調整。
來看看 KnockoutJS 實作的分頁效果:

本文的內容就到這裡。雖然實作的東西相對簡單,但對剛接觸 KnockoutJS 的朋友來說,希望這兩種分頁思路能帶來一些參考。接下來我會再分享 AngularJS 的相關內容。
以上就是這次 Bootstrap 與 KnockoutJS 搭配實作分頁的完整解析,希望對大家有所幫助!