DIV CSS 佈局教程網

Bootstrap Table + KnockoutJS 進階實戰:兩個 ViewModel 搞定增刪改查
編輯:關於JavaScript     

此前分享過 KnockoutJS 與 Bootstrap Table 的基礎用法,但那些內容嚴格來說算不上封裝,只是把 HTML 控件的取值賦值換成了數據綁定,MVVM 的價值遠沒有真正體現出來。這篇文章記錄我在正式項目中落地 ko + bootstrapTable 的一次封裝實踐,用兩個 ViewModel 把查詢、新增、編輯、刪除全部收攏。

一、第一個 ViewModel:查詢與刪除

demo 沿用之前的部門管理功能。下面按數據流向逐步拆解。

1. 後台向視圖傳遞配置

public ActionResult Index()
{
    var model = new
    {
        tableParams = new
        {
            url = "/Department/GetDepartment",
            //pageSize = 2,
        },
        urls = new
        {
            delete = "/Department/Delete",
            edit   = "/Department/Edit",
            add    = "/Department/Edit",
        },
        queryCondition = new
        {
            name = "",
            des  = ""
        }
    };
    return View(model);
}

這裡返回的 model 包含三個部分:

  • tableParams:表格初始化參數。js 中已有默認值,這裡只放頁面特有的配置。
  • urls:新增、修改、刪除三個請求的後台地址。
  • queryCondition:查詢表單的初始條件。

2. Index.cshtml

@{
    Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>Index</title>
<link href="~/Content/bootstrap/css/bootstrap.min.css" rel="stylesheet" />
<link href="~/Content/bootstrap-table/bootstrap-table.min.css" rel="stylesheet" />
<script src="~/scripts/jquery-1.9.1.min.js"></script>
<script src="~/Content/bootstrap/js/bootstrap.min.js"></script>
<script src="~/Content/bootstrap-table/bootstrap-table.min.js"></script>
<script src="~/Content/bootstrap-table/locale/bootstrap-table-zh-CN.js"></script>
<script src="~/scripts/knockout/knockout-3.4.0.min.js"></script>
<script src="~/scripts/knockout/extensions/knockout.mapping-latest.js"></script>
<script src="~/scripts/extensions/knockout.index.js"></script>
<script src="~/scripts/extensions/knockout.bootstraptable.js"></script>
<script type="text/javascript">
$(function () {
    var data = @Html.Raw(Newtonsoft.Json.JsonConvert.SerializeObject(Model));
    ko.bindingViewModel(data, document.getElementById("div_index"));
});
</script>
</head>
<body>
<div id="div_index" class="panel-body" style="padding:0px;overflow-x:hidden;">
  <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-xs-1">部門名稱</label>
          <div class="col-xs-3">
            <input type="text" class="form-control" data-bind="value:queryCondition.name">
          </div>
          <label class="control-label col-xs-1">部門描述</label>
          <div class="col-xs-3">
            <input type="text" class="form-control" data-bind="value:queryCondition.des">
          </div>
          <div class="col-xs-4" style="text-align:right;">
            <button type="button" data-bind="click:clearClick" class="btn">清空</button>
            <button type="button" data-bind="click:queryClick" class="btn btn-primary">查詢</button>
          </div>
        </div>
      </form>
    </div>
  </div>
  <div id="toolbar" class="btn-group">
    <button data-bind="click:addClick" type="button" class="btn btn-default">
      <span class="glyphicon glyphicon-plus"></span>新增
    </button>
    <button data-bind="click:editClick" type="button" class="btn btn-default">
      <span class="glyphicon glyphicon-pencil"></span>修改
    </button>
    <button data-bind="click:deleteClick" type="button" class="btn btn-default">
      <span class="glyphicon glyphicon-remove"></span>刪除
    </button>
  </div>
  <table data-bind="bootstrapTable:bootstrapTable">
    <thead>
      <tr>
        <th data-checkbox="true"></th>
        <th data-field="Name">部門名稱</th>
        <th data-field="Level">部門級別</th>
        <th data-field="Des">描述</th>
        <th data-field="strCreatetime">創建時間</th>
      </tr>
    </thead>
  </table>
</div>
</body>
</html>

依賴項與之前一致:jQuery、bootstrap、bootstrap-table、knockout 及 mapping 插件。這裡重點說明兩個自寫文件:

  • knockout.index.js:封裝查詢頁面的屬性與事件綁定。
  • knockout.bootstraptable.js:封裝 bootstrapTable 的初始化與 ko 自定義綁定。

所有頁面交互都沉到公共 js 裡,頁面上只剩兩句調用,DOM 取值賦值和事件綁定的重複代碼基本消失。

3. JS 封裝實現

(1)knockout.bootstraptable.js

(function ($) {
  // 向 ko 掛一個 bootstrapTableViewModel 構造器
  ko.bootstrapTableViewModel = function (options) {
    var that = this;
    this.default = {
      toolbar: '#toolbar',
      queryParams: function (param) {
        return { limit: param.limit, offset: param.offset };
      },
      pagination: true,
      sidePagination: "server",
      pageNumber: 1,
      pageSize: 10,
      pageList: [10, 25, 50, 100],
      method: 'get',
      search: true,
      strictSearch: true,
      showColumns: true,
      cache: false,
      showRefresh: true,
      minimumCountColumns: 2,
      clickToSelect: true,
      showToggle: true,
    };
    this.params = $.extend({}, this.default, options || {});

    // 取選中行
    this.getSelections = function () {
      return that.bootstrapTable("getSelections");
    };
    // 刷新
    this.refresh = function () {
      that.bootstrapTable("refresh");
    };
  };

  // 自定義 ko 綁定
  ko.bindingHandlers.bootstrapTable = {
    init: function (element, valueAccessor) {
      var oViewModel = valueAccessor();
      var $ele = $(element).bootstrapTable(oViewModel.params);
      // 把 bootstrapTable 方法掛回 viewmodel
      oViewModel.bootstrapTable = function () {
        return $ele.bootstrapTable.apply($ele, arguments);
      };
    },
    update: function () { }
  };
})(jQuery);

這段代碼做了兩件事:定義了 bootstrapTable 的初始化 ViewModel,以及註冊了 ko 自定義綁定。關於自定義綁定的用法可參考本系列的前兩篇。

(2)knockout.index.js

(function ($) {
  ko.bindingViewModel = function (data, bindElement) {
    var self = this;
    // 把後台傳來的查詢條件轉成監控屬性
    this.queryCondition = ko.mapping.fromJS(data.queryCondition);

    this.defaultQueryParams = {
      queryParams: function (param) {
        var params = self.queryCondition;
        params.limit = param.limit;
        params.offset = param.offset;
        return params;
      }
    };
    var tableParams = $.extend({}, this.defaultQueryParams, data.tableParams || {});
    this.bootstrapTable = new ko.bootstrapTableViewModel(tableParams);

    // 清空
    this.clearClick = function () {
      $.each(self.queryCondition, function (key, value) {
        if (typeof (value) == "function") {
          this('');
        }
      });
      self.bootstrapTable.refresh();
    };

    // 查詢
    this.queryClick = function () {
      self.bootstrapTable.refresh();
    };

    // 新增
    this.addClick = function () {
      var dialog = $('<div class="modal fade" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel"></div>');
      dialog.load(data.urls.edit, null, function () { });
      $("body").append(dialog);
      dialog.modal().on('hidden.bs.modal', function () {
        ko.cleanNode(document.getElementById("formEdit"));
        dialog.remove();
        self.bootstrapTable.refresh();
      });
    };

    // 編輯
    this.editClick = function () {
      var arrselectedData = self.bootstrapTable.getSelections();
      if (arrselectedData.length <= 0 || arrselectedData.length > 1) {
        alert("每次只能編輯一行");
        return;
      }
      var dialog = $('<div class="modal fade" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel"></div>');
      dialog.load(data.urls.edit, arrselectedData[0], function () { });
      $("body").append(dialog);
      dialog.modal().on('hidden.bs.modal', function () {
        ko.cleanNode(document.getElementById("formEdit"));
        dialog.remove();
        self.bootstrapTable.refresh();
      });
    };

    // 刪除
    this.deleteClick = function () {
      var arrselectedData = self.bootstrapTable.getSelections();
      if (!arrselectedData || arrselectedData.length <= 0) {
        alert("請至少選擇一行");
        return;
      }
      $.ajax({
        url: data.urls.delete,
        type: "post",
        contentType: 'application/json',
        data: JSON.stringify(arrselectedData),
        success: function (data, status) {
          alert(status);
          self.bootstrapTable.refresh();
        }
      });
    };

    ko.applyBindings(self, bindElement);
  };
})(jQuery);

幾個值得留意的地方:

  • ko.mapping.fromJS 把後台傳來的 JSON 轉為可監控屬性,這是雙向綁定生效的前提。
  • self.bootstrapTable.refresh() 是對 bootstrapTable 原生 refresh 的一層薄封裝。
  • dialog.load() 用來異步載入編輯視圖,並執行該頁面的 js,在動態加載腳本這塊能力很強。

後台分頁方法:

[HttpGet]
public JsonResult GetDepartment(int limit, int offset, string name, string des)
{
    var lstRes = DepartmentModel.GetData();
    if (!string.IsNullOrEmpty(name))
        lstRes = lstRes.Where(x => x.Name.Contains(name)).ToList();
    if (!string.IsNullOrEmpty(des))
        lstRes = lstRes.Where(x => x.Des.Contains(des)).ToList();

    lstRes.ForEach(x => {
        x.strCreatetime = x.Createtime.ToString("yyyy-MM-dd HH:mm:ss");
    });

    var oRes = new
    {
        rows = lstRes.Skip(offset).Take(limit).ToList(),
        total = lstRes.Count
    };
    return Json(oRes, JsonRequestBehavior.AllowGet);
}

至此查詢與清空已經跑通。

需要自定義表格事件怎麼辦

js 事件方法顯然沒法從後台 ViewModel 傳過來,只能在前端掛:

$(function () {
    var data = @Html.Raw(Newtonsoft.Json.JsonConvert.SerializeObject(Model));
    data.tableParams.onLoadSuccess = function (data) {
        alert("加載成功事件");
    };
    ko.bindingViewModel(data, document.getElementById("div_index"));
});

二、第二個 ViewModel:新增與編輯

點擊新增或修改時會請求 /Department/Edit,編輯邏輯由另一個 ViewModel 承擔。

1. ActionResult

public ActionResult Edit(Department model)
{
    var oResModel = new
    {
        editModel = model,
        urls = new
        {
            submit = model.id == 0 ? "/Department/Add" : "/Department/Update"
        }
    };
    return View(oResModel);
}

通過主鍵是否存在來判斷當前是新增還是更新,提交地址隨之切換。

2. Edit.cshtml

<form id="formEdit">
  <div class="modal-dialog" role="document">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
        <h4 class="modal-title" id="myModalLabel">操作</h4>
      </div>
      <div class="modal-body">
        <div class="form-group">
          <label for="txt_departmentname">部門名稱</label>
          <input type="text" name="txt_departmentname" data-bind="value:editModel.Name" class="form-control" placeholder="部門名稱">
        </div>
        <div class="form-group">
          <label for="txt_departmentlevel">部門級別</label>
          <input type="text" name="txt_departmentlevel" data-bind="value:editModel.Level" class="form-control" placeholder="部門級別">
        </div>
        <div class="form-group">
          <label for="txt_des">描述</label>
          <input type="text" name="txt_des" data-bind="value:editModel.Des" class="form-control" placeholder="描述">
        </div>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-default" data-dismiss="modal"><span class="glyphicon glyphicon-remove"></span>關閉</button>
        <button type="submit" class="btn btn-primary"><span class="glyphicon glyphicon-floppy-disk"></span>保存</button>
      </div>
    </div>
  </div>
</form>
<link href="~/Content/bootstrapValidator/css/bootstrapValidator.css" rel="stylesheet" />
<script src="~/Content/bootstrapValidator/js/bootstrapValidator.js"></script>
<script src="~/scripts/extensions/knockout.edit.js"></script>
<script type="text/javascript">
$(function () {
    var editData = @Html.Raw(Newtonsoft.Json.JsonConvert.SerializeObject(Model));
    ko.bindingEditViewModel(editData, {});
});
</script>

3. knockout.edit.js

(function ($) {
  ko.bindingEditViewModel = function (data, validatorFields) {
    var that = {};
    that.editModel = ko.mapping.fromJS(data.editModel);
    that.default = {
      message: '驗證不通過',
      fields: {},
      submitHandler: function (validator, form, submitButton) {
        var arrselectedData = ko.toJS(that.editModel);
        $.ajax({
          url: data.urls.submit,
          type: "post",
          contentType: 'application/json',
          data: JSON.stringify(arrselectedData),
          success: function (data, status) {
            alert(status);
          }
        });
        $("#myModal").modal("hide");
      }
    };
    that.params = $.extend({}, that.default, { fields: validatorFields } || {});
    $('#formEdit').bootstrapValidator(that.params);
    ko.applyBindings(that, document.getElementById("formEdit"));
  };
})(jQuery);

這裡封裝了編輯模型的屬性與提交事件。因為引入了 bootstrapValidator,所以走的是表單提交流程。validatorFields 用來傳入需要校驗的字段,不需要校驗時傳空對象即可。

公共 js 中出現頁面 id(如 formEdit、myModal)其實不是好習慣,更合理的做法是作為參數傳入,這一點後面還會提到。

加上必填校驗

基礎表通常總會有幾個必填字段。注意 input 的 name 屬性必須與校驗配置中的 key 對應:

<form id="formEdit">
  <div class="modal-dialog" role="document">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
        <h4 class="modal-title" id="myModalLabel">操作</h4>
      </div>
      <div class="modal-body">
        <div class="form-group">
          <label for="txt_departmentname">部門名稱</label>
          <input type="text" name="Name" data-bind="value:editModel.Name" class="form-control" placeholder="部門名稱">
        </div>
        <div class="form-group">
          <label for="txt_departmentlevel">部門級別</label>
          <input type="text" name="Level" data-bind="value:editModel.Level" class="form-control" placeholder="部門級別">
        </div>
        <div class="form-group">
          <label for="txt_des">描述</label>
          <input type="text" name="Des" data-bind="value:editModel.Des" class="form-control" placeholder="描述">
        </div>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-default" data-dismiss="modal"><span class="glyphicon glyphicon-remove"></span>關閉</button>
        <button type="submit" class="btn btn-primary"><span class="glyphicon glyphicon-floppy-disk"></span>保存</button>
      </div>
    </div>
  </div>
</form>
<link href="~/Content/bootstrapValidator/css/bootstrapValidator.css" rel="stylesheet" />
<script src="~/Content/bootstrapValidator/js/bootstrapValidator.js"></script>
<script src="~/scripts/extensions/knockout.edit.js"></script>
<script type="text/javascript">
$(function () {
    var editData = @Html.Raw(Newtonsoft.Json.JsonConvert.SerializeObject(Model));
    ko.bindingEditViewModel(editData, {
        Name: { validators: { notEmpty: { message: '名稱不能為空!' } } }
    });
});
</script>

增刪改後台方法

[HttpPost]
public JsonResult Add(Department oData)
{
    DepartmentModel.Add(oData);
    return Json(new { }, JsonRequestBehavior.AllowGet);
}

[HttpPost]
public JsonResult Update(Department oData)
{
    DepartmentModel.Update(oData);
    return Json(new { }, JsonRequestBehavior.AllowGet);
}

[HttpPost]
public JsonResult Delete(List<Department> oData)
{
    DepartmentModel.Delete(oData);
    return Json(new { }, JsonRequestBehavior.AllowGet);
}

三、總結與待優化項

這只是一個初級封裝,要真正用到生產項目裡,至少還有幾處可以改進:

  1. 如果只是單頁面的 ViewModel,其實不必繞一圈從 ActionResult 返回,直接寫在視圖裡反而更乾淨,能省掉序列化與參數傳遞。
  2. 公共 js 中不宜硬編碼頁面元素 id,應通過參數注入。
  3. 新增與編輯事件裡彈出框的代碼高度重複,抽成獨立組件能砍掉大量 js。
  4. 若查詢條件或編輯屬性中存在 select 下拉框,還需要封裝數據源相關邏輯,這在實際項目裡非常常見。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved