Bootstrap-table 使用總結

一、什麼是Bootstrap-table？

在業務系統開發中，對錶格記錄的查詢、分頁、排序等處理是非常常見的，在Web開發中，可以採用很多功能強大的插件來滿足要求，且能極大的提高開發效率，本隨筆介紹這個bootstrap-table是一款非常有名的開源表格插件，在很多項目中廣泛的應用。Bootstrap-table插件提供了非常豐富的屬性設置，可以實現查詢、分頁、排序、複選框、設置顯示列、Card view視圖、主從表顯示、合併列、國際化處理等處理功能，而且該插件同時也提供了一些不錯的擴展功能，如移動行、移動列位置等一些特殊的功能，插件可以用基於HTML5的data-*屬性標識設置，也可以使用Javascript方式進行設置，非常方便。本篇隨筆介紹bootstrap-table插件在我實際項目中的應用情況，總結相關使用中碰到的問題處理經驗。

二、怎麼使用Bootstrap-table？

Bootstrap-Table顯示數據到表格的方式有兩種，一種是客戶端（client）模式，一種是服務器（server）模式。

　　客戶端模式：指的是在服務器中把要顯示到表格的數據一次性加載出來，然後轉換成JSON格式傳到要顯示的界面中，客戶端模式較為簡單，它是把數據一次性加載出來放到界面上，然後根據你設置的每頁記錄數，自動生成分頁。當點擊第二頁時，會自動加載出數據，不會再向服務器發送請求。同時用戶可以使用其自帶的搜索功能，可以實現全數據搜索。對於數據量較少的時候，可以使用這個方法。

　　服務器模式：指的是根據設定的每頁記錄數和當前要顯示的頁碼，發送數據到服務器進行查詢，然後再顯示到表格中。該方法可以根據用戶的需要動態的加載數據，節省了服務器的資源，但是不能使用其自帶的全數據搜索功能。

Bootstrap-table是基於Boostrap開發的插件，因此使用的時候，需要引入Bootstrap的腳本和樣式。

如果我們項目中沒有引入相關的文件，則需要引入這些樣式和腳本文件，如下所示。

<code>1 <link>
2 
3 /<code>

然後是Bootstrap-table的依賴引用：

CSS文件引入

<code>1 <link>/<code>

腳本文件引入

<code>1 
2 
3 /<code>

bootstrap-table在頁面中的使用，可以分為兩種，一種是純粹用HTML5的寫法，通過data-*的方式指定各種屬性設置，一種是HTML+JS方式實現彈性設置。

如果我們採用HTML5標識的方式初始化HTML代碼，則是下面的代碼。

<code>1 <table>
2     <thead>
3         
4             Item ID
5             Item Name
6             Item Price
7         
8     /<thead>
9 /<table>/<code>

如果我們採用JS代碼方式來初始化表格插件，那麼只需要在HTML上聲明一個表格對象即可，如下代碼。

<code>1 <table>/<code>

js代碼如下：

<code> 1 $('#table').bootstrapTable({
 2     url: 'data1.json',
 3     columns: [{
 4         field: 'id',
 5         title: 'Item ID'
 6     }, {
 7         field: 'name',
 8         title: 'Item Name'
 9     }, {
10         field: 'price',
11         title: 'Item Price'
12     }, ]
13 });/<code>

不過實際上我們使用 bootstrap-table的JS配置功能肯定比這個複雜很多，下面界面效果是實際表的數據展示。

三、Bootstrap-table詳解：

1）整個JS屬性配置

以上圖為例，上圖展示結果的JS代碼如下所示：

<code> 1 var $table;
 2         //初始化bootstrap-table的內容
 3         function InitMainTable () {
 4             //記錄頁面bootstrap-table全局變量$table，方便應用
 5             var queryUrl = '/TestUser/FindWithPager?rnd=' + Math.random()
 6             $table = $('#grid').bootstrapTable({
 7                 url: queryUrl,                      //請求後臺的URL（*）
 8                 method: 'GET',                      //請求方式（*）
 9                 //toolbar: '#toolbar',              //工具按鈕用哪個容器
10                 striped: true,                      //是否顯示行間隔色
11                 cache: false,                       //是否使用緩存，默認為true，所以一般情況下需要設置一下這個屬性（*）
12                 pagination: true,                   //是否顯示分頁（*）
13                 sortable: true,                     //是否啟用排序
14                 sortOrder: "asc",                   //排序方式
15                 sidePagination: "server",           //分頁方式：client客戶端分頁，server服務端分頁（*）
16                 pageNumber: 1,                      //初始化加載第一頁，默認第一頁,並記錄
17                 pageSize: rows,                     //每頁的記錄行數（*）
18                 pageList: [10, 25, 50, 100],        //可供選擇的每頁的行數（*）
19                 search: false,                      //是否顯示錶格搜索
20                 strictSearch: true,
21                 showColumns: true,                  //是否顯示所有的列（選擇顯示的列）
22                 showRefresh: true,                  //是否顯示刷新按鈕 

23                 minimumCountColumns: 2,             //最少允許的列數
24                 clickToSelect: true,                //是否啟用點擊選中行
25                 //height: 500,                      //行高，如果沒有設置height屬性，表格自動根據記錄條數覺得表格高度
26                 uniqueId: "ID",                     //每一行的唯一標識，一般為主鍵列
27                 showToggle: true,                   //是否顯示詳細視圖和列表視圖的切換按鈕
28                 cardView: false,                    //是否顯示詳細視圖
29                 detailView: false,                  //是否顯示父子表
30                 //得到查詢的參數
31                 queryParams : function (params) {
32                     //這裡的鍵的名字和控制器的變量名必須一致，這邊改動，控制器也需要改成一樣的
33                     var temp = {   
34                         rows: params.limit,                         //頁面大小
35                         page: (params.offset / params.limit) + 1,   //頁碼
36                         sort: params.sort,      //排序列名  
37                         sortOrder: params.order //排位命令（desc，asc） 
38                     };
39                     return temp;
40                 },
41                 columns: [{
42                     checkbox: true,  
43                     visible: true                  //是否顯示覆選框  
44                 }, {
45                     field: 'Name',
46                     title: '姓名',
47                     sortable: true
48                 }, {
49                     field: 'Mobile',
50                     title: '手機',
51                     sortable: true
52                 }, {
53                     field: 'Email',
54                     title: '郵箱',
55                     sortable: true,
56                     formatter: emailFormatter 

57                 }, {
58                     field: 'Homepage',
59                     title: '主頁',
60                     formatter: linkFormatter
61                 }, {
62                     field: 'Hobby',
63                     title: '興趣愛好'
64                 }, {
65                     field: 'Gender',
66                     title: '性別',
67                     sortable: true
68                 }, {
69                     field: 'Age',
70                     title: '年齡'
71                 }, {
72                     field: 'BirthDate',
73                     title: '出生日期',
74                     formatter: dateFormatter
75                 }, {
76                     field: 'Height',
77                     title: '身高'
78                 }, {
79                     field: 'Note',
80                     title: '備註'
81                 }, {
82                     field:'ID',
83                     title: '操作',
84                     width: 120,
85                     align: 'center',
86                     valign: 'middle',
87                     formatter: actionFormatter
88                 }, ],
89                 onLoadSuccess: function () {
90                 },
91                 onLoadError: function () {
92                     showTips("數據加載失敗！");
93                 },
94                 onDblClickRow: function (row, $element) {
95                     var id = row.ID;
96                     EditViewById(id, 'view');
97                 },
98             });
99         };/<code>

上面JS代碼的配置屬性，基本上都加了註釋說明，是比較容易理解的了。

2）查詢及分頁

這裡的表格數據分頁是採用服務器分頁的方式，根據搜索條件從服務器返回數據記錄的，並使用了排序的處理方式，這裡的queryParams參數就是提交到服務器端的參數了。

<code> 1 //得到查詢的參數
 2 queryParams : function (params) {
 3 //這裡的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也需要改成一樣的
 4      var temp = {   
 5            rows: params.limit,                         //頁面大小
 6            page: (params.offset / params.limit) + 1,   //頁碼
 7            sort: params.sort,      //排序列名  
 8            sortOrder: params.order //排位命令（desc，asc） 
 9      };
10    return temp;
11 },/<code>

另外我們看到返回數據的URL地址接口是FindWithPager，我們來看看這個MVC控制器方法是如何處理數據返回的。

<code> 1 /// <summary>
 2         /// 根據條件查詢數據庫,並返回對象集合(用於分頁數據顯示)
 3         /// /<summary>
 4         /// <returns>指定對象的集合/<returns>
 5         public override ActionResult FindWithPager()
 6         {
 7             //檢查用戶是否有權限，否則拋出MyDenyAccessException異常
 8             base.CheckAuthorized(AuthorizeKey.ListKey);
 9  

10             string where = GetPagerCondition();
11             PagerInfo pagerInfo = GetPagerInfo();
12             var sort = GetSortOrder();
13 
14             List<testuserinfo> list = null;
15             if (sort != null && !string.IsNullOrEmpty(sort.SortName))
16             {
17                 list = baseBLL.FindWithPager(where, pagerInfo, sort.SortName, sort.IsDesc);
18             }
19             else
20             {
21                 list = baseBLL.FindWithPager(where, pagerInfo);
22             } 
23 
24             //Json格式的要求{total:22,rows:{}}
25             //構造成Json的格式傳遞
26             var result = new { total = pagerInfo.RecordCount, rows = list };
27             return ToJsonContent(result);
28         }/<testuserinfo>/<code>

面代碼處理了兩個部分的對象信息，一個是分頁實體類信息，一個是排序信息，然後根據這些條件獲取記錄，返回類似

<code>{total:22,rows:{}}/<code>

格式的JSON數據記錄。

<code>1 var result = new { total = pagerInfo.RecordCount, rows = list };
2 return ToJsonContent(result);/<code>

獲取分頁的參數信息如下所示

<code> 1 /// <summary>
 2         /// 根據Request參數獲取分頁對象數據
 3         /// /<summary>
 4         /// <returns>
 5         protected virtual PagerInfo GetPagerInfo()
 6         {
 7             int pageIndex = Request["page"] == null ? 1 : int.Parse(Request["page"]);
 8             int pageSize = Request["rows"] == null ? 10 : int.Parse(Request["rows"]);
 9 
10             PagerInfo pagerInfo = new PagerInfo(); 

11             pagerInfo.CurrenetPageIndex = pageIndex;
12             pagerInfo.PageSize = pageSize;
13 
14             return pagerInfo;
15         }/<code>

獲取排序參數信息的代碼如下所示

<code> 1 /// <summary>
 2         /// 獲取排序的信息
 3         /// /<summary>
 4         /// <returns>
 5         protected SortInfo GetSortOrder()
 6         {
 7             var name = Request["sort"];
 8             var order = Request["sortOrder"];
 9             return new SortInfo(name, order);
10         }/<code>

最後就是具體實現具體條件、具體頁碼、具體排序條件下的數據記錄了，這部分可以根據自己的要求實現邏輯，這裡只是給出一個封裝好的處理調用即可。

<code>baseBLL.FindWithPager(where, pagerInfo, sort.SortName, sort.IsDesc);/<code>

實際情況下，我們列表的展示，一般需要使用不同的條件進行數據的查詢的，雖然這個Bootstrap-table控件提供了一個默認的查詢按鈕，不過一般是在客戶端分頁的情況下使用，而且略顯簡單，我們一般使用自己查詢條件進行處理，如下界面所示。

或者如下：

那麼這樣對於上面的js屬性就需要調整下接受查詢條件參數queryParams 了

<code> 1 //得到查詢的參數
 2                 queryParams : function (params) {
 3                     //這裡的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也需要改成一樣的
 4                     var temp = {   
 5                         rows: params.limit,                         //頁面大小
 6                         page: (params.offset / params.limit) + 1,   //頁碼
 7                         sort: params.sort,      //排序列名  
 8                         sortOrder: params.order //排位命令（desc，asc） 
 9                     };
10                     return temp;
11                 },/<code>

對於自定義查詢條件，我們可以用下面的常規方式增加參數，如下所示

但是查詢條件的參數我們不方便一一設置，我們想通過一種較為快捷的方式來處理，那麼就需要對這個處理方式進行一個特別的修改了，首先添加一個擴展函數來處理表單的條件（參考博客http://www.cnblogs.com/zcsj/p/6635677.html的介紹）

<code> 1 //自定義函數處理queryParams的批量增加
 2         $.fn.serializeJsonObject = function () {
 3             var json = {};
 4             var form = this.serializeArray();
 5             $.each(form, function () {
 6                 if (json[this.name]) {
 7                     if (!json[this.name].push) {
 8                         json[this.name] = [json[this.name]];
 9                     }
10                     json[this.name].push();
11                 } else {
12                     json[this.name] = this.value || '';
13                 }
14             });
15             return json;
16         }/<code>

然後我們就可以批量處理表單的查詢條件了

<code> 1 queryParams : function (params) {
 2                     //這裡的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也需要改成一樣的
 3                     var temp = $("#ffSearch").serializeJsonObject();
 4                     temp["rows"] = params.limit;                        //頁面大小
 5                     temp["page"] = (params.offset / params.limit) + 1;  //頁碼
 6                     temp["sort"] = params.sort;                         //排序列名
 7                     temp["sortOrder"] = params.order;                   //排位命令（desc，asc） 
 8 
 9                     //特殊格式的條件處理 

10                     temp["WHC_Age"] = $("#WHC_Age").val() + "~" + $("#WHC_Age2").val();
11                     temp["WHC_BirthDate"] = $("#WHC_BirthDate").val() + "~" + $("#WHC_BirthDate2").val();
12 
13                     return temp;
14                 },/<code>

然後後端統一按照邏輯處理查詢參數即可。

3）格式化輸出函數及其他

對於上面JS的配置信息，我們再來回顧一下，例如對於數據轉義函數，可以格式化輸出的內容的，如下界面代碼。

格式化的數據轉義函數如下，主要就是根據內容進行格式化輸出的JS函數，好像是需要放在一個文件內。

<code> 1 //連接字段格式化
 2         function linkFormatter(value, row, index) {                
 3             return " ";
 4         }
 5         //Email字段格式化
 6         function emailFormatter(value, row, index) {
 7             return " ";
 8         }
 9         //性別字段格式化
10         function sexFormatter(value) {
11             if (value == "女") { color = 'Red'; }
12             else if (value == "男") { color = 'Green'; }
13             else { color = 'Yellow'; }
14 
15             return '
' + value + '
';
16         }/<code>

另外，我們看到行記錄的最後增加了幾個操作按鈕，方便對當前記錄的查看、編輯和刪除操作，如下效果圖所示。

這部分我們也是通過格式化函數進行處理的

<code> 1 //操作欄的格式化
 2         function actionFormatter(value, row, index) {
 3             var id = value;
 4             var result = "";
 5             result += " ";
 6             result += " ";
 7             result += " ";
 8 
 9             return result;
10         }/<code>

如果我們需要雙擊彈出編輯界面的層，我們可以處理表格的雙擊事件，如下代碼所示。

<code>1 onDblClickRow: function (row, $element) {
2                     var id = row.ID;
3                     EditViewById(id, 'view');
4                 },/<code>

如果我們需要設置行的不同的樣式展示，可以通過增加rowStyle的JS處理函數即可，如下代碼所示

<code>1 rowStyle: function (row, index) { //設置行的特殊樣式
2                     //這裡有5個取值顏色['active', 'success', 'info', 'warning', 'danger'];
3                     var strclass = "";
4                     if (index == 0) {
5                         strclass = "warning";
6                     } 

7                     return { classes: strclass }
8                 }/<code>

對於表格記錄的獲取，我們可以通過下面的代碼進行獲取：$table.bootstrapTable('getSelections')

<code>1   var rows = $table.bootstrapTable('getSelections');
2             if (rows.length > 0) {
3                 ID = rows[0].ID;
4             }/<code>

如果是多條記錄的處理，例如刪除記錄

<code> 1 //實現刪除數據的方法
 2         function Delete() {
 3             var ids = "";//得到用戶選擇的數據的ID
 4             var rows = $table.bootstrapTable('getSelections');
 5             for (var i = 0; i < rows.length; i++) {
 6                 ids += rows[i].ID + ',';
 7             }
 8             ids = ids.substring(0, ids.length - 1);
 9 
10             DeleteByIds(ids);
11         }/<code>

如果需要設置顯示列顯示，如下界面所示

以及排序處理

這些需要在JS代碼開啟相關的屬性即可。

還有就是一種CardView的卡片視圖格式，如下所示。

另外一種是父子表的展開明細的格式，如下所示

以上就是bootstrap-table插件在我實際項目中的應用情況，基本上對JS各個屬性的使用進行了一些介紹了，具體的應用我們可以參考它的文檔，獲取對應屬性、方法、事件的詳細說明，這樣我們就可以更加詳細的應用這個插件的各種功能了。

http://bootstrap-table.wenzhixin.net.cn/documentation/

PS：以上為轉載內容，經過自己的梳理後重新發布，感謝原作者伍華聰，原文路徑：https://www.cnblogs.com/wuhuacong/p/7284420.html

四、怎麼在Spring MVC及SpringBoot項目中使用Bootstrap-table進行分頁？

話不多說，直接上代碼。

前端代碼塊：

<code>　　頁面：
 1 <table>
　　JS:
 2 function initTable(){
 3             $('#test-table').bootstrapTable({
 4                 method: 'get',
 5                 toolbar: '#toolbar',    //工具按鈕用哪個容器
 6                 striped: true,      //是否顯示行間隔色
 7                 cache: false,      //是否使用緩存，默認為true，所以一般情況下需要設置一下這個屬性（*）
 8                 pagination: true,     //是否顯示分頁（*）
 9                 sortable: false,      //是否啟用排序
10                 sortOrder: "asc",     //排序方式
11                 pageNumber:1,      //初始化加載第一頁，默認第一頁 

12                 pageSize: 10,      //每頁的記錄行數（*）
13                 pageList: [10, 25, 50, 100],  //可供選擇的每頁的行數（*）
14                 url: "/testProject/page4list.json",//這個接口需要處理bootstrap table傳遞的固定參數
15                 queryParamsType:'', //默認值為 'limit' ,在默認情況下 傳給服務端的參數為：offset,limit,sort
16                                     // 設置為 ''  在這種情況下傳給服務器的參數為：pageSize,pageNumber
17 
18                 //queryParams: queryParams,//前端調用服務時，會默認傳遞上邊提到的參數，如果需要添加自定義參數，可以自定義一個函數返回請求參數
19                 sidePagination: "server",   //分頁方式：client客戶端分頁，server服務端分頁（*）
20                 //search: true,      //是否顯示錶格搜索，此搜索是客戶端搜索，不會進服務端，所以，個人感覺意義不大
21                 strictSearch: true,
22                 //showColumns: true,     //是否顯示所有的列
23                 //showRefresh: true,     //是否顯示刷新按鈕
24                 minimumCountColumns: 2,    //最少允許的列數
25                 clickToSelect: true,    //是否啟用點擊選中行
26                 searchOnEnterKey: true,
27                 columns: [{
28                     field: 'id',
29                     title: 'id',
30                     align: 'center'
31                 }, {
32                     field: 'testkey',
33                     title: '測試標識',
34                     align: 'center'
35                 }, {
36                     field: 'testname',
37                     title: '測試名字',
38                     align: 'center'
39                 },{
40                     field: 'id', 

41                     title: '操作',
42                     align: 'center',
43                     formatter:function(value,row,index){
44                         //通過formatter可以自定義列顯示的內容
45                         //value：當前field的值，即id
46                         //row：當前行的數據
47                         var a = ' ';
48                     } 
49                 }],
50                 pagination:true
51             });
52         }
在前端通過請求獲取table數據時，bootstrap table會默認拼一個 searchText的參數，來支持查詢功能。
服務端代碼：
<code> 1  @RequestMapping(value = "/page4list.json")
 2 public void page4list(Integer pageSize, Integer pageNumber, String searchText, HttpServletRequest request,
 3             HttpServletResponse response) {
 4 
 5         //搜索框功能
 6         //當查詢條件中包含中文時，get請求默認會使用ISO-8859-1編碼請求參數，在服務端需要對其解碼
 7         if (null != searchText) {
 8             try {
 9                 searchText = new String(searchText.getBytes("ISO-8859-1"), "UTF-8");
10             } catch (Exception e) {
11                 e.printStackTrace();
12             }
13         }
14         //在service通過條件查詢獲取指定頁的數據的list
15         List<mwmsgtype> list = mwMsgQueueService.page4List(pageSize, pageNumber, searchText);
16         //根據查詢條件，獲取符合查詢條件的數據總量
17         int total = mwMsgQueueService.queryCountBySearchText(searchText);
18         //自己封裝的數據返回類型，bootstrap-table要求服務器返回的json數據必須包含：totlal，rows兩個節點 

19         PageResultForBootstrap page = new PageResultForBootstrap();
20         page.setTotal(total);
21         page.setRows(list);
22         //page就是最終返回給客戶端的數據結構，可以直接返回給前端
23 
24         //下邊這段，只是我自己的代碼有自定義的spring HandlerInterceptor處理返回值，可以忽略。
25         request.setAttribute(Constants.pageResultData, page);
26 
27     }/<mwmsgtype>/<code>
 完成上述代碼，即可實現服務器端自動分頁，bootstrap-table根據服務器端返回的total，以及table設定的pageSize，自動生成分頁的頁面元素，每次點擊下一頁或者指定頁碼，bootstrap-table會自動給參數pageNumber賦值，服務器返回指定頁的數據。
如果發送的是post請求，因為bootstap table使用的是ajax方式獲取數據，這時會將請求的content type默認設置為 text/plain，這樣在服務端直接通過 @RequestParam參數映射是獲取不到的。
這時就需要在bootstrap-table的參數列表中顯式設置：
<code>1 contentType: "application/x-www-form-urlencoded"/<code>
設置成form表單的形式，tomcat內部就會自動將requset payload中的數據部分解析放到request.getParameter()中，之後就可以直接通過@RequestParam映射參數獲取。 
"/<table>/<code>

閱讀更多 Java墊腳石 的文章

關鍵字: HTML5 總結 JavaScript