[C#.NET 拾遗补漏]09:数据标注与数据校验

2023-01-17 CASP.NET.NETASP#MVC

数据标注(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 类的方法内,岂不是简洁一些?

上一篇:[C#.NET 拾遗补漏]10:理解 volatile 关键字(去除 Release 版本反向优化)

下一篇:HUE 设置hive默认参数