使用bootstraptable插件实现表格记录的查询、分页、排序操作
在业务系统开发中,对表格记录的查询、分页、排序等处理是非常常见的,在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的脚本和样式。
如果我们项目中没有引入相关的文件,则需要引入这些样式和脚本文件,如下所示。
<link rel="stylesheet" href="bootstrap.min.css" rel="external nofollow" > <script src="jquery.min.js"></script> <script src="bootstrap.min.js"></script>
不过以上内容,在我们开发项目的时候都肯定有的了,所以我们还是把中心放到使用这个插件所需要的引入文件上来。
css文件引入
<link rel="stylesheet" href="bootstrap-table.css" rel="external nofollow" >
脚本文件引入
<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配置功能肯定比这个复杂很多,下面界面效果是实际表的数据展示。
2、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; },
对于自定义查询条件,我们可以用下面的常规方式增加参数,如下所示
但是查询条件的参数我们不方便一一设置,我们想通过一种较为快捷的方式来处理,那么就需要对这个处理方式进行一个特别的修改了,首先添加一个扩展函数来处理表单的条件
//自定义函数处理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); }
如果需要设置显示列显示,如下界面所示
以及排序处理
这些需要在js代码开启相关的属性即可。
还有就是一种cardview的卡片视图格式,如下所示。
另外一种是父子表的展开明细的格式,如下所示
以上就是bootstrap-table插件在我实际项目中的应用情况,基本上对js各个属性的使用进行了一些介绍了,具体的应用我们可以参考它的文档,获取对应属性、方法、事件的详细说明,这样我们就可以更加详细的应用这个插件的各种功能了。
总结
以上所述是小编给大家介绍的使用bootstraptable插件实现表格记录的查询、分页、排序操作,希望对大家有所帮助
下一篇: jQuery实现菜单栏导航效果