DIV CSS 佈局教程網

MVC 搭配 Bootstrap 的 Ajax 表單驗證實作
編輯:AJAX基礎知識     

採用 Bootstrap 之後,驗證樣式變得棘手。Bootstrap 提供了 has-error 這樣的狀態類別,但 jQuery Validate 有自己的一套 class 規則,兩者不易共存;而 ASP.NET MVC 內建的模型驗證雖然方便,輸出結構卻得調整才符合 Bootstrap 的預期。以下說明一個可行的整合路徑。

一、先取得 Bootstrap 編輯器範本

從 NuGet 安裝「MVC EditorTemplates for Bootstrap 3」套件,即可獲得一批預製範本。以最單純的文字欄位為例:

@model object
<div class="form-group@(Html.ValidationErrorFor(m => m, " has-error"))">
    @Html.LabelFor(m => m, new { @class = "control-label" })
    <div class="controls">
        @Html.TextBox("",
            ViewData.TemplateInfo.FormattedModelValue,
            ViewBag.ClearTextField == true
                ? new { @class = "form-control clear-text-field input-block-level" }
                : new { @class = "form-control input-block-level" })
        @Html.ValidationMessageFor(m => m, null, new { @class = "help-block" })
    </div>
</div>

如此一來,使用 EditorFor 時就會直接輸出 Bootstrap 需要的 HTML 結構,驗證失敗時也自動掛上 has-error。

二、補一個非強型別的驗證輔助方法

問題在於:有些欄位不是模型屬性(例如以隱藏欄位承載的「部門」),強型別的 ValidationErrorFor 用不上。此時可在套件的 Validation 類別中擴充一個字串版本:

public static MvcHtmlString ValidationError(this HtmlHelper htmlHelper, string field, string error)
{
    if (HasError(htmlHelper, ModelMetadata.FromStringExpression(field, htmlHelper.ViewData), field))
        return new MvcHtmlString(error);
    else
        return null;
}

檢視頁面中即可直接指定欄位名:

<div class="form-group@(Html.ValidationError("Department", " has-error"))">
    <label class="control-label" for="DepartmentId">所在部門</label>
    <div class="controls">
        <span id="deptname"></span>
        <a id="btnSelectDepartment">選擇部門</a>
        <input class="form-control" data-val="true"
               data-val-required="部門是必需的。"
               id="DepartmentId" name="DepartmentId" type="hidden" value="">
        @Html.ValidationMessage("Department", null, new { @class = "help-block" })
    </div>
</div>

三、以 Ajax 送出表單並處理回傳

接下來處理表單的非同步提交。MVC 內建的 Ajax.BeginForm 雖然可用,但彈性有限,這裡改用 ajaxSubmit 搭配 $.ajax:

var $divuserform = $("#divuserform");

$divuserform.dialog({ title: '新建用戶' /* 其餘設定略 */ });

$("#btnCreateUser").click(function () {
    var nodes = zTreeObjleft.getSelectedNodes();
    if (nodes.length > 0) {
        CreateUserForm($divuserform);
    }
});

function CreateUserForm(form) {
    var $divuserform = form;
    $.ajax({
        url: "CreateUser",
        success: function (html) {
            CreateUserFormSuccessCallback(html, $divuserform);
        }
    });
}

function InitSelectDepartmentWhenCreateUser() {
    $("#btnSelectDepartment").departmentSelection({
        onSelected: function (name, id) {
            $("#deptname").text(name);
            $("#DepartmentId").val(id);
        }
    });
}

function CreateUserFormSuccessCallback(html, form) {
    var $divuserform = form;
    $divuserform.children().children().html(html);
    $("#divuserform").dialog("open");

    var $form = $divuserform.find("form");
    InitSelectDepartmentWhenCreateUser();

    $form.submit(function (event) {
        $form.ajaxSubmit(function (data) {
            if (data === "success") {
                $("#divuserform").dialog("close");
                $("#divuserform").clearForm();
            } else {
                // 驗證失敗:把帶有錯誤樣式的畫面重新填回去
                CreateUserFormSuccessCallback(data, form);
            }
        });
        event.preventDefault();   // 阻止表單真的送出
    });
}

這個結構的巧妙之處在於:驗證失敗時,伺服器回傳的是「重新渲染過、已掛上 has-error 的檢視」,前端只要把它填回對話框即可,不必自己組裝錯誤訊息。

四、後端補上自訂驗證

if (!DepartmentId.HasValue)
{
    ModelState.AddModelError("Department", "必須選擇部門");
}

if (ModelState.IsValid)
{
    user.Id = Guid.NewGuid();
    user.CreateTime = DateTime.Now;

    if (DepartmentId.HasValue)
    {
        var dept = new DeptUserRole();
        dept.DepartmentId = DepartmentId.Value;
        dept.IsMain = true;
        dept.RoleId = RoleId.Value;
        user.DeptUserRoles.Add(dept);
    }

    db.Users.Add(user);
    await db.SaveChangesAsync();
    return Content("success");
}

// 驗證未通過,回傳帶有錯誤狀態的檢視
return View(user);

幾點提醒

  • 前端驗證只是體驗優化,所有規則都必須在伺服器端重跑一次,這段程式碼正是如此。
  • 回傳字串 "success" 作為成功訊號略嫌脆弱,建議改用 JSON 並明確帶上成功與否的旗標。
  • 錯誤訊息應由後端依語系產生,避免在前端硬編碼多國語言字串。
  • 對話框中的表單在關閉後仍留在 DOM 中,若欄位含敏感資料,記得在關閉時清空。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved