c# 数据标注与数据校验

 更新时间:2020年10月09日 11:19:54   作者:精致码农 • 王亮  
这篇文章主要介绍了c# 数据标注与数据校验的相关资料,帮助大家更好的理解和学习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# 内置了很多常用数据校验特性类,比如最常用的 RequiredAttributeStringLengthAttributeRangeAttribute 等。

手动执行数据校验

大多数时候,数据校验都是由框架(如 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#如何使用UDP进行聊天通信

    c#如何使用UDP进行聊天通信

    这篇文章主要介绍了c#如何使用UDP进行聊天通信问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • 详解C#之委托

    详解C#之委托

    这篇文章主要介绍了C#委托的含义以及用法,文中代码非常详细,帮助大家更好的理解和学习
    2020-06-06
  • Visual Studio连接unity编辑器的实现步骤

    Visual Studio连接unity编辑器的实现步骤

    unity编辑器中打开C#脚本的时候发现Visual Studio没有连接unity编辑器,本文主要介绍了Visual Studio连接unity编辑器的实现步骤,感兴趣的可以了解一下
    2023-11-11
  • WPF弹出右键菜单时判断鼠标是否选中该项

    WPF弹出右键菜单时判断鼠标是否选中该项

    这篇文章介绍了WPF弹出右键菜单时判断鼠标是否选中该项的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • 基于WPF实现面包屑控件的示例代码

    基于WPF实现面包屑控件的示例代码

    这篇文章主要为大家详细介绍了如何基于WPF实现简单的面包屑控件,文中的示例代码讲解详细,对我们学习或工作有一定帮助,感兴趣的小伙伴可以了解一下
    2023-05-05
  • C#中实现PriorityQueue优先级队列的代码

    C#中实现PriorityQueue优先级队列的代码

    这篇文章主要介绍了C#中PriorityQueue优先级队列的实现,构造初始化这部分主要介绍关键的字段和方法,比较器的初始化以及堆的初始化,需要的朋友可以参考下
    2021-12-12
  • 关于C#10 新特性 Lambda 优化

    关于C#10 新特性 Lambda 优化

    这篇文章主要介绍了C# 10 新特性 Lambda 优化,C# 10 对于 Lambda 做了很多的优化,我们可以在 C# 中更加方便地使用委托和 Lambda 了,下面就来看一些示例,需要的朋友也可以参考一下
    2021-11-11
  • C#异常处理详解

    C#异常处理详解

    这篇文章介绍了C#异常处理,有需要的朋友可以参考一下
    2013-10-10
  • C# 设置系统日期格式的方法

    C# 设置系统日期格式的方法

    公司电脑各式各样的都有,里面的设置也有很多不统一的,我们做软件一般会从系统中获取一些数据,比如日期时间,环境变量的路径参数,可以用批处理文件达到我们所想要的目的,也可以用C#代码
    2013-03-03
  • 通过 C#/VB.NET 代码将 Excel 工作表拆分为单独的文件

    通过 C#/VB.NET 代码将 Excel 工作表拆分为单独的文件

    这篇文章主要介绍了通过C#/VB.NET代码将Excel工作表拆分为单独的文件,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-09-09

最新评论