基于Metronic的Bootstrap开发框架经验总结（16）-- 使用插件bootstrap-table实现表格记录的查询、分页、排序等处理

在业务系统开发中，对表格记录的查询、分页、排序等处理是非常常见的，在Web开发中，可以采用很多功能强大的插件来满足要求，且能极大的提高开发效率，本随笔介绍这个bootstrap-table是一款非常有名的开源表格插件，在很多项目中广泛的应用。Bootstrap-table插件提供了非常丰富的属性设置，可以实现查询、分页、排序、复选框、设置显示列、Card view视图、主从表显示、合并列、国际化处理等处理功能，而且该插件同时也提供了一些不错的扩展功能，如移动行、移动列位置等一些特殊的功能，插件可以用基于HTML5的data-*属性标识设置，也可以使用Javascript方式进行设置，非常方便。本篇随笔介绍bootstrap-table插件在我实际项目中的应用情况，总结相关使用中碰到的问题处理经验。

1、Bootstrap-table资源及使用介绍

在GitHub上Bootstrap-table的源码地址是：

Bootstrap-table的文档地址：

Bootstrap-table的各种样例：

Bootstrap-Table显示数据到表格的方式有两种，一种是客户端（client）模式，一种是服务器（server）模式。

　　所谓客户端模式，指的是在服务器中把要显示到表格的数据一次性加载出来，然后转换成JSON格式传到要显示的界面中，客户端模式较为简单，它是把数据一次性加载出来放到界面上，然后根据你设置的每页记录数，自动生成分页。当点击第二页时，会自动加载出数据，不会再向服务器发送请求。同时用户可以使用其自带的搜索功能，可以实现全数据搜索。对于数据量较少的时候，可以使用这个方法。

　　所谓服务器模式，指的是根据设定的每页记录数和当前要显示的页码，发送数据到服务器进行查询，然后再显示到表格中。该方法可以根据用户的需要动态的加载数据，节省了服务器的资源，但是不能使用其自带的全数据搜索功能。

Bootstrap-table是基于Boostrap开发的插件，因此使用的时候，需要引入Bootstrap的脚本和样式。

如果我们项目中没有引入相关的文件，则需要引入这些样式和脚本文件，如下所示。

不过以上内容，在我们开发项目的时候都肯定有的了，所以我们还是把中心放到使用这个插件所需要的引入文件上来。

CSS文件引入

脚本文件引入

一般来说我们如果是基于MVC开发的系统，CSS和JS的代码，都是放在BundleConfig.cs里面初始化的，如下所示

bootstrap-table在页面中的使用，可以分为两种，一种是纯粹用HTML5的写法，通过data-*的方式指定各种属性设置，一种是HTML+JS方式实现弹性设置。

如果我们采用HTML5标识的方式初始化HTML代码，则是下面的代码。

Item ID Item Name Item Price

如果我们采用JS代码方式来初始化表格插件，那么只需要在HTML上声明一个表格对象即可，如下代码。

然后简单的JS代码初始化如下所示

$('#table''data1.json''id''Item ID''name''Item Name''price''Item Price'

不过实际上我们使用 bootstrap-table的JS配置功能肯定比这个复杂很多，下面界面效果是实际表的数据展示。

2、bootstrap-table的详细使用

1）整个JS属性配置

在上图中，我们是使用JS方式进行初始化表格内容的，JS代码如下所示

queryUrl = '/TestUser/FindWithPager?rnd=' += $('#grid' method: 'GET', striped: , cache: , pagination: , sortable: , sortOrder: "asc", sidePagination: "server", pageNumber: 1, pageSize: rows, pageList: [10,25,50,100], search: , strictSearch: , showRefresh: , minimumCountColumns: 2, clickToSelect: , uniqueId: "ID", showToggle: , cardView: , detailView: , queryParams : temp = page: (params.offset / params.limit) + 1, sort: params.sort, sortOrder: params.order 'Name''姓名''Mobile''手机''Email''邮箱''Homepage''主页''Hobby''兴趣爱好''Gender''性别''Age''年龄''BirthDate''出生日期''Height''身高''Note''备注''ID''操作'120'center''middle'"数据加载失败！" id ='view'

上面JS代码的配置属性，基本上都加了注释说明，是比较容易理解的了。

2）查询及分页

这里的表格数据分页是采用服务器分页的方式，根据搜索条件从服务器返回数据记录的，并使用了排序的处理方式，这里的queryParams参数就是提交到服务器端的参数了

queryParams : temp =

另外我们看到返回数据的URL地址接口是FindWithPager，我们来看看这个MVC控制器方法是如何处理数据返回的。

        </span><span style="color: #0000ff;"&gt;string</span> <span style="color: #0000ff;"&gt;where</span> =<span style="color: #000000;"&gt; GetPagerCondition();
        PagerInfo pagerInfo </span>=<span style="color: #000000;"&gt; GetPagerInfo();
        </span><span style="color: #0000ff;"&gt;var</span> sort =<span style="color: #000000;"&gt; GetSortOrder();

        List</span><TestUserInfo> list = <span style="color: #0000ff;"&gt;null</span><span style="color: #000000;"&gt;;
        </span><span style="color: #0000ff;"&gt;if</span> (sort != <span style="color: #0000ff;"&gt;null</span> &amp;&amp; !<span style="color: #0000ff;"&gt;string</span><span style="color: #000000;"&gt;.IsNullOrEmpty(sort.SortName))
        {
            list </span>= baseBLL.FindWithPager(<span style="color: #0000ff;"&gt;where</span><span style="color: #000000;"&gt;,pagerInfo,sort.SortName,sort.IsDesc);
        }
        </span><span style="color: #0000ff;"&gt;else</span><span style="color: #000000;"&gt;
        {
            list </span>= baseBLL.FindWithPager(<span style="color: #0000ff;"&gt;where</span><span style="color: #000000;"&gt;,pagerInfo);
        } 

        </span><span style="color: #008000;"&gt;//</span><span style="color: #008000;"&gt;Json格式的要求{total:22,rows:{}}
        </span><span style="color: #008000;"&gt;//</span><span style="color: #008000;"&gt;构造成Json的格式传递</span>
        <span style="color: #0000ff;"&gt;var</span> result = <span style="color: #0000ff;"&gt;new</span> { total = pagerInfo.RecordCount,rows =<span style="color: #000000;"&gt; list };
        </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; ToJsonContent(result);
    }</span></pre>

上面代码处理了两个部分的对象信息，一个是分页实体类信息，一个是排序信息，然后根据这些条件获取记录，返回类似

{total:22,rows:{}}

格式的JSON数据记录。

result = { total = pagerInfo.RecordCount,rows = ToJsonContent(result);

获取分页的参数信息如下所示

pageIndex = Request[] == ? : .Parse(Request[ pageSize = Request[] == ? : .Parse(Request[

        PagerInfo pagerInfo </span>= <span style="color: #0000ff;"&gt;new</span><span style="color: #000000;"&gt; PagerInfo();
        pagerInfo.CurrenetPageIndex </span>=<span style="color: #000000;"&gt; pageIndex;
        pagerInfo.PageSize </span>=<span style="color: #000000;"&gt; pageSize;

        </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; pagerInfo;
    }</span></pre>

获取排序参数信息的代码如下所示

name = Request[ order = Request[

最后就是具体实现具体条件、具体页码、具体排序条件下的数据记录了，这部分可以根据自己的要求实现逻辑，这里只是给出一个封装好的处理调用即可。

baseBLL.FindWithPager(,sort.IsDesc);

实际情况下，我们列表的展示，一般需要使用不同的条件进行数据的查询的，虽然这个Bootstrap-table控件提供了一个默认的查询按钮，不过一般是在客户端分页的情况下使用，而且略显简单，我们一般使用自己查询条件进行处理，如下界面所示。

或者如下的

那么这样对于上面的js属性就需要调整下接受查询条件参数queryParams 了

queryParams : temp =

对于自定义查询条件，我们可以用下面的常规方式增加参数，如下所示

但是查询条件的参数我们不方便一一设置，我们想通过一种较为快捷的方式来处理，那么就需要对这个处理方式进行一个特别的修改了，首先添加一个扩展函数来处理表单的条件（参考博客http://www.cnblogs.com/zcsj/p/6635677.html的介绍）

$.fn.serializeJsonObject = json = form = (json[ (!json[.name] = [json[.name] = .value || ''

然后我们就可以批量处理表单的查询条件了

queryParams : temp = $("#ffSearch""rows"] = params.limit; temp["page"] = (params.offset / params.limit) + 1; temp["sort"] = params.sort; temp["sortOrder"] = params.order;

                <span style="color: #008000;"&gt;//</span><span style="color: #008000;"&gt;特殊格式的条件处理</span>
                temp["WHC_Age"] = $("#WHC_Age").val() + "~" + $("#WHC_Age2"<span style="color: #000000;"&gt;).val();
                temp[</span>"WHC_BirthDate"] = $("#WHC_BirthDate").val() + "~" + $("#WHC_BirthDate2"<span style="color: #000000;"&gt;).val();

                </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; temp;
            },</span></pre>

然后后端统一按照逻辑处理查询参数即可。

3）格式化输出函数及其他

对于上面JS的配置信息，我们再来回顾一下，例如对于数据转义函数，可以格式化输出的内容的，如下界面代码。

格式化的数据转义函数如下，主要就是根据内容进行格式化输出的JS函数，好像是需要放在一个文件内。

"" + value + "" "" + value + "" (value == "女") { color = 'Red' (value == "男") { color = 'Green' { color = 'Yellow'

        </span><span style="color: #0000ff;"&gt;return</span> '<div  style="color: ' + color + '"&gt;' + value + '</div>'<span style="color: #000000;"&gt;;
    }</span></pre>

另外，我们看到行记录的最后增加了几个操作按钮，方便对当前记录的查看、编辑和删除操作，如下效果图所示。

502ec6ea59b423eb.png" alt="">

这部分我们也是通过格式化函数进行处理的

id = result = ""+= ""+= ""+= ""

        </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; result;
    }</span></pre>

如果我们需要双击弹出编辑界面的层，我们可以处理表格的双击事件，如下代码所示。

onDblClickRow:

如果我们需要设置行的不同的样式展示，可以通过增加rowStyle的JS处理函数即可，如下代码所示

rowStyle: (row,index) { strclass = "" (index == 0= "warning"

对于表格记录的获取，我们可以通过下面的代码进行获取：$table.bootstrapTable('getSelections')

rows = $table.bootstrapTable('getSelections' (rows.length > 0= rows[0

如果是多条记录的处理，例如删除记录

删除数据的方法 ids = "";用户选择的数据的ID rows = $table.bootstrapTable('getSelections' ( i = 0; i < rows.length; i+++= rows[i].ID + ','= ids.substring(0,ids.length - 1

        DeleteByIds(ids);
    }</span></pre>

如果需要设置显示列显示，如下界面所示

以及排序处理

这些需要在JS代码开启相关的属性即可。

还有就是一种CardView的卡片视图格式，如下所示。

另外一种是父子表的展开明细的格式，如下所示

以上就是bootstrap-table插件在我实际项目中的应用情况，基本上对JS各个属性的使用进行了一些介绍了，具体的应用我们可以参考它的文档，获取对应属性、方法、事件的详细说明，这样我们就可以更加详细的应用这个插件的各种功能了。

希望上面的总结介绍对你使用bootstrap-table插件有所助益，感谢耐心阅读。