ASP.NET MVC5（四）：數據註解和驗證

前言

用戶輸入驗證的工作，不僅要在客戶端瀏覽器中執行，還要在服務端執行。主要原因是客戶端驗證會對輸入數據給出即時反饋，提高用戶體驗；伺服器端驗證，主要是因為不能完全信任用戶提供的數據。ASP.NET MVC框架提供了強大的驗證組件幫助我們處理這些繁雜的問題。

驗證註解特性定義在命名空間System.ComponentModel.DataAnnotations中，它們提供了伺服器端驗證的功能，當在模型的屬性上使用時，框架也支持客戶端驗證。常用特性簡介：

• Required
  當屬性值為null或者空時，將引發一個驗證錯誤，可以理解為若添加了Required特性，則此項為必填項。
• StringLength
  限定字元串長度。
• RegularExpression
  使用正則表達式驗證輸入的字元串是否符合格式要求。
• Range
  用來指定輸入數值來的最小值和最大值。
• Compare
  用來判斷兩個屬性是否擁有相同的值。例如，確保兩次輸入的密碼相同。
• Remote
  利用伺服器端的回調函數執行客戶端的邏輯驗證。

下面，通過一個簡單的示例來講解這些特性的使用方法。 假設現在我們開發一套圖書管理系統，在Models文件夾中創建Book類，用來保存書籍的基本信息。

public class Book
{
public int Id { get; set; }
public string Name { get; set; }
public string Author { get; set; }
public int PagesNumber { get; set; }
public string Publisher { get; set; }
public string PublicationDate { get; set; }
public string Content { get; set; }
public decimal Price { get; set; }
public decimal PriceConfirm { get; set; }
}

添加BooksController，啟動項目，此時，ASP.NET MVC已經利用基架模板幫助我們創建好了相應的controller和View，直接將瀏覽器定位到/Books/Create，可瀏覽如下用來添加書籍的頁面。

在添加書籍時，用戶希望對輸入的數據進行一些驗證，當輸入的數據無法通過相關驗證時，返回錯誤信息。此時，驗證註解特性就派上了用場。 第一步，引入命名空間

using System.ComponentModel.DataAnnotations;
using System.Web.Mvc;

向BooksController中添加CheckContent方法（為了使用remote特性做準備）

public JsonResult CheckContent(string content)
{
var result = db.Books.Where(m => m.Content == content).Count == 0;
return Json(result, JsonRequestBehavior.AllowGet);
}

修改Book類，分別添加驗證註解：

public int Id { get; set; }
[Required] //必填
public string Name { get; set; }
[StringLength(50)] //作者姓名的長度不能超過50個字元
public string Author { get; set; }
[Range(100, 10000)] //頁數保證在100~10000頁之間
public int PagesNumber { get; set; }
public string Publisher { get; set; }
[RegularExpression(@"^d{4}(-|/|.)d{1,2}1d{1,2}$")] //日期格式
public string PublicationDate { get; set; }
[Remote("CheckContent", "Books")] //內容介紹不能重複
public string Content { get; set; }
public decimal Price { get; set; }
[System.ComponentModel.DataAnnotations.Compare("Price")] //兩次輸入的價格必須一致
public decimal PriceConfirm { get; set; }

重新啟動項目，在Create頁面輸入不符合驗證邏輯的數據，效果如下：

重新輸入正確的數據，點擊Create，數據成功錄入後，我們再錄入另外一本書籍，Content內容與上一次添加的內容相同，得到錯誤信息，此時Remote特性調用了CheckContent方法進行驗證。

★注意，Remote特性自動發送AJAX請求訪問後台代碼來實現驗證，它只有客戶端驗證，沒有服務端驗證。也就是說，當用戶瀏覽器關閉js，Remote檢查將不起作用，因此，Remote特性存在一定的安全隱患。同理，如果創建Controller時沒有勾選Reference script libraries選項，Remote特性也將不起任何作用。

每個驗證特性都允許傳入一個帶有自定義錯誤提示消息的參數，例如以上示例中RegularExpression特性返回的錯誤消息，用戶可能無法理解正則表達式的含義，此時，我們就需要返回一些簡單易懂的錯誤消息，向RegularExpression傳入ErrorMessage參數。

[RegularExpression(@"^d{4}(-|/|.)d{1,2}1d{1,2}$",ErrorMessage ="請輸入有效的日期格式，例如：2017-06-16")] //日期格式
public string PublicationDate { get; set; }

效果如下：

默認情況下，ASP.NET MVC框架在模型綁定時執行驗證邏輯。模型綁定器一旦使用新值完成對模型屬性的更新，就會利用當前的模型元數據獲得模型的所有驗證器。ASP.NET MVC運行時提供了一個驗證器DataAnnotationsModelValidator來與數據註解一同工作。這個模型驗證器會找到所有的驗證特性並執行它們包含的驗證邏輯。模型綁定器捕獲所有失敗的驗證規則並把它們存放在模型狀態中。

控制器操作決定了在模型驗證失敗或成功時程序的執行流程。通常情況下，驗證成功，保存用戶輸入數據，驗證失敗，重新渲染視圖，返回錯誤消息。以下是系統自動創建的Create方法，首先判斷模型狀態ModelState是否存在錯誤，若不存在，則保存書籍信息，若存在敗，則重新渲染視圖。

[HttpPost]
[ValidateAntiForgeryToken]
public ActionResult Create([Bind(Include = "Id,Name,Author,PagesNumber,Publisher,PublicationDate,Content,Price,PriceConfirm")] Book book)
{
if (ModelState.IsValid)
{
db.Books.Add(book);
db.SaveChanges;
return RedirectToAction("Index");
}

return View(book);
}

自定義驗證邏輯

上一節中介紹了這麼多驗證註解，我們不禁會問，用戶經常會提出很多奇葩的需求，我們能否自己定義一些驗證邏輯呢？答案是肯定的。本節，將介紹如何完成自定義邏輯驗證。

所有驗證註解特性最終都派生自基類ValidationAttribute，它是個抽象類，因此，創建自定義註解特性時也必須派生自ValidationAttribute類。 假設用戶提出一個需求，由於某位作者遭到無情封殺，錄入書籍信息時，作者一欄不能為指定的人名。

首先，添加CheckAuthorAttribute類派生自基類ValidationAttribute：

using System.ComponentModel.DataAnnotations;

namespace MyFirstMvcProject.Infrastructure
{
public class CheckAuthorAttribute : ValidationAttribute
{
}
}

為了實現這個驗證，需要重寫基類的IsValid方法，ValidationContext參數提供了可在IsValid方法內部使用的信息，如模型類型、模型對象實例、用來驗證屬性的顯示名稱等。IsValid方法的第一個參數是要驗證的對象的值，另外，我們通過構造函數獲取不能通過驗證的人名。

public class CheckAuthorAttribute : ValidationAttribute
{
public string Author { get; set; }

protected override ValidationResult IsValid(object value, ValidationContext validationContext)
{
if (value != null)
{
if (value.ToString == Author)
{
return new ValidationResult(FormatErrorMessage(validationContext.DisplayName));
}
}
return ValidationResult.Success;
}
}

上述代碼有兩點需要注意：

1. 向基類構造函數傳遞一個默認值的錯誤提示信息。
2. FormatErrorMessage方法：基於出現比較錯誤的數據欄位對錯誤消息應用格式設置。

修改Book類，在Author屬性上添加CheckAuthor特性。

[StringLength(50)] //作者姓名的長度不能超過50個字元
[CheckAuthor("Thomas", ErrorMessage = "Author can not be this one.")]
public string Author { get; set; }

運行程序，輸入Author，點擊Create，效果如下：

到目前為止，我們已經成功創建自定義註解特性，但是細心的用戶又發現了，新添加的驗證只有在點擊了Create後才能觸發，其他的驗證都可以給出即時反饋。正如用戶所說，目前我們只添加了服務端驗證，下面將介紹如何為CheckAuthor特性添加客戶端驗證。

修改MaxWordsAttribute類，使其繼承IClientValidatable介面，實現GetClientValidationRules方法。

public class CheckAuthorAttribute : ValidationAttribute, IClientValidatable
{
public string Author { get; set; }

yield return rule;
}
}

說明：

1. IClientValidatable介面為ASP.NET MVC驗證框架提供一種用於在運行時發現驗證程序是否支持客戶端驗證的方法。GetClientValidationRules在類中實現，返回該類的客戶端驗證規則。
2. ErrorMessage屬性用於存放錯誤提示消息。
3. ValidationParameters集合用於存放客戶端需要的參數，本例中即為Thomas.
4. ValidationType屬性標識了客戶端需要的一段JavaScript代碼。

在Scripts文件夾下添加JavaScript文件，命名為customvalidators.js，鍵入如下代碼：

///
///

$.validator.unobtrusive.adapters.addSingleVal("checkauthor", "author");

說明：

1. AddSingleVal為需要從元數據中檢索唯一參數值的驗證規則創建適配器。第一個參數是適配器名稱，第二個參數是要從元數據中檢索的參數的名稱。
2. 調用validator.AddMethod方法添加新的驗證器。

最後，在Views/Books/Create.cshtml中添加對customvalidators.js的引用：

@section Scripts {
@Scripts.Render("~/bundles/jqueryval")

}

啟動程序，將Url定位到/Books/Create，在Author文本框中輸入Thomas，當焦點離開Author文本框後即可完成驗證。

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！