ASP.NET MVC的四种验证编程方式

2024-10-04 03:40:10

我们可以采用4种不同的编程模式来进行针对绑定参数的验证。

一、手工验证绑定的参数

在定义具体Action方法的时候，对已经成功绑定的参数实施手工验证无疑是一种最为直接的编程方式，接下来我们通过一个简单的实例来演示如何将参数验证逻辑实现在对应的Action方法中，并在没有通过验证的情况下将错误信息响应给客户端。我们在一个ASP.NET MVC应用中定义了如下一个Person类作为被验证的数据类型，它的Name、Gender和Age三个属性分别表示一个人的姓名、性别和年龄。

public class Person
{
  [DisplayName("姓名")]
  public string Name { get; set; } 

  [DisplayName("性别")]
  public string Gender { get; set; } 

  [DisplayName("年龄")]
  public int? Age { get; set; }
}

接下来我们定义了如下一个HomeController。在针对GET请求的Action方法Index中，我们创建了一个Person对象并将其作为Model呈现在对应的View中。另一个支持POST请求的Index方法具有一个Person类型的参数，我们在该Action方法中先调用Validate方法对这个输入参数实施验证。如果验证成功（ModeState.IsValid属性返回True），我们返回一个内容为“输入数据通过验证”的ContentResult，否则将此参数作为Model呈现在对应的View中。

public class HomeController : Controller
{
  [HttpGet]
  public ActionResult Index()
  {
    return View(new Person());
  } 

  [HttpPost]
  public ActionResult Index(Person person)
  {
    Validate(person); 

    if (!ModelState.IsValid)
    {
      return View(person);
    }
    else
    {
      return Content("输入数据通过验证");
    }
  } 

  private void Validate(Person person)
  {
    if (string.IsNullOrEmpty(person.Name))
    {
      ModelState.AddModelError("Name", "'Name'是必需字段");
    } 

    if (string.IsNullOrEmpty(person.Gender))
    {
      ModelState.AddModelError("Gender", "'Gender'是必需字段");
    }
    else if (!new string[] { "M", "F" }.Any(
      g => string.Compare(person.Gender, g, true) == 0))
    {
      ModelState.AddModelError("Gender",
      "有效'Gender'必须是'M','F'之一");
    } 

    if (null == person.Age)
    {
      ModelState.AddModelError("Age", "'Age'是必需字段");
    }
    else if (person.Age > 25 || person.Age < 18)
    {
      ModelState.AddModelError("Age", "有效'Age'必须在18到25周岁之间");
    }
  }
}

如上面的代码片断所示，我们在Validate该方法中我们对作为参数的Person对象的3个属性进行逐条验证，如果提供的数据没有通过验证，我们会调用当前ModelState的AddModelError方法将指定的验证错误消息转换为ModelError保存起来。我们采用的具体的验证规则如下。

Person对象的Name、Gender和Age属性均为必需字段，不能为Null（或者空字符串）。
表示性别的Gender属性的值必需是“M”（Male）或者“F”（Female），其余的均为无效值。
Age属性表示的年龄必须在18到25周岁之间。
如下所示的是Action方法Index对应View的定义，这是一个Model类型为Person的强类型View，它包含一个用于编辑人员信息的表单。我们直接调用HtmlHelper<TModel> 的扩展方法EditorForModel将作为Model的Person对象以编辑模式呈现在表单之中。

@model Person
<html>
<head>
  <title>编辑人员信息</title>
</head>
<body>
  @using (Html.BeginForm())
  {
    @Html.EditorForModel()
    <input type="submit" value="保存"/>
  }
</body>
</html>

直接运行该程序后，一个用于编辑人员基本信息的页面会被呈现出来，如果我们在输入不合法的数据并提交后，相应的验证信息会以图1所示的形式呈现出来。

二、使用ValidationAttribute特性

将针对输入参数的验证逻辑和业务逻辑定义在Action方法中并不是一种值得推荐的编程方式。在大部分情况下，同一个数据类型在不同的应用场景中具有相同的验证规则，如果我们能将验证规则与数据类型关联在一起，让框架本身来实施数据验证，那么最终的开发者就可以将关注点更多地放在业务逻辑的实现上面。实际上这也是ASP.NET MVC的Model验证系统默认支持的编程方式。当我们在定义数据类型的时候，可以在类型及其数据成员上面应用相应的ValidationAttribute特性来定义默认采用的验证规则。

“System.ComponentModel.DataAnnotations”命名空间定义了一系列具体的ValidationAttribute特性类型，它们大都可以直接应用在自定义数据类型的某个属性上对目标数据成员实施验证。这些预定义验证特性不是本章论述的重点，我们会在“下篇”中对它们作一个概括性的介绍。

常规验证可以通过上面列出的这些预定义ValidationAttribute特性来完成，但是在很多情况下我们需要通过创建自定义的ValidationAttribute特性来解决一些特殊的验证。比如上面演示实例中针对Person对象的验证中，我们要求Gender属性指定的表示性别的值必须是“M/m”和“F/f”两者之一，这样的验证就不得不通过自定义的ValidationAttribute特性来实现。

针对 “某个值必须在指定的范围内”这样的验证规则，我们定义一个DomainAttribute特性。如下面的代码片断所示，DomainAttribute具有一个IEnumerable<string>类型的只读属性Values提供了一个有效值列表，该列表在构造函数中被初始化。具体的验证实现在重写的IsValid方法中，如果被验证的值在这个列表中，则视为验证成功并返回True。为了提供一个友好的错误消息，我们重写了方法FormatErrorMessage。

[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field,  AllowMultiple = false)]
public class DomainAttribute : ValidationAttribute
{
  public IEnumerable<string> Values { get; private set; } 

  public DomainAttribute(string value)
  {
    this.Values = new string[] { value };
  } 

  public DomainAttribute(params string[] values)
  {
    this.Values = values;
  } 

  public override bool IsValid(object value)
  {
    if (null == value)
    {
      return true;
    }
    return this.Values.Any(item => value.ToString() == item);
  } 

  public override string FormatErrorMessage(string name)
  {
    string[] values = this.Values.Select(value => string.Format("'{0}'", value)).ToArray();
    return string.Format(base.ErrorMessageString, name,string.Join(",",  values));
  }
}

由于ASP.NET MVC在进行参数绑定的时候会自动提取应用在目标参数类型或者数据成员上的ValidationAttribute特性，并利用它们对提供的数据实施验证，所以我们不再需要像上面演示的实例一样自行在Action方法中实施验证，而只需要在定义参数类型Person的时候应用相应的ValidationAttribute特性将采用的验证规则与对应的数据成员相关联。

如下所示的是属性成员上应用了相关ValidationAttribute特性的Person类型的定义。我们在三个属性上均应用了RequiredAttribute特性将它们定义成必需的数据成员，Gender和Age属性上则分别应用了DomainAttribute和RangeAttribute特性对有效属性值的范围作了相应限制。

public class Person
{
  [DisplayName("姓名")]
  [Required(ErrorMessageResourceName = "Required",  ErrorMessageResourceType = typeof(Resources))]
  public string Name { get; set; } 

  [DisplayName("性别")]
  [Required(ErrorMessageResourceName = "Required",  ErrorMessageResourceType = typeof(Resources))]
  [Domain("M", "F", "m", "f", ErrorMessageResourceName = "Domain", ErrorMessageResourceType = typeof(Resources))]
  public string Gender { get; set; } 

  [DisplayName("年龄")]
  [Required(ErrorMessageResourceName = "Required", ErrorMessageResourceType = typeof(Resources))]
  [Range(18, 25, ErrorMessageResourceName = "Range", ErrorMessageResourceType = typeof(Resources))]
  public int? Age { get; set; }
}

三个ValidationAttribute特性采用的错误消息均定义在项目默认的资源文件中（我们可以采用这样的步骤创建这个资源文件：右键选择Solution Exploror中的项目，并在上下文菜单中选择“属性”选项打开“项目属性”对象框。最后在对话框中选择“资源”Tab页面，通过点击页面中的链接创建一个资源文件），具体定义如图2所示。

由于ASP.NET MVC会自动提取应用在绑定参数类型上的ValidationAttribute特性对绑定的参数实施自动化验证，所以我们根本不需要在具体的Action方法中来对参数作手工验证。如下面的代码片断所示，我们在Action方法Index中不再显式调用Validate方法，但是运行该程序并在输入不合法数据的情况下提交表单后依然会得到如图1所示的输出结果。

public class HomeController : Controller
{
  //其他成员
  [HttpPost]
  public ActionResult Index(Person person)
  {
    if (!ModelState.IsValid)
    {
      return View(person);
    }
    else
    {
      return Content("输入数据通过验证");
    }
  }
}

三、让数据类型实现IValidatableObject接口

除了将验证规则通过ValidationAttribute特性直接定义在数据类型上并让ASP.NET MVC在进行参数绑定过程中据此来验证参数之外，我们还可以将验证操作直接定义在数据类型中。既然我们将验证操作直接实现在了数据类型上，意味着对应的数据对象具有“自我验证”的能力，我们姑且将这些数据类型称为“自我验证类型”。这些自我验证类型是实现了具有如下定义的接口IValidatableObject，该接口定义在“System.ComponentModel.DataAnnotations”命名空间下。

public interface IValidatableObject
{
  IEnumerable<ValidationResult> Validate( ValidationContext validationContext);
}

如上面的代码片断所示，IValidatableObject接口具有唯一的方法Validate，针对自身的验证就实现在该方法中。对于上面演示实例中定义的数据类型Person，我们可以按照如下的形式将它定义成自我验证类型。

public class Person: IValidatableObject
{
  [DisplayName("姓名")]
  public string Name { get; set; } 

  [DisplayName("性别")]
  public string Gender { get; set; } 

  [DisplayName("年龄")]
  public int? Age { get; set; } 

  public IEnumerable<ValidationResult> Validate( ValidationContext validationContext)
  {
    Person person = validationContext.ObjectInstance as Person;
    if (null == person)
    {
      yield break;
    }
    if(string.IsNullOrEmpty(person.Name))
    {
      yield return new ValidationResult("'Name'是必需字段", new string[]{"Name"});
    } 

    if (string.IsNullOrEmpty(person.Gender))
    {
      yield return new ValidationResult("'Gender'是必需字段", new string[] { "Gender" });
    }
    else if (!new string[]{"M","F"}.Any( g=>string.Compare(person.Gender,g, true) == 0))
    {
      yield return new ValidationResult("有效'Gender'必须是'M','F'之一",  new string[] { "Gender" });
    } 

    if (null == person.Age)
    {
      yield return new ValidationResult("'Age'是必需字段",  new string[] { "Age" });
    }
    else if (person.Age > 25 || person.Age < 18)
    {
      yield return new ValidationResult("'Age'必须在18到25周岁之间",  new string[] { "Age" });
    }
  }
}

如上面的代码片断所示，我们让Person类型实现了IValidatableObject接口。在实现的Validate方法中，我们从验证上下文中获取被验证的Person对象，并对其属性成员进行逐个验证。如果数据成员没有通过验证，我们通过一个ValidationResult对象封装错误消息和数据成员名称（属性名），该方法最终返回的是一个元素类型为ValidationResult的集合。在不对其他代码作任何改动的情况下，我们直接运行该程序并在输入不合法数据的情况下提交表单后依然会得到如图1所示的输出结果。

四、让数据类型实现IDataErrorInfo接口

上面我们让数据类型实现IValidatableObject接口并将具体的验证逻辑定义在实现的Validate方法中，这样的类型能够被ASP.NET MVC所识别，后者会自动调用该方法对绑定的数据对象实施验证。如果我们让数据类型实现IDataErrorInfo接口也能实现类似的自动化验证效果。

IDataErrorInfo接口定义在“System.ComponentModel”命名空间下，它提供了一种标准的错误信息定制方式。如下面的代码片段所示，IDataErrorInfo具有两个成员，只读属性Error用于获取基于自身的错误消息，而只读索引用于返回指定数据成员的错误消息。

public interface IDataErrorInfo
{
  string Error { get; }
  string this[string columnName] { get; }
}

同样是针对上面演示的实例，现在我们对需要被验证的数据类型Person进行了重新定义。如下面的代码片断所示，我们让Person实现了IDataErrorInfo接口。在实现的索引中，我们将索引参数columnName视为属性名称，根据它按照上面的规则对相应的属性成员实施验证，并在验证失败的情况下返回相应的错误消息。在不对其他代码作任何改动的情况下，我们直接运行该程序并在输入不合法数据的情况下提交表单后依然会得到如图1所示的输出结果。

public class Person : IDataErrorInfo
{
  [DisplayName("姓名")]
  public string Name { get; set; } 

  [DisplayName("性别")]
  public string Gender { get; set; } 

  [DisplayName("年龄")]
  public int? Age { get; set; } 

  [ScaffoldColumn(false)]
  public string Error { get; private set; } 

  public string this[string columnName]
  {
    get
    {
      switch (columnName)
      {
        case "Name":
          {
            if(string.IsNullOrEmpty(this.Name))
            {
              return "'姓名'是必需字段";
            }
            return null;
          }
        case "Gender":
          {
            if (string.IsNullOrEmpty(this.Gender))
            {
              return "'性别'是必需字段";
            }
            else if (!new string[] { "M", "F" }.Any(
              g => string.Compare(this.Gender, g, true) == 0))
            {
              return "'性别'必须是'M','F'之一";
            }
            return null;
          }
        case "Age":
          {
            if (null == this.Age)
            {
              return "'年龄'是必需字段";
            }
            else if (this.Age > 25 || this.Age < 18)
            {
              return "'年龄'必须在18到25周岁之间";
            }
            return null;
          }
        default: return null; 

      }
    }
  }
}

以上就是采用4种不同的编程模式来进行针对绑定参数验证的实现代码，希望对大家的学习有所帮助。

ASP.NET MVC自定义错误页面真的简单吗?

如果你在设置asp.net mvc自定义错误页面时遇到问题,这并不止你一个人.惊讶之余你的做法是正确的,没有起到作用的原因是其一部分错误是由asp.net管道处理的,另一部分是由iis直接处理. 通常情况 (我期望是这种情况,在一些其他框架/服务器上) 我们只需要在一个地方配置自定义错误页就可以了,无论怎么哪儿引发的错误.就像这样︰ <customErrors mode="On"> <error code="404" path="404.
ASP.NET MVC阿里大于短信接口开发短信群发能

互联网上有许多公司提供短信接口服务,诸如网易云信.阿里大于等等.我在自己项目里需要使用到短信服务起到通知作用,实际开发周期三天,完成配置.开发和使用,总的说,阿里大于提供的接口易于开发,非常的方便,短信费用是计数缴纳的,作为个人开发者,我使用的服务业务产生的费用为0.045￥/条(10万条以下). 现在要实现一个例会短信群发通知的功能,所有被通知对象信息均存于Mysql中,应用架构采用asp.net MVC .首先准备好获取的API各项(以下各项服务参数都需要在大于官网上申请), 申请好自己的短
ASP.NET MVC5+EF6+EasyUI后台管理系统微信公众平台开发之消息管理

前言回顾上一节,我们熟悉的了解了消息的请求和响应,这一节我们来建立数据库的表,表的设计蛮复杂你也可以按自己所分析的情形结构来建表必须非常熟悉表的结果才能运用这张表,这表表的情形涵盖比较多思维导图我这个人比较喜欢用思维导图来分析和表达一些模型: 表结构根据思维导图,我们可以建立的表可以是3张表:消息表,规则表,类型表消息表:实际的消息规则表:文本.图文.语音等类型表:文本.图文.语音(默认回复,订阅回复) 也可以是两张表:规制表,消息表(+一个类型字段) 我这里只设计一张表:消
ASP.NET MVC中URL地址传参的两种写法

一.url地址传参的第一种写法 1.通过mvc中默认的url地址书写格式:控制器/方法名/参数 2.实例:http://localhost:39270/RequestDemo/Index/88,默认参数名为id所以名称为id. 如果使用其他名称,后台是无法读取的会报错二.url地址传参的第二种写法 1.使用?加参数名=参数值的写法,如果有多个参数使用&来连接 http://localhost:39270/RequestDemo/Index?id=88&name=%E5%BC%A0%E4%
ASP.NET MVC4 Razor模板简易分页效果

一.无数据提交第一步,建立一个 Controller命名为PageIndex的空控制器,自定义一个方法如下: public ActionResult PageIndex(string action, string controller, int currentPage, int pageCount) { //int count = db.Product.Count(); ViewBag.PageCount = pageCount;//从操作中获取总数据页数将传入分页视图页面 ViewBag.C
ASP.NET MVC下的四种验证编程方式[续篇]

在<ASP.NET MVC的四种验证编程方式>一文中我们介绍了ASP.NET MVC支持的四种服务端验证的编程方式("手工验证"."标注ValidationAttribute特性"."让数据类型实现IValidatableObject或者IDataErrorInfo"),那么在ASP.NET MVC框架内部是如何提供针对这四种不同编程方式的支持的呢?接下来我们就来聊聊这背后的故事. 一.ModelValidator与ModelVali
ASP.NET MVC分页和排序功能实现

分页和排序,应该是软件开发中,需要必知必会的技能了,对于分页,网上很多教程,当然,别人终究是别人的,只有自己理解,会了,并且吸收之后,再用自己的语言,传授出来,这才是硬道理.好了,废话说多了.现在我们进入正题: 这里,我打算使用EF Code-First方式分页控件就是用PagedList.MVC,来做分页,对于排序,实现的思路是,加载数据出来之后,默认是升序排序,然后我们点击一下相应的列标题,就按照该字段降序排序,查数据.思路明确了,就开始干吧! 1.首先新建一个空白的MVC项目,在Model
ASP.NET MVC5网站开发之登录、验证和注销管理员篇1（六）

上次业务逻辑和展示层的架构都写了,可以开始进行具体功能的实现,这次先实现管理员的登录.验证和注销功能. 一.业务逻辑层1.实现256散列加密方法. Ninesky.Core[右键]-> 添加->文件夹,输入文件夹名General. General文件夹[右键]->添加->类,输入类名Security. 引用System.Security.Cryptography命名空间(1),并实现SHA256静态加密方法. 2.Administrator模型类 Ninesky.Core[右键]-
ASP.NET MVC5验证系列之客户端验证

前面学习了,服务端验证,这篇文章中,我们接着学习客户端验证,客户端的验证,使用Jquery和Jquery插件来实现[jquery.validate.min.js and jquery.validate.unobtrusive.min.js) ] 在服务端验证中,页面必须要提交到服务器,进行验证,如果数据验证不通过,服务器端就会发送一个响应到客户端,然后客户端根据相应的信息,进行处理:而客户端验证则不同,用户输入的数据,只要一提交,客户端就会进行先验证,如果不通过就报错,不会提交到服务器进行验证,
asp.net mvc4中bootstrap datetimepicker控件的使用

前段时间写了一篇关于调用阿里大于的短信接口来开发例会短信群发通知功能的文章http://www.jb51.net/article/94142.htm,其中的例会时间是需求中的重中之重,它需要满足"格式化","易输入"这两点,对短信费用关心的开发者要知道长短信是两条短信费用之和,因此,例会时间不能随意交给用户自定义输入:要考虑到"易输入"这点,只能选择日期选择控件来辅助用户输入,由于日期选择控件较为小巧使用,在页面中引入并不是难事.在本篇文章中,使
Asp.net MVC中获取控制器的名称的方法

1.视图中 string controller = ViewContext.RouteData.Route.GetRouteData(this.Context).Values["controller"].ToString(); string controller = ViewContext.RouteData.Values["controller"].ToString(); 2.控制器的action中 string controller = RouteData.Ro
ASP.NET MVC5+EF6+EasyUI后台管理系统微信公众平台开发之资源环境准备

前言: 本次将学习扩展企业微信公众号功能,微信公众号也是企业流量及品牌推广的主要途径,所谓工欲善其事必先利其器,调试微信必须把程序发布外网环境,导致调试速度太慢,太麻烦! 我们需要准备妥当才能进入开发,为后续快速开发作准备什么是内网穿透? 意在外部网络通过域名可以访问本地IIS站点! 软件环境: Windows10+IIS10 (把本地站点配置到IIS10做为备用,发布站点不作为教程) 知识点:花生壳(主要)ngrok开始: 首先发布站点到IIS,我这里发布站点到本地IIS,并绑定端口为:80
Asp.NET MVC中使用SignalR实现推送功能

一.简介 Signal 是微软支持的一个运行在 Dot NET 平台上的 html websocket 框架.它出现的主要目的是实现服务器主动推送(Push)消息到客户端页面,这样客户端就不必重新发送请求或使用轮询技术来获取消息. 可访问其官方网站:https://github.com/SignalR/ 获取更多资讯. 二.Asp.net SignalR 是个什么东东 Asp.net SignalR是微软为实现实时通信的一个类库.一般情况下,SignalR会使用JavaScript的长轮询(lo

ASP.NET MVC的四种验证编程方式

相关推荐

随机推荐