火影推荐程序连载50-数据标注与数据校验

数据标注(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);

创建好这个上下文对象就可以对数据进行多种方式的校验了,比如校验对象的所有属性:

www.dongdongrji.cn maven.apache.org/xsd/maven-4.0.0.xsd">
  
  <artifactId>dubbo<www.xxinyoupt.cn /artifactId>
  
  <groupId>nacos</groupId>
  
  <version>0.0.1-SNAPSHOT<www.lanboyulezc.cn /version>
  
  <priority value=www.lanboylgw.com/"info"www.chuanchenpt.cn/ />
  
  <appender-ref ref=www.yixingxzc.cn"stdout"www.lanboylgw.com />
  
  <appender-ref ref="fileout"www.baichuangyule.cn /
  
  换掉encoder的实现类或者换掉layout的实现类就可以了
  
  <?xml version= www.lanboyulezc.cn www.jiuerylzc.cn"1.0"www.zhuyngyule.cn encoding=www.bhylzc.cn"UTF-8"?>
  
  <configuration debug=www.shicaiyulezc.cn"false"www.huachenguoj.com >
  
  <property name=www.51huayuzc.cn"APP_NAME" value="logtest"/>
  
  <property name=www.xinhuihpw.com "LOG_HOME" value="./logs" www.wanyaylezc.cn//>
  
  <appender name="STDOUT" class="www".yachengyl.cn"ch.qos.logback.core.ConsoleAppender">
  
  <!--替换成AspectLogbackEncoder-->
  
  <encoder class="www.shengrenyp.cn "com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder"www.51huayuzc.cn>
  
  <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{www.pinguo2yl.com} - %msg%n</pattern>
  
  <appender www.baishenjzc.cn name="FILE" www.baihua178.cn class="ch.qos.logback.core.rolling.RollingFileAppender">
  
  <File>${LOG_HOME}/${APP_www.jinliyld.cn NAME}.log<www.baihua178.cn /File>
  
  <rollingPolicy class="www.jintianxuesha.com"ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"www.wanyaylezc.cn/>
  
  <FileNamePattern>www.yachengyl.cn ${LOG_HOME}/${APP_NAME}.log.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
  
  <MaxHistory>30<www.51huayuzc.cn /MaxHistory>
  
  <maxFileSize>1000MB<www.jinliyld.cn /maxFileSize>

也可以只校验对象的指定属性:

ValidationContext vc = new ValidationContext(objectToValidate);
ICollection<ValidationResult> results = new List<ValidationResult>();
bool isValid = Validator.TryValidatePropery(objectToValidate.PropertyToValidate, vc, results, true);

返回值 isValid 表示是否所有数据都验证通过,验证失败的信息会放到 results 结果集。

看到这,我觉得手动执行校验还是有点麻烦,创建 ValidationContext 对象这一步如果也封装在 Validator 类的方法内,岂不是简洁一些?

©️2020 CSDN 皮肤主题: 编程工作室 设计师:CSDN官方博客 返回首页