博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
ASP.NET MVC ModelState与数据验证【转】
阅读量:5997 次
发布时间:2019-06-20

本文共 4697 字,大约阅读时间需要 15 分钟。

ViewData有一个ModelState的属性,这是一个类型为ModelStateDictionary的ModelState类型的字典集合。在进行数据验证的时候这个属性是比较有用的。在使用Html.ValidationMessage()的时候,就是从ViewData.ModelState中检测是否有指定的KEY,如果存在,就提示错误信息。例如在前一篇文章中使用到的UpdateModel方法:

我们在View中使用Html.ValidationMessage(string modelName)来对指定的属性进行验证:

Html.ValidationMessage()有几个重载:

其中ValidationSummary()是用于显示全部的验证信息的。跟ASP.NET里面的ValidationSummary验证控件差不多。

我们测试一下/Admin/Setting页面:

在用UpdateModel方法更新BlogSettings.Instance.PostsPerPage的时候,当我们如图所示填写"10d"的时候,由于PostsPerPage为整型的,所以UpdateModel方法就会出错,同时会往ViewData.ModelState添加相应的错误信息,从而Html.ValidationMessage()方法就可以从ViewData.ModelState中检测到错误并提示。同时Html.ValidationMessage()方法会为出错的属性的输入框添加一个名为"input-validation-error"的CSS类,同时后面的提示信息的CSS类名为"field-validation-error":

CSS类的样式是可以由我们自己自由定义的。如上图的红色高亮显示。

好,下面我们来实现发表新随笔的功能。我们先写一个提供用户输入随笔内容的表单页面:

<p>

<label for="Title">标题</label>
<%=Html.TextBox("Title", new { id = "Title", @class = "required" })%>
<%=Html.ValidationMessage("Title")%>
</p>
<p>
<label for="Content">内容</label>
<%=Html.TextArea("Content")%>
<%=Html.ValidationMessage("Content")%>
</p>
<p>
<label for="Slug">URL地址别名(如果为空则和标题同名)</label>
<%=Html.TextBox("Slug", new { id = "Slug", @class = "required" })%>
<%=Html.ValidationMessage("Slug")%>
</p>

然后我们对用户提交过来的数据进行保存:

[AcceptVerbs("POST"), ActionName("NewPost")]

public ActionResult SaveNewPost(FormCollection form)
{
    Post post = new Post();
try
    {
        UpdateModel(post, new[] { "Title", "Content", "Slug" });
    }
catch
    {
return View(post);
    }
    post.Save();
return ShowMsg(new List<string>() { "发表新随笔成功" });
}

由于这三个值都是字符串类型,所以如果值为空的话,UpdateModel也是不会出错的,而我们的Title和Content是不允许为空的,或者我们想我们的Slug的长度不能超过100,也就是需要有我们自己的业务规则。这时候我们或许会这样写:

try

{
    UpdateModel(post, new[] { "Title", "Content", "Slug" });
}
catch
{
return View(post);
}
if (string.IsNullOrEmpty(post.Title))
{
    ViewData.ModelState.AddModelError("Title", post.Title, "标题不能为空");
}
if (string.IsNullOrEmpty(post.Content))
{
    ViewData.ModelState.AddModelError("Content", post.Content, "内容不能为空");
}
if (!ViewData.ModelState.IsValid)
{
return View(post);
}

ViewData.ModelState提供了一个AddModelError的方法,方便我们添加验证失败的信息。我们可以如上代码这样进行对象的业务规则验证,但是一旦业务规则多了,这样的代码是非常壮观的,而且不好控制。那么我们该怎么更好的进行业务规则的验证呢?得意于BlogEngine.Net的良好架构,我们可以很轻松的完成这一点。

首先,让我们修改一下BlogEngine.Core里面BusinessBase的代码。我们前面说过,BusinessBase实现了IDataErrorInfo接口,该接口有个索引器,导致ViewData.Eval()方法调用时搜索索引器的值时返回String.Empty而使ViewData.Eval()认为是找到值了,从而失效。

我们可以将return string.Empty修改为return null。但我们这里并不需要用到这个接口,所以我们把该接口去掉,并把相应的代码注释了。然后我们再暴露一个BrokenRules的属性,用于返回当前的所有破坏性业务规则(红框部分代码为我们添加的):

BusinessBase提供了一个抽象的ValidationRules方法,用于在业务类重写这个方法往里面添加验证规则(具体请看BusinessBase的Validation节)。

ExpandedBlockStart.gif

ExpandedBlockStart.gif#region Validation
InBlock.gif
InBlock.gifprivate StringDictionary _BrokenRules = new StringDictionary();
ExpandedSubBlockStart.gif/// <summary>
InBlock.gif/// 获取所有的破坏性规则。
InBlock.gif/// 在获取前请用IsValid进行判断。
ExpandedSubBlockEnd.gif/// </summary>
InBlock.gifpublic StringDictionary BrokenRules
ExpandedSubBlockStart.gif{
InBlock.gif get
ExpandedSubBlockStart.gif {
InBlock.gif return _BrokenRules;
ExpandedSubBlockEnd.gif    }
ExpandedSubBlockEnd.gif}
InBlock.gif
ExpandedSubBlockStart.gif/// <summary>
InBlock.gif/// Add or remove a broken rule.
InBlock.gif/// </summary>
InBlock.gif/// <param name="propertyName">The name of the property.</param>
InBlock.gif/// <param name="errorMessage">The description of the error</param>
ExpandedSubBlockEnd.gif/// <param name="isBroken">True if the validation rule is broken.</param>
InBlock.gifprotected virtual void AddRule(string propertyName, string errorMessage, bool isBroken)
ExpandedSubBlockStart.gif{
InBlock.gif if (isBroken)
ExpandedSubBlockStart.gif {
InBlock.gif        _BrokenRules[propertyName] = errorMessage;
ExpandedSubBlockEnd.gif    }
InBlock.gif else
ExpandedSubBlockStart.gif {
InBlock.gif if (_BrokenRules.ContainsKey(propertyName))
ExpandedSubBlockStart.gif {
InBlock.gif            _BrokenRules.Remove(propertyName);
ExpandedSubBlockEnd.gif        }
ExpandedSubBlockEnd.gif    }
ExpandedSubBlockEnd.gif}
InBlock.gif
ExpandedSubBlockStart.gif/// <summary>
InBlock.gif/// Reinforces the business rules by adding additional rules to the
InBlock.gif/// broken rules collection.
ExpandedSubBlockEnd.gif/// </summary>
InBlock.gifprotected abstract void ValidationRules();
InBlock.gif
ExpandedSubBlockStart.gif/// <summary>
InBlock.gif/// Gets whether the object is valid or not.
ExpandedSubBlockEnd.gif/// </summary>
InBlock.gifpublic bool IsValid
ExpandedSubBlockStart.gif{
InBlock.gif get
ExpandedSubBlockStart.gif {
InBlock.gif        ValidationRules();
InBlock.gif return this._BrokenRules.Count == 0;
ExpandedSubBlockEnd.gif    }
ExpandedSubBlockEnd.gif}
InBlock.gif
ExpandedSubBlockStart.gif/// /// <summary>
InBlock.gif/// If the object has broken business rules, use this property to get access
InBlock.gif/// to the different validation messages.
ExpandedSubBlockEnd.gif/// </summary>
InBlock.gifpublic virtual string ValidationMessage
ExpandedSubBlockStart.gif{
InBlock.gif get
ExpandedSubBlockStart.gif {
InBlock.gif if (!IsValid)
ExpandedSubBlockStart.gif {
InBlock.gif            StringBuilder sb = new StringBuilder();
InBlock.gif foreach (string messages in this._BrokenRules.Values)
ExpandedSubBlockStart.gif {
InBlock.gif                sb.AppendLine(messages);
ExpandedSubBlockEnd.gif            }
InBlock.gif
InBlock.gif return sb.ToString();
ExpandedSubBlockEnd.gif        }
InBlock.gif
InBlock.gif return string.Empty;
ExpandedSubBlockEnd.gif    }
ExpandedSubBlockEnd.gif}
InBlock.gif
ExpandedBlockEnd.gif#endregion

我们在Post类中重写这个方法来添加验证规则:

然后我们可以在Controller的Action中很优雅的书写我们的代码来进行业务规则的验证:

[AcceptVerbs("POST"), ActionName("NewPost")]

public ActionResult SaveNewPost(FormCollection form)
{
    Post post = new Post();
try
    {
        UpdateModel(post, new[] { "Title", "Content", "Slug" });
    }
catch
    {
return View(post);
    }
if (!post.IsValid)
    {
foreach (string key in post.BrokenRules.Keys)
        {
            ViewData.ModelState.AddModelError(key, form[key], post.BrokenRules[key]);
        }
return View(post);
    }
    post.Save();
return ShowMsg(new List<string>() { "发表新随笔成功" });
}

我们注意到上面的Action中用到了一个FormCollection 的参数,这个参数系统会自动将Form提交过来的全部表单值(Request.Form)赋给它的。客户端验证可以用jQuery的验证插件来,这里就不罗嗦了。

暂时就写这么多吧,想到什么再补充。Enjoy!Post by 。

本文的Blog程序示例代码:

你可能感兴趣的文章
JDBC 批量插入数据优化, 使用 addBatch 和 executeBatch
查看>>
设置Tabbar和NavigationBar的颜色
查看>>
攻击JavaWeb应用[5]-MVC安全
查看>>
Java 各种锁的小结
查看>>
600门免费在线编程/计算机科学课程(1月更新版)
查看>>
golang常用手册:运算符、条件语句、循环语句
查看>>
设计模式解析-1:观察者模式
查看>>
CoordinatorLayout实现酷炫折叠效果
查看>>
微信小程序模仿网易云音乐
查看>>
AliOS Things图形界面开发指南
查看>>
EasyAndroid基础集成组件库之:EasyPermissions 动态权限申请库
查看>>
UIPresentationController
查看>>
微服务架构的核心要点和实现原理解析
查看>>
并发编程之显式条件
查看>>
线上服务器部署(前后端)(12 个视频)
查看>>
技术人的职业规划
查看>>
JDK1.8 十大新特性详解
查看>>
S/4HANA和CRM Fiori应用的搜索分页实现
查看>>
Association, Composition and Aggregation in UI5, CRM, S/4HANA and C4C
查看>>
写给社区的回顾和展望:TiDB 2019, Level Up !
查看>>