c# 数据标注与数据校验
数据标注(Data Annotation)是类或类成员添加上下文信息的一种方式,在 C# 通常用特性(Attribute)类来描述。它的用途主要可以分为下面这三类:
- 验证 Validation:向数据添加验证规则
- 显示 Display:指定数据如何呈现给用户
- 模型 Modelling:添加关于用法和与其它类的关系信息
下面是一个用来验证和展现用户信息的一个 Model:
class Kid { [Range(0, 18)] // 年龄不能超过18岁,不能为负数 public int Age { get; set; } [StringLength(MaximumLength = 50, MinimumLength = 3)] // 名称的长度不能超过 50,不能小于 3 public string Name { get; set; } [DataType(DataType.Date)] // 生日将作为日期展示 (不带时间) public DateTime Birthday { get; set; } }
数据标注的显示用途主要在早期的 ASP.NET 和 ASP.NET MVC 等框架中使用。例如,在 ASP.NET MVC 中,Razor 引擎会根据 Model 属性的 DataType 特性动态生成不同类型的表单元素。不过,现在这类用途除了 WPF(比如 EditableAttribute
)已经过时很少用了。
数据标注用来验证数据的合法性是最常见的用法,在 ASP.NET Core/Mvc 中,数据作为表单 Model 提交时,框架会对 Model 数据自动进行校验,也可以手动调用 ModelState.IsValid()
来判断数据是否合法。
自定义校验特性
自定义一个校验特性很简单,创建一个继承 ValidationAttribute
的类,然后重写它的 IsValid
方法。示例:
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)] public class EvenNumberAttribute : ValidationAttribute { public override bool IsValid(object input) { if (input == null) return false; if (!int.TryParse(input.ToString(), out int val)) return false; return val % 2 == 0; } }
然后这个特性可以这么用:
public class Model { [EvenNumberAttribute(ErrorMessage = "数字必须是偶数")] public int MyNumber { get; set; } }
除了这自定义校验的方式,C# 还提供了一个 CustomValidation
特性,也是用来自定义数据校验的,它是通过反射的方式来实现的。示例:
public class Model { [CustomValidation(typeof(MyCustomValidation), "IsNotEvenNumber")] public int MyNumber { get; set; } } public static class MyCustomValidation { public static ValidationResult IsNotEvenNumber(object input) { var result = new ValidationResult("数字必须是偶数"); if (input == null || !int.TryParse(input.ToString(), out int val)) return result; return val % 2 == 0 ? ValidationResult.Success : result; } }
C# 内置了很多常用数据校验特性类,比如最常用的 RequiredAttribute
、StringLengthAttribute
、RangeAttribute
等。
手动执行数据校验
大多数时候,数据校验都是由框架(如 ASP.NET Core)帮我们做了,但有时候我们想手动执行校验数据怎么做呢?简单说,使用 Validator
类即可,但也不是想像的那么直接。数据校验需要提供检验的信息,比如校验规则、需要校验的属性及未通过显示的错误信息等,而这些需要由另一个类来从待校验的实例中提取作为上下文,它是 ValidationContext
,所以需要先创建 ValidationContext
对象:
ValidationContext vc = new ValidationContext(objectToValidate);
创建好这个上下文对象就可以对数据进行多种方式的校验了,比如校验对象的所有属性:
ValidationContext vc = new ValidationContext(objectToValidate); ICollection<ValidationResult> results = new List<ValidationResult>(); bool isValid = Validator.TryValidateObject(objectToValidate, vc, results, true);
也可以只校验对象的指定属性:
ValidationContext vc = new ValidationContext(objectToValidate); ICollection<ValidationResult> results = new List<ValidationResult>(); bool isValid = Validator.TryValidatePropery(objectToValidate.PropertyToValidate, vc, results, true);
返回值 isValid 表示是否所有数据都验证通过,验证失败的信息会放到 results 结果集。
看到这,我觉得手动执行校验还是有点麻烦,创建 ValidationContext
对象这一步如果也封装在 Validator
类的方法内,岂不是简洁一些?
作者:精致码农
出处:http://cnblogs.com/willick
联系:liam.wang@live.com
以上就是c# 数据标注与数据校验的详细内容,更多关于c# 数据标注与数据校验的资料请关注猪先飞其它相关文章!
相关文章
- 我们在使用C#做项目的时候,基本上都需要制作登录界面,那么今天我们就来一步步看看,如果简单的实现登录界面呢,本文给出2个例子,由简入难,希望大家能够喜欢。...2020-06-25
- 这篇文章主要介绍了C# 字段和属性的的相关资料,文中示例代码非常详细,供大家参考和学习,感兴趣的朋友可以了解下...2020-11-03
- 这篇文章主要介绍了C#中截取字符串的的基本方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-11-03
- 本文给大家分享C#连接SQL数据库和查询数据功能的操作技巧,本文通过图文并茂的形式给大家介绍的非常详细,需要的朋友参考下吧...2021-05-17
- 这篇文章主要介绍了C#实现简单的Http请求的方法,以实例形式较为详细的分析了C#实现Http请求的具体方法,需要的朋友可以参考下...2020-06-25
- 本文主要介绍了C#中new的几种用法,具有很好的参考价值,下面跟着小编一起来看下吧...2020-06-25
使用Visual Studio2019创建C#项目(窗体应用程序、控制台应用程序、Web应用程序)
这篇文章主要介绍了使用Visual Studio2019创建C#项目(窗体应用程序、控制台应用程序、Web应用程序),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25- 这篇文章主要介绍了C#开发Windows窗体应用程序的简单操作步骤,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-04-12
- 这篇文章主要介绍了C#从数据库读取图片并保存的方法,帮助大家更好的理解和使用c#,感兴趣的朋友可以了解下...2021-01-16
- 最近做一个小项目不可避免的需要前端脚本与后台进行交互。由于是在asp.net中实现,故问题演化成asp.net中jiavascript与后台c#如何进行交互。...2020-06-25
- 这篇文章主要用实例讲解C#递归算法的概念以及用法,文中代码非常详细,帮助大家更好的参考和学习,感兴趣的朋友可以了解下...2020-06-25
- 本文通过例子,讲述了C++调用C#的DLL程序的方法,作出了以下总结,下面就让我们一起来学习吧。...2020-06-25
- 轻松学习C#的基础入门,了解C#最基本的知识点,C#是一种简洁的,类型安全的一种完全面向对象的开发语言,是Microsoft专门基于.NET Framework平台开发的而量身定做的高级程序设计语言,需要的朋友可以参考下...2020-06-25
- 本文主要介绍了C#变量命名规则小结,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-09
- 这篇文章主要介绍了c#中(&&,||)与(&,|)的区别详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-06-25
- 本文主要介绍了C# 中取绝对值的函数。具有很好的参考价值。下面跟着小编一起来看下吧...2020-06-25
- 这篇文章主要介绍了C#绘制曲线图的方法,以完整实例形式较为详细的分析了C#进行曲线绘制的具体步骤与相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25
- 这篇文章主要介绍了c#自带缓存使用方法,包括获取数据缓存、设置数据缓存、移除指定数据缓存等方法,需要的朋友可以参考下...2020-06-25
- 下面小编就为大家带来一篇C#学习笔记- 随机函数Random()的用法详解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25
- 这篇文章主要介绍了C#中list用法,结合实例形式分析了C#中list排序、运算、转换等常见操作技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25