網路上類似文章不少,但多數寫得偏複雜。這裡記錄一個精簡做法,重點放在幾個容易卡住的地方。最終效果如下:

後端 ASP.NET MVC 5,前端使用 jquery.validate、jquery.validate.unobtrusive、requirejs 與 Bootstrap,皆為當時的最新版。jquery.validate 是主流的前端驗證套件;unobtrusive 是微軟在其基礎上寫的配套層,透過 NuGet 安裝 Microsoft.jQuery.Unobtrusive.Validation 即可取得。
MVC 的強項是驗證規則寫在 model 上,前後端共用同一份定義:
public class Manufacturer : OperatedModel
{
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int ID { get; set; }
/// <summary>信用代碼/注冊號</summary>
[Required(ErrorMessage = "信用代碼/注冊號不能為空")]
[MaxLength(30)]
public string EnterpriseNo { get; set; }
/// <summary>企業名稱</summary>
[Required(ErrorMessage = "企業名稱不能為空")]
public string EnterpriseName { get; set; }
[Required(ErrorMessage = "手機號不能為空")]
[RegularExpression(RegexLib.Mobile, ErrorMessage = "手機號碼格式不正確")]
public string Mobile { get; set; }
[EmailAddress]
public string Email { get; set; }
[Required(ErrorMessage = "入駐日期不能為空")]
public DateTime EnterDate { get; set; }
// ... 其餘屬性略
}
使用者把 model 提交到 Action 時,MVC 會依這些 Attribute 自動驗證,後端很開心。但資料送出之前,前端也該先驗一輪。若用 jquery.validate,就得在 JS 或標籤裡把規則再寫一遍——能不能複用後端已有的定義?可以。
以 EnterpriseNo 為例,cshtml 裡這樣寫:
@Html.TextBoxFor(m => m.BasicInfo.EnterpriseNo,
new { placeholder = "必填項", @class = "form-control" })
產生的 HTML:
<input class="form-control" data-val="true"
data-val-maxlength="字段 EnterpriseNo 必須是最大長度為“30”的字符串或數組類型。"
data-val-maxlength-max="30"
data-val-required="信用代碼/注冊號不能為空"
id="BasicInfo_EnterpriseNo" name="BasicInfo.EnterpriseNo"
placeholder="必填項" type="text">
標籤上自動多了一堆 data- 開頭的屬性:data-val="true" 表示這個控制項需要驗證,其餘每一組都是「規則 + 失敗訊息」。訊息可以自訂,否則框架會生成「字段 EnterpriseNo 必須是最大長度為30的字符串或數組類型。」這種機器翻譯腔。問題是 jquery.validate 並不認這些屬性,得靠 jquery.validate.unobtrusive 接手。
新版 jquery.validate 已支援 AMD,可以直接用 requirejs 載入;unobtrusive 則需要 shim:
require.config({
baseUrl: '/scripts',
paths: {
"jquery": 'jquery-2.2.3.min',
"knockout": 'knockout-3.4.0',
"bootstrap": '../components/bootstrap/3.3.6/js/bootstrap.min',
"validate": 'jquery.validate',
"validateunobtrusive": 'jquery.validate.unobtrusive.min'
},
shim: {
'bootstrap': { deps: ['jquery'], exports: 'bootstrap' },
'validateunobtrusive': { deps: ['validate'], exports: 'validateunobtrusive' }
}
});
設定好之後 require 載入,點 submit 各套件就開始作用。但除了游標會跳到第一個驗證失敗的控制項之外,好像什麼都沒發生——連 jquery.validate 預設在控制項後面顯示錯誤訊息的 errorPlacement 都消失了。
原因在於 jquery.validate.unobtrusive 覆寫了 errorPlacement(見原始碼的 attachValidation 函式)。對我們來說反而省了一道手續。由於 tooltip 的 HTML 標記是由 Bootstrap 動態產生的,errorPlacement 並不適合,因此改為覆寫 showErrors:
// tooltipvalidator.js
define(['validateunobtrusive'], function () {
function TooltipValidator() {}
TooltipValidator.prototype = {
init: function (validatorOptions, tooltipOptions) {
tooltipOptions = tooltipOptions || {};
validatorOptions = validatorOptions || {};
this._tooltipOptions = $.extend({}, { placement: 'top' }, tooltipOptions, { animation: false });
this._validatorOptions = $.extend({}, {
showErrors: function (errorMap, errorList) {
// 先清掉曾經通過驗證的控制項狀態
for (var i = 0; i < this.successList.length; i++) {
var el = this.successList[i];
$(el).tooltip('destroy');
$(el).parents('div.form-group').removeClass('has-error');
}
// 再為失敗的控制項掛上 tooltip
for (var i = 0; i < errorList.length; i++) {
var errorElement = $(errorList[i].element);
errorElement.parents('div.form-group').addClass('has-error');
errorElement
.attr('data-original-title', errorList[i].message)
.tooltip('show');
}
},
submitHandler: function (form) { return false; }
}, validatorOptions);
this._configTooltip();
this._configValidator();
},
_configTooltip: function () {
$('[data-val="true"]').tooltip(this._tooltipOptions);
},
_configValidator: function () {
$.validator.setDefaults(this._validatorOptions);
$.validator.unobtrusive.parse(document);
}
};
return new TooltipValidator();
});
之後在 require 的回呼裡呼叫 tooltipvalidator.init() 就完成設定,不必另外寫邏輯。
注意上面 _configValidator 裡那句 $.validator.unobtrusive.parse(document)。unobtrusive 自己的原始碼中已經有:
$(function () { $jQval.unobtrusive.parse(document); });
但 $.ready 在 DOM 載入完成後就會執行,會跑在我們有機會呼叫 _configValidator 之前,導致自訂設定失效。(若是在單頁無刷新應用中,會發現第二次載入局部頁時設定又生效了——因為 $.ready 只在初次載入時執行,而 require 回呼每次載入都會跑。)
兩種解法:一是讓 unobtrusive 依賴 tooltipvalidator;二是直接把 unobtrusive 裡那句 $jQval.unobtrusive.parse(document) 移除。這裡採用第二種,比較乾脆。
整體串起來就是:後端 Attribute 產生 data-* 屬性 → unobtrusive 讀取並驗證 → 我們覆寫 showErrors 把結果交給 Bootstrap Tooltip 呈現。三層各司其職,驗證規則也只有一份來源。