ASP.NET MVC3 Model驗證總結

標籤：class   blog   code   java   http   tar   

原文轉自：http://www.cnblogs.com/yeagen/archive/2012/09/24/2700836.html

ASP.NET MVC3中的Model是自驗證的，這是通過.NET4的System.ComponentModel.DataAnnotations命名空間完成的。 我們要做的只是給Model類的各屬性加上對應的驗證標記（Attributes）就可以讓MVC3架構幫我們完成驗證。我以MVC3項目模板內建的登入 做例子講解Model的驗證。

一、啟用用戶端驗證：

用戶端驗證主要是為了提高使用者體驗，在網頁不回刷的情況下完成驗證。

第一步是要在web.config裡啟用用戶端驗證，這在MVC3內建的模板項目中已經有了：

<add key="ClientValidationEnabled" value="true"/><add key="UnobtrusiveJavaScriptEnabled" value="true"/>

然後在被驗證的View頁面上要加入這樣兩個JavaScript，注意，他們是依賴於JQuery的：

<script src="@Url.Content("~/Scripts/jquery.validate.min.js")" type="text/javascript"></script><script src="@Url.Content("~/Scripts/jquery.validate.unobtrusive.min.js")" type="text/javascript"></script>

驗證訊息的顯示有兩種，一種是ValidationSummary，它可以顯示一份驗證訊息的匯總，包括從後台Action裡返回的訊息。

@Html.ValidationSummary(true, "Login was unsuccessful. Please correct the errors and try again.")

另一種是Model中各屬性對應HTML控制項的驗證訊息：

@Html.ValidationMessageFor(m => m.UserName)

二、在Model中加入驗證標記

MVC3項目模板內建的登入模型類如下：

public class LogOnModel{    [Required]    [Display(Name = "User name")]    public string UserName { get; set; }     [Required]    [DataType(DataType.Password)]    [Display(Name = "Password")]    public string Password { get; set; }     [Display(Name = "Remember me?")]    public bool RememberMe { get; set; }}

對比普通的C#類，我們發現每個屬性上都多了被方括弧“[]”包圍的標記。其中，[Required]是驗證標記的一種，而[Display]、[DataType]則是為了顯示對應的HTML控制項，這不在本文討論範圍之內。

除了Required，我們還可以在Model中添加其他有用的驗證標記。下面是個較完整的列表：

Model類中可以添加的驗證標記：

1. 必要欄位

[Required]

public string FirstName { get; set; }

2. 欄位長度

至多n位：

[StringLength(160)]

public string FirstName { get; set; }

要求至少n位：

[StringLength(160, MinimumLength=3)]

public string FirstName { get; set; }

3. 正則驗證

[RegularExpression(@”[A-Za-z0-9._%+-][email protected][A-Za-z0-9.-]+\.[A-Za-z]{2,4}”)]

public string Email { get; set; }

4. 範圍

[Range(35,44)]

public int Age { get; set; }

小數的情況：

[Range(typeof(decimal), “0.00”, “49.99”)]

public decimal Price { get; set; }

5. 服務端參與的驗證

[Remote(“CheckUserName”, “Account”)]

public string UserName { get; set; }

然後在AccountController裡指定一個CheckUserName方法：

public JsonResult CheckUserName(string username){    var result = Membership.FindUsersByName(username).Count == 0;    return Json(result, JsonRequestBehavior.AllowGet);}

 

6. 比較

 

[RegularExpression(@”[A-Za-z0-9._%+-][email protected][A-Za-z0-9.-]+\.[A-Za-z]{2,4}”)]

public string Email { get; set; }

[Compare(“Email”)]

public string EmailConfirm { get; set; }

7. 自訂錯誤訊息

正則：

[RegularExpression(@”[A-Za-z0-9._%+-][email protected][A-Za-z0-9.-]+\.[A-Za-z]{2,4}”,

                   ErrorMessage=”Email doesn’t look like a valid email address.”)]

public string Email { get; set; }

普通文本：

[Required(ErrorMessage=”Your last name is required”)]

[StringLength(160, ErrorMessage=”Your last name is too long”)]

public string LastName { get; set; }

預留位置：

[Required(ErrorMessage=”Your {0} is required.”)]

[StringLength(160, ErrorMessage=”{0} is too long.”)]

public string LastName { get; set; }

三、後台Action的寫法

Action裡要做的有兩件事：判斷ModelState是否合法、添加錯誤訊息。MVC3模板內建的登入Action如下：

[HttpPost]public ActionResult LogOn(LogOnModel model, string returnUrl){    if (ModelState.IsValid)    {        if (Membership.ValidateUser(model.UserName, model.Password))        {            FormsAuthentication.SetAuthCookie(model.UserName, model.RememberMe);            if (Url.IsLocalUrl(returnUrl) && returnUrl.Length > 1 && returnUrl.StartsWith("/")                && !returnUrl.StartsWith("//") && !returnUrl.StartsWith("/\\"))            {                return Redirect(returnUrl);            }            else            {                return RedirectToAction("Index", "Home");            }        }        else        {            ModelState.AddModelError("", "The user name or password provided is incorrect.");        }    }     // If we got this far, something failed, redisplay form    return View(model);}

[HttpPost]表示這個Action只能通過POST動作調用，這是為了配合View裡的表單，因為FORM的ACTION是POST（當然也可以是GET），不過這不在本文的討論範圍內。

if (ModelState.IsValid) 是重點，如果不出意外，即用戶端瀏覽器沒有關閉JavaScript，並且客戶不是個駭客（駭客可能會通過一些工具類比POST），那隻要通過正常途徑 POST到這個Action的Model都應該是IsValid的。當然，編程的一個重要原則是不能相信使用者的輸入，所以我們有必要再判斷一次 ModelState.IsValid。

ModelState.AddModelError方法是給View返回一個錯誤訊息，最終交給@Html.ValidationSummary顯示。

最後附上常用Regex（網上找的）

數字："^[0-9]*$"。

n位的數字："^\d{n}$"。

至少n位的數字："^\d{n,}$"。

m~n位的數字：。"^\d{m,n}$"

零和非零開頭的數字："^(0|[1-9][0-9]*)$"。

有兩位小數的正實數："^[0-9]+(.[0-9]{2})?$"。

有1~3位小數的正實數："^[0-9]+(.[0-9]{1,3})?$"。

非零的正整數："^\+?[1-9][0-9]*$"。

非零的負整數："^\-[1-9][]0-9"*$。

長度為3的字元："^.{3}$"。

由26個英文字母組成的字串："^[A-Za-z]+$"。

由26個大寫英文字母組成的字串："^[A-Z]+$"。

由26個小寫英文字母組成的字串："^[a-z]+$"。

由數字和26個英文字母組成的字串："^[A-Za-z0-9]+$"。

由數字、26個英文字母或者底線組成的字串："^\w+$"。

驗證使用者密碼："^[a-zA-Z]\w{5,17}$"正確格式為：以字母開頭，長度在6~18之間，只能包含字元、數字和底線。

驗證是否含有^%&’,;=?$\"等字元："[^%&’,;=?$\x22]+"。

只能輸入漢字："^[\u4e00-\u9fa5]{0,}$"

驗證Email地址："^\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$"。

驗證InternetURL："^http://([\w-]+\.)+[\w-]+(/[\w-./?%&=]*)?$"。

驗證電話號碼："^(\(\d{3,4}-)|\d{3.4}-)?\d{7,8}$"正確格式為："XXX-XXXXXXX"、"XXXX- XXXXXXXX"、"XXX-XXXXXXX"、"XXX-XXXXXXXX"、"XXXXXXX"和"XXXXXXXX"。

驗證社會安全號碼(15位或18位元字)："^\d{15}|\d{18}$"。

驗證一年的12個月："^(0?[1-9]|1[0-2])$"正確格式為："01"～"09"和"1"～"12"。

驗證一個月的31天："^((0?[1-9])|((1|2)[0-9])|30|31)$"正確格式為;"01"～"09"和"1"～"31"。