JS元件系列——表格元件神器：bootstrap table
前言：之前一直在忙著各種什麼效果，殊不知最基礎的Bootstrap Table用法都沒有涉及，罪過，罪過。今天補起來吧。上午博主由零開始自己從頭到尾使用了一遍Bootstrap Table ，遇到不少使用方面的問題，也做了一部分筆記，在此分享出來供需要使用的園友參考。還記得前兩天有園友加群問我Bootstrap Table的使用問題，呵呵，巧了，今天博主也遇到同樣的問題了，在此還是要表示抱歉，沒有將這篇提前發出來。
bootstrap table系列：
一、相關文件和技術網站小結
關於流式佈局的bootstrap，博主也是最近半年才開始使用，用過之後才知道其實開源的東西挺不錯的，還是為bootstrap開源工作者點一個大大的贊！老規矩，貼出相關文件：
這裡要說明一點：Bootstrap Table的離線API是博主自己在官網上面儲存下來的，樣式可能存在問題。博主也不想使用這種看起來乖乖的離線文件，但沒辦法，http://bootstrap-table.wenzhixin.net.cn/zh-cn/documentation/這網站經常性的打不開，貌似有被牆的可能性。下一步是不是要FQ了，O(∩_∩)O~。
二、Bootstrap Table的引入
關於Bootstrap Table的引入，一般來說還是兩種方法：
1、直接下載原始碼，新增到專案裡面來。
由於Bootstrap Table是Bootstrap的一個元件，所以它是依賴Bootstrap的，我們首先需要新增Bootstrap的引用。Bootstrap的包直接在
2、使用我們神奇的Nuget
開啟Nuget，搜尋這兩個包
Bootstrap已經是最新的3.3.5了，我們直接安裝即可。
而Bootstrap Table的版本竟然是0.4，這也太坑爹了。所以博主建議Bootstrap Table的包就直接在原始碼裡面去下載吧。Bootstrap Table最新的版本好像是1.9.0。
三、程式碼詳解
當然，元件引用進來了，使用就簡單了，只不過這裡面涉及很多細節需要我們處理，具體我們待會再說，先來看看使用方法。
1、在cshtml頁面引用相關元件，並定義好一個空的表格。
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>BootStrap Table使用</title>
@*1、Jquery元件引用*@
<script src="~/Scripts/jquery-1.10.2.js"></script>
@*2、bootstrap元件引用*@
<script src="~/Content/bootstrap/bootstrap.js"></script>
<link href="~/Content/bootstrap/bootstrap.css" rel="stylesheet" />
@*3、bootstrap table元件以及中文包的引用*@
<script src="~/Content/bootstrap-table/bootstrap-table.js"></script>
<link href="~/Content/bootstrap-table/bootstrap-table.css" rel="stylesheet" />
<script src="~/Content/bootstrap-table/locale/bootstrap-table-zh-CN.js"></script>
@*4、頁面Js檔案的引用*@
<script src="~/Scripts/Home/Index.js"></script>
</head>
<body>
<div class="panel-body" style="padding-bottom:0px;">
<div class="panel panel-default">
<div class="panel-heading">查詢條件</div>
<div class="panel-body">
<form id="formSearch" class="form-horizontal">
<div class="form-group" style="margin-top:15px">
<label class="control-label col-sm-1" for="txt_search_departmentname">部門名稱</label>
<div class="col-sm-3">
<input type="text" class="form-control" id="txt_search_departmentname">
</div>
<label class="control-label col-sm-1" for="txt_search_statu">狀態</label>
<div class="col-sm-3">
<input type="text" class="form-control" id="txt_search_statu">
</div>
<div class="col-sm-4" style="text-align:left;">
<button type="button" style="margin-left:50px" id="btn_query" class="btn btn-primary">查詢</button>
</div>
</div>
</form>
</div>
</div>
<div id="toolbar" class="btn-group">
<button id="btn_add" type="button" class="btn btn-default">
<span class="glyphicon glyphicon-plus" aria-hidden="true"></span>新增
</button>
<button id="btn_edit" type="button" class="btn btn-default">
<span class="glyphicon glyphicon-pencil" aria-hidden="true"></span>修改
</button>
<button id="btn_delete" type="button" class="btn btn-default">
<span class="glyphicon glyphicon-remove" aria-hidden="true"></span>刪除
</button>
</div>
<table id="tb_departments"></table>
</div>
</body>
</html>
引入需要的檔案之後，我們最重要的就是定義一個空的table，如上的 <table id="tb_departments"></table> 。當然Bootstrap table還提供了一種簡介的用法，直接在table標籤裡面定義類似“data-...”等相關屬性，就不用再js裡面註冊了，但博主覺得這種用法雖然簡單，但不太靈活，遇到父子表等這些高階用法的時候就不太好處理了，所以咱們還是統一使用在js裡面初始化的方式來使用table元件。
2、Js初始化
$(function () {
//1.初始化Table
var oTable = new TableInit();
oTable.Init();
//2.初始化Button的點選事件
var oButtonInit = new ButtonInit();
oButtonInit.Init();
});
var TableInit = function () {
var oTableInit = new Object();
//初始化Table
oTableInit.Init = function () {
$('#tb_departments').bootstrapTable({
url: '/Home/GetDepartment', //請求後臺的URL（*）
method: 'get', //請求方式（*）
toolbar: '#toolbar', //工具按鈕用哪個容器
striped: true, //是否顯示行間隔色
cache: false, //是否使用快取，預設為true，所以一般情況下需要設定一下這個屬性（*）
pagination: true, //是否顯示分頁（*）
sortable: false, //是否啟用排序
sortOrder: "asc", //排序方式
queryParams: oTableInit.queryParams,//傳遞引數（*）
sidePagination: "server", //分頁方式：client客戶端分頁，server服務端分頁（*）
pageNumber:1, //初始化載入第一頁，預設第一頁
pageSize: 10, //每頁的記錄行數（*）
pageList: [10, 25, 50, 100], //可供選擇的每頁的行數（*）
search: true, //是否顯示錶格搜尋，此搜尋是客戶端搜尋，不會進服務端，所以，個人感覺意義不大
strictSearch: true,
showColumns: true, //是否顯示所有的列
showRefresh: true, //是否顯示重新整理按鈕
minimumCountColumns: 2, //最少允許的列數
clickToSelect: true, //是否啟用點選選中行
height: 500, //行高，如果沒有設定height屬性，表格自動根據記錄條數覺得表格高度
uniqueId: "ID", //每一行的唯一標識，一般為主鍵列
showToggle:true, //是否顯示詳細檢視和列表檢視的切換按鈕
cardView: false, //是否顯示詳細檢視
detailView: false, //是否顯示父子表
columns: [{
checkbox: true
}, {
field: 'Name',
title: '部門名稱'
}, {
field: 'ParentName',
title: '上級部門'
}, {
field: 'Level',
title: '部門級別'
}, {
field: 'Desc',
title: '描述'
}, ]
});
};
//得到查詢的引數
oTableInit.queryParams = function (params) {
var temp = { //這裡的鍵的名字和控制器的變數名必須一直，這邊改動，控制器也需要改成一樣的
limit: params.limit, //頁面大小
offset: params.offset, //頁碼
departmentname: $("#txt_search_departmentname").val(),
statu: $("#txt_search_statu").val()
};
return temp;
};
return oTableInit;
};
var ButtonInit = function () {
var oInit = new Object();
var postdata = {};
oInit.Init = function () {
//初始化頁面上面的按鈕事件
};
return oInit;
};
表格的初始化也很簡單，定義相關的引數即可。上面一些博主覺得重要的引數都加了註釋，並且初始化Table必須的幾個引數博主也用（*）做了標記，如果你的表格也有太多的頁面需求，直接用必須的引數就能解決。同樣，在columns引數裡面其實也有很多的引數需要設定，比如列的排序，對齊，寬度等等。這些博主覺得比較簡單，不會涉及表格的功能，看看API就能搞定。
3、在Controller裡面對應的方法
public JsonResult GetDepartment(int limit, int offset, string departmentname, string statu)
{
var lstRes = new List<Department>();
for (var i = 0; i < 50; i++)
{
var oModel = new Department();
oModel.ID = Guid.NewGuid().ToString();
oModel.Name = "銷售部" + i ;
oModel.Level = i.ToString();
oModel.Desc = "暫無描述資訊";
lstRes.Add(oModel);
}
var total = lstRes.Count;
var rows = lstRes.Skip(offset).Take(limit).ToList();
return Json(new { total = total, rows = rows }, JsonRequestBehavior.AllowGet);
}
這裡有一點需要注意：如果是服務端分頁，返回的結果必須包含total、rows兩個引數。漏寫或錯寫都會導致表格無法顯示資料。相反，如果是客戶端分頁，這裡要返回一個集合物件到前端。
4、效果及說明
還是貼幾張效果圖出來：
四、問題小結
由於是從零開始開發的以上功能，博主遇到一個問題可以和園友們分享一下，這應該也是今天這篇想表達的重點。
1、上面說過，如果在js裡面初始化的引數 sidePagination: "server" 設定為在服務端分頁，那麼我們的返回值必須告訴前端總記錄的條數和當前頁的記錄數，然後前端才知道如何分頁。並且最重要的一點，這兩個引數的名字必須為total和rows。最開始博主也不知道這個，寫成了total和row，結果是請求可以進到後臺的GetDepartment方法，返回值total和row也都有值，可是前端就是顯示如下：
找了好半天原因。原來是row寫錯了，應該寫成rows。可能這也是前天園友遇到的問題的原因。
2、第二個問題就是關於bootstrap頁面樣式的問題，我們使用過bootstrap的朋友應該知道，它裡面所有的圖示都是通過class = "glyphicon glyphicon-plus"這種方式去寫的。博主按要求這樣做了，可是新增、修改、刪除前面的圖示怎麼都出不來。如下：
怎麼回事呢？然後各種百度，最後發現原來是fonts資料夾的問題。我們在新建一個MVC專案的時候，會自動建立一個fonts資料夾，裡面內容如下：
而我們的bootstrap.css是放在Content資料夾裡面的，這樣就導致找不到這些樣式檔案。最終通過谷歌瀏覽器檢視控制檯
原來它自動去Content裡面找fonts檔案夾了。這下就好辦了，把我們的fonts資料夾拷貝到Content下不就行了嗎。呵呵，原來真是這樣，問題順利解決。
3、關於中文。剛開始，博主沒有引用 <script src="~/Content/bootstrap-table/locale/bootstrap-table-zh-CN.js"></script> 這個包，所以介面找不到記錄是顯示的是英文，如下：
後來也是查資料瞭解到，bootstrap table裡面原來還有一箇中文包，把它新增進來就好了。
4、第四點要說說表格自帶的搜尋功能，有上可知，在初始化表格的時候，通過設定search: true可以設定表格的搜尋框出現並且可以進行模糊搜尋。之前博主一直以為只有客戶端分頁才能使用這個搜尋，多謝園友指出，其實服務端分頁也可以使用這個搜尋功能。只不過需要在對應的方法里加上search引數。比如
oTableInit.queryParams = function (params) {
var temp = { //這裡的鍵的名字和控制器的變數名必須一直，這邊改動，控制器也需要改成一樣的
limit: params.limit, //頁面大小
offset: params.offset, //頁碼
departmentname: $("#txt_search_departmentname").val(),
statu: $("#txt_search_statu").val(),
search:params.search
};
return temp;
};
然後後端
public JsonResult GetDepartment(int limit, int offset, string departmentname, string statu, string search)
{
var lstRes = new List<Department>();
for (var i = 0; i < 50; i++)
{
var oModel = new Department();
oModel.ID = Guid.NewGuid().ToString();
oModel.Name = "銷售部" + i ;
oModel.Level = i.ToString();
oModel.Desc = "暫無描述資訊";
lstRes.Add(oModel);
}
var total = lstRes.Count;
var rows = lstRes.Skip(offset).Take(limit).ToList();
return Json(new { total = total, rows = rows }, JsonRequestBehavior.AllowGet);
}
這樣，每次使用者在搜尋框裡面輸入都會進到後臺的方法，並且將使用者輸入的值傳到search引數。但是如果你需要對多個欄位進行模糊匹配，那麼就意味著你的後臺需要去對多個數據欄位進行like操作，這樣查詢效率肯定低下。所以，如果需要模糊匹配的欄位很多，這個search在實際專案中是用不上的。綜上，博主還是覺得只有在客戶端分頁的時候，這個搜尋的作用比較明顯。
5、關於Bootstrap Table的排序，由於一般這種BS系統肯定會採用服務端分頁，我們如果僅僅在js裡面設定sortable和sortOrder等屬性資訊，表格是不會有效排序的。原因很簡單，服務端分頁的方式，排序本頁資料意義不大。所以，一般的排序需要將排序方式和排序欄位傳送到後臺，在後臺排序比較合適。比如我們這裡可以再引數裡面增加兩個：
oTableInit.queryParams = function (params) {
var temp = { //這裡的鍵的名字和控制器的變數名必須一直，這邊改動，控制器也需要改成一樣的
limit: params.limit, //頁面大小
offset: params.offset, //頁碼
order: params.order,
ordername: params.sort,
departmentname: $("#txt_search_departmentname").val(),
statu: $("#txt_search_statu").val()
};
return temp;
};
五、總結
在之前的幾年開發經歷中，博主也使用Jqgrid、EasyUI等表格元件。相比而言，bootstrap Table有自己的優勢：
1、介面採用扁平化的風格，使用者體驗比較好，更好相容各種客戶端。這點也是最重要的。
2、開源、免費。國人最喜歡的就是免費了。呵呵。
3、相對Jqgrid、easyUI而言，比較輕量級。功能不能說最全面，但基本夠用。
至此，本篇就結束了，歡迎園友們拍磚。原始碼下載。
最近打算做點自己的東西出來，將部落格裡面的一些好的技術融合進去。有專案合作的小夥伴趕快聯絡博主吧！