JS表格组件神器bootstraptable详解（基础版）
⼀、Bootstrap Table的引⼊
关于Bootstrap Table的引⼊，⼀般来说还是两种⽅法：
1、直接下载源码，添加到项⽬⾥⾯来。
由于是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>
jquery是什么功能组件</head>
<body>
<div class="panel-body" >
<div class="panel panel-default">
<div class="panel-heading">查询条件</div>
<div class="panel-body">
<form id="formSearch" class="form-horizontal">
<div class="form-group" >
<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" >
<button type="button" 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标签⾥⾯定义类
似“”等相关属性，就不⽤再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可以设置表格的搜索框出现并且可以进⾏模糊搜索。但是这个时候问题来了，我们采⽤的是服务端分页，每次返回到前台的只有本页的数据，这个时候我们再搜索的时候发现：搜索不了。这是什么原因呢？博主在⾕歌⾥⾯调试bootstrap-table.js这个js发现⾥⾯有这样⼀段逻辑：
Search = function (event) {
var text = $.trim($(event.currentTarget).val());
// trim search input
if (imOnSearch && $(event.currentTarget).val() !== text) {
$(event.currentTarget).val(text);
}
if (text === this.searchText) {
return;
}
this.searchText = text;
this.options.pageNumber = 1;
this.initSearch();
this.updatePagination();
};
BootstrapTable.prototype.initSearch = function () {
var that = this;
if (this.options.sidePagination !== 'server') {
var s = this.searchText && LowerCase();
var f = $.isEmptyObject(this.filterColumns) ? null : this.filterColumns;
// Check filter
this.data = f ? $.grep(this.options.data, function (item, i) {
for (var key in f) {
if (item[key] !== f[key]) {
return false;
}
}
return true;
}) : this.options.data;
this.data = s ? $.grep(this.data, function (item, i) {
for (var key in item) {
key = $.isNumeric(key) ? parseInt(key, 10) : key;
var value = item[key],
column = lumns[lumns, key)],
j = $.inArray(key, that.header.fields);
// Fix #142: search use formated data
if (column && column.searchFormatter) {
value = calculateObjectValue(column,
that.header.formatters[j], [value, item, i], value);
}
var index = $.inArray(key, that.header.fields);
if (index !== -1 && that.header.searchables[index] && (typeof value === 'string' || typeof value === 'number')) {
if (that.options.strictSearch) {
if ((value + '').toLowerCase() === s) {
return true;
}
} else {
if ((value + '').toLowerCase().indexOf(s) !== -1) {
return true;
}
}
}
}
return false;
}) : this.data;
}
};
在initSearch⽅法⾥⾯，它有⼀个判断：if (this.options.sidePagination !== 'server') {......}也就是说，如果不是服务端分页，才进⼊检索，重写加载表格，否则压根就不会进⼊检索，这也就是为什么服务分页的时候，搜索会不起作⽤。博主试了下，换成客户端分页，确实可以搜索。呵呵，原来如此。其实这也很好⾥⾯，过滤本页的数据，意义不⼤。
5、关于Bootstrap Table的排序，由于⼀般这种BS系统肯定会采⽤服务端分页，我们如果仅仅在js⾥⾯设置sortable和sortOrder等属性信息，表格是不会有效排序的。原因很简单，服务端分页的⽅式，排序本页数据意义不⼤。所以，⼀般的排序需要将排序⽅式和排序字段发送到后台，在后台排序⽐较合适。⽐如我们这⾥可以再参数⾥⾯增加两个：
oTableInit.queryParams = function (params) {
var temp = { //这⾥的键的名字和控制器的变量名必须⼀直，这边改动，控制器也需要改成⼀样的
limit: params.limit, //页⾯⼤⼩
offset: params.offset, //页码
order: der,
ordername: params.sort,
departmentname: $("#txt_search_departmentname").val(),
statu: $("#txt_search_statu").val()
};
return temp;
};
五、总结
在开发经历中，也使⽤Jqgrid、EasyUI等表格组件。相⽐⽽⾔，有⾃⼰的优势：
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论