博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
[ASP.NET MVC]如何定制Numeric属性/字段验证消息
阅读量:5784 次
发布时间:2019-06-18

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

对于一个Numeric属性/字段,ASP.NET MVC会自动进行数据类型的验证(客户端验证),以确保输入的是一个有效的数字,但是呈现在页面上的错误消息总是一段固定的文本:“The field {0} must be a number”,本篇提供一种解决方案使我们可以对此验证消息进行定制。[源代码从下载]

目录

一、针对Numeric属性/字段默认验证消息
二、默认的验证消息来源于何处?
三、通过自定义ModelValidatorProvider替换NumericModelValidator
四、注册自定义ModelValidatorProvider

一、针对Numeric属性/字段默认验证消息

我们先来通过一个简单的例子来验证这个问题,为此我们定义了如下一个表示员工信息的Employee类型,其中代表年龄的Age属性类型为整型。

1: public class Employee
2: {
3:     [Display(Name = "姓名")]
4:     public string Name { get; set; }
5: 
6:     [Display(Name = "性别")]
7:     public string Gender { get; set; }
8: 
9:     [Display(Name = "年龄")]
10:     public int Age { get; set; }
11: }

我们创建一个Model类型为Employee的View对某个元员工的信息进行修改。如下图所示,当我们输入一个非数字字符串作为Age字段的时候,验证错误信息显示为“The field 年龄 must be a number”,值得一提的是:当前线程的CurrentUICulture为zh-CN。

二、默认的验证消息来源于何处?

针对数字类型字段进行验证的是一个名称为NumericModelValidator的ModelValidator,不过这是个定义在System.Web.Mvc程序集中俄内部类型。如果采用Reflector查看其定义,可以发现用于返回错误消息的方法是一个名为MakeErrorString的静态方法。如下面的代码所示,作为错误消息的字符串来源于内嵌于程序集中的资源文件。

1: internal sealed class NumericModelValidator : ModelValidator
2: {
3:     //其他成员
4:     private static string MakeErrorString(string displayName)
5:     {
6:         return string.Format(CultureInfo.CurrentCulture, MvcResources.ClientDataTypeModelValidatorProvider_FieldMustBeNumeric, new object[] { displayName });
7:     }
8: }

NumericModelValidator最终是通过ClientDataTypeModelValidatorProvider这个一个ModelValidatorProvider提供的。

三、通过自定义ModelValidatorProvider替换NumericModelValidator

如果我们想改变内部类型NumericModelValidator的错误消息,可以通过将ClientDataTypeModelValidatorProvider提供的NumericModelValidator替换成另一个ModelValidator。在这里我们替换的是一个DataAnnotationsModelValidator,而它基于的ValidationAttribute是我们自定义的NumericAttribute。

如下面的代码片断所示,内部类型NumericAttribute是ValidationAttribute的子类,并且实现了IClientValidatable接口。在这里我么只考虑客户端验证,所以重写的IsValid方法直接返回True,而GetClientValidationRules方法则返回一个包含一个验证类型为“number”的ModelClientValidationRule对象的集合。我们使用FormatErrorMessage方法格式化后的字符串作为ModelClientValidationRule的ErrorMessage属性。

1: internal class NumericAttribute : ValidationAttribute, IClientValidatable
2: {
3:     public override bool IsValid(object value)
4:     {
5:         return true;
6:     }
7:     public IEnumerable
GetClientValidationRules(ModelMetadata metadata, ControllerContext context)
8:     {
9:         yield return new ModelClientValidationRule { ValidationType = "number", ErrorMessage = this.FormatErrorMessage(metadata.DisplayName)};
10:     }
11: }

现在我们需要做的就是通过一个自定义ModelValidatorProvider将ClientDataTypeModelValidatorProvider提供的NumericModelValidator替换成基于NumericAttribute的DataAnnotationsModelValidator,所以我们定义了一个直接继承自ClientDataTypeModelValidatorProvider的FilterableClientDataTypeModelValidatorProvider。如下面的代码所示,在重写的GetValidators方法中我们完成了针对NumericModelValidator的替换。对于被创建的NumericAttribute来说,我们指定的错误消息也定义在Resource文件中(为了提供多语言的支持),而基于zh的内容为“{0}必须是一个数字!”。

1: public class FilterableClientDataTypeModelValidatorProvider : ClientDataTypeModelValidatorProvider
2: {
3:     public override IEnumerable
GetValidators(ModelMetadata metadata, ControllerContext context)
4:     {
5:         var allValidators = base.GetValidators(metadata, context);
6:         var validators = new List
();
7:         foreach (var v in allValidators)
8:         {
9:             if (v.GetType().Name != "NumericModelValidator")
10:             {
11:                 validators.Add(v);
12:             }
13:             else
14:             {
15:                 NumericAttribute attribute = new NumericAttribute{ ErrorMessage = Resources.FieldMustBeNumeric};
16:                 DataAnnotationsModelValidator validator = new DataAnnotationsModelValidator(metadata, context, attribute);
17:                 validators.Add(validator);
18:             }
19:         }
20:         return validators;
21:     }
22: }

四、注册自定义ModelValidatorProvider

现在我们只需要通过ModelValidatorProvider的注册让我们自定义的FilterableClientDataTypeModelValidatorProvider替换默认的ClientDataTypeModelValidatorProvider。在Global.asax中,针对FilterableClientDataTypeModelValidatorProvider的注册可以通过如下的代码来完成。

1: public class MvcApplication : System.Web.HttpApplication
2: {
3:     //其他成员
4:     protected void Application_Start()
5:     {
6:          //其他操作
7:         var clientDataTypeValidator = ModelValidatorProviders.Providers.OfType
().FirstOrDefault();
8:         if (null != clientDataTypeValidator)
9:         {
10:             ModelValidatorProviders.Providers.Remove(clientDataTypeValidator);
11:         }
12:         ModelValidatorProviders.Providers.Add(new FilterableClientDataTypeModelValidatorProvider());
13:     }
14: }

现在运行我们的程序就可以得到我们定制的错误消息了。

转载地址:http://oavyx.baihongyu.com/

你可能感兴趣的文章
胖哥学SpringMVC:请求方式转换过滤器配置
查看>>
Kotlin 更加优雅的 Builder - 理解 with
查看>>
前端日拱一卒D6——字符编码与浏览器解析
查看>>
深入理解浏览器的缓存机制
查看>>
微软向Linux社区开放60000多项专利:对开源微软是认真的
查看>>
Hoshin Kanri在丰田的应用
查看>>
又拍云沈志华:如何打造一款安全的App
查看>>
克服大数据集群的挑战
查看>>
PostgreSQL并发控制(MVCC, 事务,事务隔离级别)
查看>>
DM***的第二阶段OSPF
查看>>
20180702搭建青岛RAC记录
查看>>
Spring Security OAuth 实现OAuth 2.0 授权
查看>>
linux文件及简单命令学习
查看>>
dubbo源码分析-架构
查看>>
新 Terraform 提供商: Oracle OCI, Brightbox, RightScale
查看>>
6套毕业设计PPT模板拯救你的毕业答辩
查看>>
IT兄弟连 JavaWeb教程 JSP与Servlet的联系
查看>>
Windows phone 8 学习笔记
查看>>
linux并发连接数:Linux下高并发socket最大连接数所受的各种限制
查看>>
详解区块链中EOS的作用。
查看>>