转载

MVC5 + EF6 + Bootstrap3 (15) 应用ModelState和Data Annotation做服务器端数据验证

Slark.NET-博客园 http://www.cnblogs.com/slark/p/mvc5-ef6-bs3-get-started-server-side-validation.html

系列教程： MVC5 + EF6 + Bootstrap3

上一节： MVC5 + EF6 + Bootstrap3 (14) 分部视图PartialView

源码下载：点我下载

通过ModelState验证数据

首先，在Models文件夹下创建Model,文件名为ModelStateModel.cs，代码如下：

1 namespace SlarkInc.Models 2 { 3     public class ModelStateModel 4     { 5         public string Name { get; set; } 6         public string Email { get; set; } 7     } 8 }

Model有Name 和 Email 两个属性，后面我们将对这两个属性做验证。

在Controllers文件夹下创建名为DataValidationController的控制器，代码如下：

 1 using System.Web.Mvc;  2 using SlarkInc.Models;  3 using System.Text.RegularExpressions;  4   5 namespace SlarkInc.Controllers  6 {  7     public class DataValidationController : Controller  8     {  9         public ActionResult ModelStateAction() 10         { 11             return View(); 12         } 13  14         [HttpPost] 15         public ActionResult ModelStateAction(ModelStateModel model) 16         { 17             if (string.IsNullOrEmpty(model.Name)) 18             { 19                 ModelState.AddModelError("Name", "Name is required"); 20             } 21             if (string.IsNullOrEmpty(model.Email)) 22             { 23                 ModelState.AddModelError("Email", "Email is required"); 24             } 25             else 26             { 27                 string expression = @"^/s*([A-Za-z0-9_-]+(/./w+)*@([/w-]+/.)+/w{2,3})/s*$"; 28                 Regex reg = new Regex(expression); 29                 if(!reg.IsMatch(model.Email)) 30                 { 31                     ModelState.AddModelError("Email", "Email is invalid"); 32                 }              33             } 34             if (ModelState.IsValid) 35             { 36                 ViewBag.Name = model.Name; 37                 ViewBag.Email = model.Email; 38             } 39             return View(model); 40         } 41     } 42 }

代码第9行是通过Get方法访问ModelStateAction，第14行通过Post方法访问ModelStateAction。我们知道服务器端验证是验证提交到服务器的数据，那么这个验证就一定是在Post方法调用的Action中。第17-20行，表示如果model.Name是空，则在ModelState中加入错误信息。AddModelError函数有两个参数，第一个是错误信息的Key,第二个是错误信息的内容。Key的内容一般是属性的名字，这样将来在View中就能在属性对应的地方显示错误信息。同理21-14行验证邮箱是否填写。27-32行验证邮箱是否有效。第34行，ModelState.IsValid是一个bool变量。当没有任何服务器端验证错误时，IsValid是true，否则是false。第34-39行表示如果没有错误则将提交的信息在View中显示出来。

接下来在Views/DataValidation/文件夹下创建ModelStateAction.cshtml文件，对应之前创建的Action。View代码如下：

 1 @model SlarkInc.Models.ModelStateModel  2 @{  3     ViewBag.Title = "ModelStateAction";  4 }  5 <h2>ModelState Validation</h2>  6 @Html.ValidationSummary()  7 @using (Html.BeginForm())  8 {  9     if(@ViewData.ModelState.IsValid && ViewBag.Name != null) 10     { 11         <b> 12             Name : @ViewBag.Name 13             <br /> 14             Email: @ViewBag.Email   15         </b>      16     } 17     <fieldset> 18         <div class="editor-label"> 19             @Html.LabelFor(model=>model.Name) 20         </div> 21         <div class="editor-field"> 22             @Html.EditorFor(model => model.Name) 23             @Html.ValidationMessageFor(model => model.Name) 24         </div> 25         <div class="editor-label"> 26             @Html.LabelFor(model=>model.Email) 27         </div> 28         <div class="editor-field"> 29             @Html.EditorFor(model => model.Email) 30             @Html.ValidationMessageFor(model => model.Email) 31         </div> 32         <br /> 33         <input type="submit" value="Submit" /> 34     </fieldset>

之前我们在Controller中做了服务器端验证，那么这里的View就负责显示验证错误信息。

第6行，Html.ValidationSummary()会把所有验证不通过的信息逐条显示出来。第9行，ViewData.ModelState.IsValid表示验证是否通过。第9-16行表示如果通过验证则在View中显示出来提交的信息。第23、30行，用Html.ValidationMessageFor函数显示属性对应的验证错误信息。

按F5运行这个View。

填入如下所示信息并提交，可以看到数据验证信息：

MVC5 + EF6 + Bootstrap3 (15) 应用ModelState和Data Annotation做服务器端数据验证

从图中可以看到ValidationSummary()函数显示了所有验证信息。ValidationMessageFor()函数显示自己对应属性的验证信息。

下面输入正确信息，显示结果如图所示：

MVC5 + EF6 + Bootstrap3 (15) 应用ModelState和Data Annotation做服务器端数据验证

图中红色方框内的信息就是提交验证成功ModelState.IsValid为true时显示出来的。

通过Data Annotation验证数据

在Models文件夹下创建名为DataAnnotationModel的Model。代码如下：

 1 using System.ComponentModel.DataAnnotations;  2   3 namespace SlarkInc.Models  4 {  5     public class DataAnnotationModel  6     {  7         [Required(ErrorMessage = "Name is required")]  8         public string Name { get; set; }  9  10         [Required(ErrorMessage = "Email is required")] 11         [RegularExpression(@"^/s*([A-Za-z0-9_-]+(/./w+)*@([/w-]+/.)+/w{2,3})/s*$", ErrorMessage = "Email is invalid")] 12         public string Email { get; set; } 13     } 14 }

不同于ModelState的方法，这里主要是在Model中加入需要验证的条件。

第1行，要使用Data Annotation就需要引用System.ComponentModel.DataAnnotations。第7、10、11行使用了Data Annotation，是对属性的注解。其形式就是一个中括号里包了一个函数。第7、10行，Required()表示这个属性是必填的，ErrorMessage的值是必填项没有填时，显示的错误提示信息。第11行，RegularExpression()是正则表达式验证，只有符合正则表达式的字符串才能通过验证。

在DataValidationController中加入DataAnnotationAction()，代码如下：

 1 using System.Web.Mvc;  2 using SlarkInc.Models;  3 using System.Text.RegularExpressions;  4   5 namespace SlarkInc.Controllers  6 {  7     public class DataValidationController : Controller  8     {  9         public ActionResult DataAnnotationAction() 10         { 11             return View(); 12         } 13  14         [HttpPost] 15         public ActionResult DataAnnotationAction(DataAnnotationModel model) 16         { 17             if (ModelState.IsValid) 18             { 19                 ViewBag.Name = model.Name; 20                 ViewBag.Email = model.Email; 21             } 22             return View(model); 23         } 24     } 25 }

这里的Controller相对前一种验证要简单一些。唯一与验证相关的是第17行ModelState.IsValid，如果验证通过，则向View传入提交的信息。

下面来写这个Action对应的View。在Views/DataValidation文件夹中创建DataAnnotationAction.cshtml文件，写入如下代码：

 1 @model SlarkInc.Models.DataAnnotationModel  2 @{  3     ViewBag.Title = "DataAnnotationAction";  4 }  5 <h2>Data Annotation Validation</h2>  6 @Html.ValidationSummary()  7 @using (Html.BeginForm())  8 {  9     if (@ViewData.ModelState.IsValid && ViewBag.Name != null) 10     { 11         <b> 12             Name : @ViewBag.Name 13             <br /> 14             Email: @ViewBag.Email 15         </b> 16     } 17     <fieldset> 18         <div class="editor-label"> 19             @Html.LabelFor(model => model.Name) 20         </div> 21         <div class="editor-field"> 22             @Html.EditorFor(model => model.Name) 23             @Html.ValidationMessageFor(model => model.Name) 24         </div> 25         <div class="editor-label"> 26             @Html.LabelFor(model => model.Email) 27         </div> 28         <div class="editor-field"> 29             @Html.EditorFor(model => model.Email) 30             @Html.ValidationMessageFor(model => model.Email) 31         </div> 32         <br /> 33         <input type="submit" value="Submit" /> 34     </fieldset> 35 }