【翻译】ModelState - ASP.NET MVC 大揭秘

最新推荐文章于 2021-10-22 11:18:14 发布

不惧神风

最新推荐文章于 2021-10-22 11:18:14 发布

阅读量3.1k

点赞数 6

分类专栏：学习笔记

学习笔记专栏收录该内容

27 篇文章 15 订阅

订阅专栏

科学上网找到的一篇关于ModelState的好文，翻译出来留作学习用，原文在此：The ModelState - ASP.NET MVC Demystified

ModelState - ASP.NET MVC 大揭秘

你是否曾想过在你的 ASP .NET MVC 控制器中时常出现的ModelState是什么呢？和你一样，我也对它充满了好奇心。现在，就让我们通过这篇文章来分析一下究竟什么是ModelState，以及人们使用它的理由吧。

一、什么是ModelState？

ModelState是Controller的一个属性，可以被继承自System.Web.Mvc.Controller的那些类访问。它表示在一次POST提交中被提交到服务器的 ⁽¹⁾键值对集合（a collection of name and value pairs），每个记录到ModelState内的值都有一个错误信息集。尽管ModelState的名字中含有“Model”，但它只有名称、值和错误集，与任何Model类都没有关系。
ModelState有两个作用：存储提交到服务器的值，以及存储与之相关联的验证错误集。但这些都是生硬枯燥的解释，现在，让我们通过一些实例来看看它的效果吧。

二、准备一组Model、View与Controller

在讲解实例之前我们需要先做一些准备工作。首先，我们先写一个AddUserVM视图模型：

// ViewModels/Home/AddUserVM.cs
public class AddUserVM
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string EmailAddress { get; set; }
}

接下来，我们再设计一个简单的视图用于显示信息和收集数据：

<!-- Views/Home/Add.cshtml -->
@model ModelStateDemo.ViewModels.Home.AddUserVM
<h2>Add</h2>

@using(Html.BeginForm())
{
    <div>
        <div>
            @Html.TextBoxFor(x => x.FirstName)
        </div>
        <div>
            @Html.TextBoxFor(x => x.LastName)
        </div>
        <div>
            @Html.TextBoxFor(x => x.EmailAddress)
        </div>
        <div>
            <input type="submit" value="Save" />
        </div>
    </div>
}

最后，我们还需要在控制器中添加新的Action（Controllers/HomeController.cs）：

[HttpGet]
public ActionResult Add()
{
    AddUserVM model = new AddUserVM();
    return View(model);
}

[HttpPost]
public ActionResult Add(AddUserVM model)
{
    if(!ModelState.IsValid)
    {
        return View(model);
    }
    return RedirectToAction("Index");
}

这样，当我们将表单提交给POST操作时，我们输入的所有值都将显示在AddUserVM实例中。但是现在问题来了，这些数值是被怎么提交上去的呢？

三、ModelStateDictionary类

让我们看一下Add页面的呈现HTML表单：

<form action="/Home/Add" method="post">    
    <div>
        <div>
            <label for="FirstName">First Name:</label>
            <input id="FirstName" name="FirstName" type="text" value="">
        </div>
        <div>
            <label for="LastName">Last Name:</label>
            <input id="LastName" name="LastName" type="text" value="">
        </div>
        <div>
            <label for="EmailAddress">Email Address:</label>
            <input id="EmailAddress" name="EmailAddress" type="text" value="">
        </div>
        <div>
            <input type="submit" value="Save">
        </div>
    </div>
</form>

我们可以看到，在POST中，<input>标签中的所有值都将会作为键值对提交给服务器。当MVC收到POST时，它会获取所有POST参数并将它们添加到ModelStateDictionary实例中。在Visual Studio中进行调试时，我们可以通过“局部变量”窗口来查看此实例（打开“局部变量”的方法：开启调试后点击菜单栏的“调试” -> 选择“窗口” -> 点击“局部变量”）：
从上图中我们可以看出，ModelStateDictionary的Values属性中含有System.Web.Mvc.ModelState的实例。那么ModelState里究竟包含着什么呢？

四、ModelState里究竟有什么

        同样是刚才那个窗口，让我们展开Value里的属性看看：
ModelStateDictionary         我们可以发现，每一个属性里都包含有一个ValueProviderResult的实例，并且每个实例中都有一个提交给服务器的实际值。当我们通过POST提交数据的时候，⁽²⁾ MVC会自动帮我们生成这些实例，并且在POST操作中输入会与提交上来的值一一映射形成键值对。从本质上讲，MVC将用户的输入包装到对服务器而言更加友好的类（ModelState和ValueProviderResult）中以便于使用。
        但这些还不是ModelState的全部，还有两个重要属性我们没有讨论：ModelState.Errors属性和ModelStateDictionary.IsValid属性。我们之前说过，ModelState有两个用途，而这两个属性则正是用于ModelState的第二个用途：存储在提交的值中找到的错误。

五、ModelState中的错误信息集

我们稍微修改下AddUserVM中的内容（ViewModels/Home/AddUserVM.cs）：

public class AddUserVM
{
    [Required(ErrorMessage = "Please enter the user's first name.")]
    [StringLength(50, ErrorMessage = "The First Name must be less than {1} characters.")]
    [Display(Name = "First Name:")]
    public string FirstName { get; set; }

    [Required(ErrorMessage = "Please enter the user's last name.")]
    [StringLength(50, ErrorMessage = "The Last Name must be less than {1} characters.")]
    [Display(Name = "Last Name:")]
    public string LastName { get; set; }

    [EmailAddress(ErrorMessage = "The Email Address is not valid")]
    [Required(ErrorMessage = "Please enter an email address.")]
    [Display(Name = "Email Address:")]
    public string EmailAddress { get; set; }
}

我们在原先的基础上添加了一些验证属性，在这个例子中，我先加入了 ⁽³⁾Requiered、StringLength以及Display三个属性作为示范。同时，我还为它们设置了相应的错误信息，这样当验证错误出现时，这些提示信息将会被显示在页面上。
完成上述更改后，让我们修改“添加”视图以显示错误消息（Views/Home/Add.cshtml）：

@model ModelStateDemo.ViewModels.Home.AddUserVM

<h2>Add</h2>

@using(Html.BeginForm())
{
    @Html.ValidationSummary()
    <div>
        <div>
            @Html.LabelFor(x => x.FirstName)
            @Html.TextBoxFor(x => x.FirstName)
            @Html.ValidationMessageFor(x => x.FirstName)
        </div>
        <div>
            @Html.LabelFor(x => x.LastName)
            @Html.TextBoxFor(x => x.LastName)
            @Html.ValidationMessageFor(x => x.LastName)
        </div>
        <div>
            @Html.LabelFor(x => x.EmailAddress)
            @Html.TextBoxFor(x => x.EmailAddress)
            @Html.ValidationMessageFor(x => x.EmailAddress)
        </div>
        <div>
            <input type="submit" value="Save" />
        </div>
    </div>
}

        请注意我们现在使用的两个帮助信息控件 ValidationSummary 和 ValidationMessageFor。ValidationSummary控件将会读取模型中所有属性的错误信息摘要并显示在一个项目符号列表中；而ValidationMessageFor则只显示其指定属性的错误信息摘要。
        现在让我们看看当我们尝试提交缺少电子邮件地址的无效POST时会发生什么。当我们在调试中进入POST操作时，我们的ModelStateDictionary中出现了以下内容：
ErrorsCollection         注意，电子邮件属性的ModelState实例中的Errors集合现在记录了一个错误。当MVC为提交上来的属性创建ModelState时，它会遍历视图模型中的每一个属性及其相关联验证属性。如果有任何错误被发现，MVC就会将错误添加到ModelState的错误信息集合中。同时，我们还能注意到的是：isVaild这一属性现在也是false了。这是因为现在有错误出现了，而对于isVaild而言，只要有任何提交上来的属性存在错误，它就会变为false。
        以上种种设置验证的手段，都是为了让我们设计的MVC可以以其设计的方式正常运作。ModelState存储提交的值，允许它们映射到类属性（或作为操作的参数），并为每个属性保留一组错误消息。在一些简单的环境下，这些能在后台自行处理的验证手段正是我们所需要的。

六、自定义验证

那么现在问题来了，当我们需要采用更加复杂的验证手段时，我们该怎么办呢？举个例子，假设我们需要验证名字和姓氏是否相同，并在发生这种情况时显示特定的错误消息，此时我们应该如何设计验证方式呢？方法还是有的，我们实际上可以通过ModelStateDictionary上的AddModelError方法向模型状态添加错误：

[HttpPost]
public ActionResult Add(AddUserVM model)
{
    if(model.FirstName == model.LastName)
    {
        ModelState.AddModelError("LastName", "The last name cannot be the same as the first name.");
    }
    if(!ModelState.IsValid)
    {
        return View(model);
    }
    return RedirectToAction("Index");
}

AddModelError方法的第一个参数是需要显示错误信息的属性的名称。还是用刚才那个例子，我们将第一个参数设置为“LastName”。如果你只希望它出现在ValidationSummary而不是ValidationMessage中，你可以将其设置为空（或用一个假名）。
现在错误将直接显示在页面上：
AddModelError

七、总结

ModelState代表着POST提交中上传上来的值和错误信息，其验证过程必须遵守开发者指定的验证规则（像[Required]和[EmailAddress]这样的）。只要我们想，我们也可以自己定义错误信息。使用ValidationSummary和ValidationMessageFor则可以直接从ModelState读取错误信息内容并展示给用户看。更多的相关信息，我推荐你们查阅 Professional ASP.NET MVC 5，特别是第6章，里面详细介绍了使用ModelState的验证方法。我还在Github上有一个非常简单的示例项目，它演示了ModelState的工作原理，并提供了这篇文章中的所有代码和标记，推荐你们看一看！
希望各位看的开心！Happy Coding！

(1) 原文里按直译应当写作“名称与提交值对”，但从ModelState的继承形式来看，ModelState应当是一个集合。它同时继承了IConnection、IDictionary、IEnumerable等多个接口，内部含有一个键值对集合和一个与之相对应的错误信息集合，所以我将它翻译成了键值对。

(2) 这里的原句是 “MVC creates all of these instances automatically for us when we submit a POST with data, and the POST action has inputs that map to the submitted values.”。ModelState里value与name是根据model一一对应的，value即为提交上来的数值，name表示model的属性名，在view中体现为<input>标签的id。因为ModelState本身就有个键值对的缘故所以我认为作者在这里想表达的应该是说：将与input的id对应的“键”和用户输入的“值”一一对应起来，这也符合ModelState键值对集合的本质。

(3) 这三者应该都是MVC的验证特性，[Required]表示该参数或属性为必填项，即该项的输入不能为 NULL；[StringLength]用来验证字符串属性值是否未超过指定长度限制；[Display]我没有找到官方描述，但从效果上看可能是以文本的形式显示属性说明的，如果有dalao找到了官方描述的，请务必在评论区中指点一二。

推荐链接：ModelState Class (System.Web.Mvc)

不惧神风

关注

6
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
【翻译】ModelState - ASP.NET MVC 大揭秘

        科学上网找到的一篇关于ModelState的好文，翻译出来留作学习用，原文在此：The ModelState - ASP.NET MVC Demystified ModelState - ASP.NET MVC 大揭秘       &nb...
复制链接

扫一扫

专栏目录