使用bootstrap table小記（表格組件）

時間 2019-11-08

標籤使用 bootstrap table 表格組件欄目 Bootstarp 简体版

原文原文鏈接

前言

新的一年悄然到來，生活依舊。最近一週大熱的趙雷風，一首《成都》,一首《理想》再次把民謠展現在國人面前。歌詞着實寫的不錯。css

理想，你今年幾歲html

你老是誘惑着年輕的朋友前端

你老是謝了又開給我驚喜jquery

又讓我沉入失望的生活裏git

。。。。github

我已不是無悔的那個青年bootstrap

青春被時光拋棄後端

已經是當父親的年紀瀏覽器

理想永遠都年輕緩存

你讓我倔強的反抗着命運

你讓我變得蒼白

卻依然天真的相信

花兒會再次的怒放

等等，這和咱們今天的主題貌似沒半毛錢關係。好了，再扯就扯遠了，今天和你們分享的是 Bootstrap Table 點我查看效果

或者直接看簡版效果以下（一個簡單的後臺管理，實現了增刪查改）：

bottstrap相關

既然說是bootstrap table 那確定是bootstrap實現的（這是句廢話）。

關於bottstrap相關文檔以下：

Bootstrap中文網：http://www.bootcss.com/

Bootstrap Table Demo：http://issues.wenzhixin.net.cn/bootstrap-table/index.html

Bootstrap Table API：http://bootstrap-table.wenzhixin.net.cn/zh-cn/documentation/

Bootstrap Table源碼：https://github.com/wenzhixin/bootstrap-table

Bootstrap DataPicker：http://www.bootcss.com/p/bootstrap-datetimepicker/

Boostrap Table 擴展API：http://bootstrap-table.wenzhixin.net.cn/extensions/

Bootstrap離線API

Bootstrap Table 離線API

bottstrap引入

關於引入有兩種方式，一種是直接下載源碼，而後放到項目中，bottstrap包能夠到http://v3.bootcss.com/ 中找到。

第二種方法就是使用打開Nuget，搜索這兩個包

而Bootstrap Table的版本居然是0.4，這也太坑爹了。因此博主建議Bootstrap Table的包就直接在源碼裏面去下載吧。Bootstrap Table最新的版本好像是1.9.0。

代碼解析

@{
    Layout = null;
}
<!DOCTYPE html>
<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>BootStrap Table使用</title>
    @*一、Jquery組件引用*@
    <script src="~/Scripts/jquery-1.10.2.js"></script>

    @*二、bootstrap組件引用*@
    <script src="~/Content/bootstrap/bootstrap.js"></script>
    <link href="~/Content/bootstrap/bootstrap.css" rel="stylesheet" />
    
    @*三、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>
    
    @*四、頁面Js文件的引用*@
    <script src="~/Scripts/Home/Index.js"></script>
</head>
<body>
    <div class="panel-body" style="padding-bottom:0px;">
        <div class="panel panel-default">
            <div class="panel-heading">查詢條件</div>
            <div class="panel-body">
                <form id="formSearch" class="form-horizontal">
                    <div class="form-group" style="margin-top:15px">
                        <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" style="text-align:left;">
                            <button type="button" style="margin-left:50px" 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標籤裏面定義相似「data-...」等相關屬性，就不用再js裏面註冊了，但博主以爲這種用法雖然簡單，但不太靈活，遇到父子表等這些高級用法的時候就不太好處理了，因此我們仍是統一使用在js裏面初始化的方式來使用table組件。

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: 'MethodName',
title: '方法名'
}, {
field: 'OperType',
title: '日誌類型'
}, {
field: 'LogFormat',
title: '內容格式'
}, {
field: 'ParamterValues',
title: '格式參數'
}, {
field: 'LogSql',
title: '數值'
}, {
field: 'SQLParamter',
title: '數值定義'
}, {
field: 'CreateDate',
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就能搞定。

注：若是須要隱藏某列，只須要便可

$('#tb_departments').bootstrapTable('hideColumn', '列名');

顯示某列

$('#tableOrderRealItems').bootstrapTable('showColumn', '列名');

在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兩個參數。漏寫或錯寫都會致使表格沒法顯示數據。相反，若是是客戶端分頁，這裏要返回一個集合對象到前端。

效果及說明

小結

第一個問題上面說過，若是在js裏面初始化的參數 sidePagination: "server" 設置爲在服務端分頁，那麼咱們的返回值必須告訴前端總記錄的條數和當前頁的記錄數，而後前端才知道如何分頁。而且最重要的一點，這兩個參數的名字必須爲total和rows。最開始博主也不知道這個，寫成了total和row，結果是請求能夠進到後臺的GetDepartment方法，返回值total和row也都有值，但是前端就是顯示以下：

找了好半天緣由。原來是row寫錯了，應該寫成rows。

第二個問題就是關於bootstrap頁面樣式的問題，咱們使用過bootstrap的朋友應該知道，它裏面全部的圖標都是經過class = "glyphicon glyphicon-plus"這種方式去寫的。博主按要求這樣作了，但是新增、修改、刪除前面的圖標怎麼都出不來。以下：

怎麼回事呢？而後各類百度，最後發現原來是fonts文件夾的問題。咱們在新建一個MVC項目的時候，會自動建立一個fonts文件夾，裏面內容以下：

而咱們的bootstrap.css是放在Content文件夾裏面的，這樣就致使找不到這些樣式文件。最終經過谷歌瀏覽器查看控制檯

原來它自動去Content裏面找fonts文件夾了。這下就好辦了，把咱們的fonts文件夾拷貝到Content下不就好了嗎。呵呵，原來真是這樣，問題順利解決

Content文件夾中存放文件以下所示：

第三點要說說表格自帶的搜索功能，有上可知，在初始化表格的時候，經過設置search: true能夠設置表格的搜索框出現而且能夠進行模糊搜索。以前博主一直覺得只有客戶端分頁才能使用這個搜索，多謝園友指出，其實服務端分頁也可使用這個搜索功能。只不過須要在對應的方法里加上search參數。好比

oTableInit.queryParams = function (params) {
        var temp = {   //這裏的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也須要改爲同樣的
            limit: params.limit,   //頁面大小
            offset: params.offset,  //頁碼
            departmentname: $("#txt_search_departmentname").val(),
            statu: $("#txt_search_statu").val(),
            search:params.search
        };
        return temp;
    };

而後後端（後端能夠根據這個參數值是否有值來判斷作什麼查詢）

public JsonResult GetDepartment(int limit, int offset, string departmentname, string statu, string search)
        {
            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);
        }

這樣，每次用戶在搜索框裏面輸入都會進到後臺的方法，而且將用戶輸入的值傳到search參數。可是若是你須要對多個字段進行模糊匹配，那麼就意味着你的後臺須要去對多個數據字段進行like操做，這樣查詢效率確定低下。因此，若是須要模糊匹配的字段不少，這個search在實際項目中是用不上的。綜上，博主仍是以爲只有在客戶端分頁的時候，這個搜索的做用比較明顯。

第四點：關於Bootstrap Table的排序，因爲通常這種BS系統確定會採用服務端分頁，咱們若是僅僅在js裏面設置sortable和sortOrder等屬性信息，表格是不會有效排序的。緣由很簡單，服務端分頁的方式，排序本頁數據意義不大。因此，通常的排序須要將排序方式和排序字段發送到後臺，在後臺排序比較合適。好比咱們這裏能夠再參數裏面增長兩個：

oTableInit.queryParams = function (params) {
        var temp = {   //這裏的鍵的名字和控制器的變量名必須一直，這邊改動，控制器也須要改爲同樣的
            limit: params.limit,   //頁面大小
            offset: params.offset,  //頁碼
            order: params.order,
            ordername: params.sort,
            departmentname: $("#txt_search_departmentname").val(),
            statu: $("#txt_search_statu").val()
        };
        return temp;
    };