基於Metronic的Bootstrap開發框架經驗總結（16）-- 使用插件bootstrap-table實現表格記錄的查詢、分頁、排序等處理

時間 2019-11-08

標籤基於 metronic bootstrap 開發框架經驗總結使用插件 table 實現表格記錄查詢分頁排序處理欄目 Bootstarp 简体版

原文原文鏈接

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

一、Bootstrap-table資源及使用介紹

在GitHub上Bootstrap-table的源碼地址是：https://github.com/wenzhixin/bootstrap-tablecss

Bootstrap-table的文檔地址：http://bootstrap-table.wenzhixin.net.cn/html

Bootstrap-table的各類樣例：https://github.com/wenzhixin/bootstrap-table-examplesjava

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

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

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

Bootstrap-table是基於Boostrap開發的插件，所以使用的時候，須要引入Bootstrap的腳本和樣式。數據庫

若是咱們項目中沒有引入相關的文件，則須要引入這些樣式和腳本文件，以下所示。json

<link rel="stylesheet" href="bootstrap.min.css">

<script src="jquery.min.js"></script>
<script src="bootstrap.min.js"></script>

不過以上內容，在咱們開發項目的時候都確定有的了，因此咱們仍是把中心放到使用這個插件所須要的引入文件上來。bootstrap

CSS文件引入

<link rel="stylesheet" href="bootstrap-table.css">

腳本文件引入

<script src="bootstrap-table.js"></script>
<--漢化文件，放在 bootstrap-table.js 後面-->
<script src="bootstrap-table-zh-CN.js"></script>

通常來講咱們若是是基於MVC開發的系統，CSS和JS的代碼，都是放在BundleConfig.cs裏面初始化的，以下所示

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

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

<table data-toggle="table" data-url="data1.json">
    <thead>
        <tr>
            <th data-field="id">Item ID</th>
            <th data-field="name">Item Name</th>
            <th data-field="price">Item Price</th>
        </tr>
    </thead>
</table>

若是咱們採用JS代碼方式來初始化表格插件，那麼只須要在HTML上聲明一個表格對象便可，以下代碼。

<table id="table"></table>

而後簡單的JS代碼初始化以下所示

$('#table').bootstrapTable({
    url: 'data1.json',
    columns: [{
        field: 'id',
        title: 'Item ID'
    }, {
        field: 'name',
        title: 'Item Name'
    }, {
        field: 'price',
        title: 'Item Price'
    }, ]
});

不過實際上咱們使用 bootstrap-table的JS配置功能確定比這個複雜不少，下面界面效果是實際表的數據展現。

二、bootstrap-table的詳細使用

1）整個JS屬性配置

在上圖中，咱們是使用JS方式進行初始化表格內容的，JS代碼以下所示

        var $table;
        //初始化bootstrap-table的內容
        function InitMainTable () {
            //記錄頁面bootstrap-table全局變量$table，方便應用
            var queryUrl = '/TestUser/FindWithPager?rnd=' + Math.random()
            $table = $('#grid').bootstrapTable({
                url: queryUrl,                      //請求後臺的URL（*）
                method: 'GET',                      //請求方式（*）
                //toolbar: '#toolbar',              //工具按鈕用哪一個容器
                striped: true,                      //是否顯示行間隔色
                cache: false,                       //是否使用緩存，默認爲true，因此通常狀況下須要設置一下這個屬性（*）
                pagination: true,                   //是否顯示分頁（*）
                sortable: true,                     //是否啓用排序
                sortOrder: "asc",                   //排序方式
                sidePagination: "server",           //分頁方式：client客戶端分頁，server服務端分頁（*）
                pageNumber: 1,                      //初始化加載第一頁，默認第一頁,並記錄
                pageSize: rows,                     //每頁的記錄行數（*）
                pageList: [10, 25, 50, 100],        //可供選擇的每頁的行數（*）
                search: false,                      //是否顯示錶格搜索
                strictSearch: true,
                showColumns: true,                  //是否顯示全部的列（選擇顯示的列）
                showRefresh: true,                  //是否顯示刷新按鈕
                minimumCountColumns: 2,             //最少容許的列數
                clickToSelect: true,                //是否啓用點擊選中行
                //height: 500,                      //行高，若是沒有設置height屬性，表格自動根據記錄條數以爲表格高度
                uniqueId: "ID",                     //每一行的惟一標識，通常爲主鍵列
                showToggle: true,                   //是否顯示詳細視圖和列表視圖的切換按鈕
                cardView: false,                    //是否顯示詳細視圖
                detailView: false,                  //是否顯示父子表
                //獲得查詢的參數
                queryParams : function (params) {
                    //這裏的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也須要改爲同樣的
                    var temp = {   
                        rows: params.limit,                         //頁面大小
                        page: (params.offset / params.limit) + 1,   //頁碼
                        sort: params.sort,      //排序列名  
                        sortOrder: params.order //排位命令（desc，asc） 
                    };
                    return temp;
                },
                columns: [{
                    checkbox: true,  
                    visible: true                  //是否顯示覆選框  
                }, {
                    field: 'Name',
                    title: '姓名',
                    sortable: true
                }, {
                    field: 'Mobile',
                    title: '手機',
                    sortable: true
                }, {
                    field: 'Email',
                    title: '郵箱',
                    sortable: true,
                    formatter: emailFormatter
                }, {
                    field: 'Homepage',
                    title: '主頁',
                    formatter: linkFormatter
                }, {
                    field: 'Hobby',
                    title: '興趣愛好'
                }, {
                    field: 'Gender',
                    title: '性別',
                    sortable: true
                }, {
                    field: 'Age',
                    title: '年齡'
                }, {
                    field: 'BirthDate',
                    title: '出生日期',
                    formatter: dateFormatter
                }, {
                    field: 'Height',
                    title: '身高'
                }, {
                    field: 'Note',
                    title: '備註'
                }, {
                    field:'ID',
                    title: '操做',
                    width: 120,
                    align: 'center',
                    valign: 'middle',
                    formatter: actionFormatter
                }, ],
                onLoadSuccess: function () {
                },
                onLoadError: function () {
                    showTips("數據加載失敗！");
                },
                onDblClickRow: function (row, $element) {
                    var id = row.ID;
                    EditViewById(id, 'view');
                },
            });
        };

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

2）查詢及分頁

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

                //獲得查詢的參數
                queryParams : function (params) {
                    //這裏的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也須要改爲同樣的
                    var temp = {   
                        rows: params.limit,                         //頁面大小
                        page: (params.offset / params.limit) + 1,   //頁碼
                        sort: params.sort,      //排序列名  
                        sortOrder: params.order //排位命令（desc，asc） 
                    };
                    return temp;
                },

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

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

            string where = GetPagerCondition();
            PagerInfo pagerInfo = GetPagerInfo();
            var sort = GetSortOrder();

            List<TestUserInfo> list = null;
            if (sort != null && !string.IsNullOrEmpty(sort.SortName))
            {
                list = baseBLL.FindWithPager(where, pagerInfo, sort.SortName, sort.IsDesc);
            }
            else
            {
                list = baseBLL.FindWithPager(where, pagerInfo);
            } 

            //Json格式的要求{total:22,rows:{}}
            //構形成Json的格式傳遞
            var result = new { total = pagerInfo.RecordCount, rows = list };
            return ToJsonContent(result);
        }

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

{total:22,rows:{}}

格式的JSON數據記錄。

            var result = new { total = pagerInfo.RecordCount, rows = list };
            return ToJsonContent(result);

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

        /// <summary>
        /// 根據Request參數獲取分頁對象數據
        /// </summary>
        /// <returns></returns>
        protected virtual PagerInfo GetPagerInfo()
        {
            int pageIndex = Request["page"] == null ? 1 : int.Parse(Request["page"]);
            int pageSize = Request["rows"] == null ? 10 : int.Parse(Request["rows"]);

            PagerInfo pagerInfo = new PagerInfo();
            pagerInfo.CurrenetPageIndex = pageIndex;
            pagerInfo.PageSize = pageSize;

            return pagerInfo;
        }

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

        /// <summary>
        /// 獲取排序的信息
        /// </summary>
        /// <returns></returns>
        protected SortInfo GetSortOrder()
        {
            var name = Request["sort"];
            var order = Request["sortOrder"];
            return new SortInfo(name, order);
        }

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

baseBLL.FindWithPager(where, pagerInfo, sort.SortName, sort.IsDesc);

實際狀況下，咱們列表的展現，通常須要使用不一樣的條件進行數據的查詢的，雖然這個Bootstrap-table控件提供了一個默認的查詢按鈕，不過通常是在客戶端分頁的狀況下使用，並且略顯簡單，咱們通常使用本身查詢條件進行處理，以下界面所示。

或者以下的

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

                //獲得查詢的參數
                queryParams : function (params) {
                    //這裏的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也須要改爲同樣的
                    var temp = {   
                        rows: params.limit,                         //頁面大小
                        page: (params.offset / params.limit) + 1,   //頁碼
                        sort: params.sort,      //排序列名  
                        sortOrder: params.order //排位命令（desc，asc） 
                    };
                    return temp;
                },

對於自定義查詢條件，咱們能夠用下面的常規方式增長參數，以下所示

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

        //自定義函數處理queryParams的批量增長
        $.fn.serializeJsonObject = function () {
            var json = {};
            var form = this.serializeArray();
            $.each(form, function () {
                if (json[this.name]) {
                    if (!json[this.name].push) {
                        json[this.name] = [json[this.name]];
                    }
                    json[this.name].push();
                } else {
                    json[this.name] = this.value || '';
                }
            });
            return json;
        }

而後咱們就能夠批量處理表單的查詢條件了

                queryParams : function (params) {
                    //這裏的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也須要改爲同樣的
                    var temp = $("#ffSearch").serializeJsonObject();
                    temp["rows"] = params.limit;                        //頁面大小
                    temp["page"] = (params.offset / params.limit) + 1;  //頁碼
                    temp["sort"] = params.sort;                         //排序列名
                    temp["sortOrder"] = params.order;                   //排位命令（desc，asc） 

                    //特殊格式的條件處理
                    temp["WHC_Age"] = $("#WHC_Age").val() + "~" + $("#WHC_Age2").val();
                    temp["WHC_BirthDate"] = $("#WHC_BirthDate").val() + "~" + $("#WHC_BirthDate2").val();

                    return temp;
                },

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

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

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

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

        //鏈接字段格式化
        function linkFormatter(value, row, index) {                
            return "<a href='" + value + "' title='單擊打開鏈接' target='_blank'>" + value + "</a>";
        }
        //Email字段格式化
        function emailFormatter(value, row, index) {
            return "<a href='mailto:" + value + "' title='單擊打開鏈接'>" + value + "</a>";
        }
        //性別字段格式化
        function sexFormatter(value) {
            if (value == "女") { color = 'Red'; }
            else if (value == "男") { color = 'Green'; }
            else { color = 'Yellow'; }

            return '<div  style="color: ' + color + '">' + value + '</div>';
        }

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

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

        //操做欄的格式化
        function actionFormatter(value, row, index) {
            var id = value;
            var result = "";
            result += "<a href='javascript:;' class='btn btn-xs green' onclick=\"EditViewById('" + id + "', view='view')\" title='查看'><span class='glyphicon glyphicon-search'></span></a>";
            result += "<a href='javascript:;' class='btn btn-xs blue' onclick=\"EditViewById('" + id + "')\" title='編輯'><span class='glyphicon glyphicon-pencil'></span></a>";
            result += "<a href='javascript:;' class='btn btn-xs red' onclick=\"DeleteByIds('" + id + "')\" title='刪除'><span class='glyphicon glyphicon-remove'></span></a>";

            return result;
        }

若是咱們須要雙擊彈出編輯界面的層，咱們能夠處理表格的雙擊事件，以下代碼所示。

                onDblClickRow: function (row, $element) {
                    var id = row.ID;
                    EditViewById(id, 'view');
                },

若是咱們須要設置行的不一樣的樣式展現，能夠經過增長rowStyle的JS處理函數便可，以下代碼所示

                rowStyle: function (row, index) { //設置行的特殊樣式
                    //這裏有5個取值顏色['active', 'success', 'info', 'warning', 'danger'];
                    var strclass = "";
                    if (index == 0) {
                        strclass = "warning";
                    }
                    return { classes: strclass }
                }

對於表格記錄的獲取，咱們能夠經過下面的代碼進行獲取：$table.bootstrapTable('getSelections')

            var rows = $table.bootstrapTable('getSelections');
            if (rows.length > 0) {
                ID = rows[0].ID;
            }

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

        //實現刪除數據的方法
        function Delete() {
            var ids = "";//獲得用戶選擇的數據的ID
            var rows = $table.bootstrapTable('getSelections');
            for (var i = 0; i < rows.length; i++) {
                ids += rows[i].ID + ',';
            }
            ids = ids.substring(0, ids.length - 1);

            DeleteByIds(ids);
        }