【WPF】MVVM模式下的输入校验(IDataErrorInfo + DataAnnotations)

于 2024-09-10 16:53:51 发布
阅读量277 收藏
点赞数
分类专栏： C# 文章标签： wpf DataGrid 数据校验
原文链接：https://blog.csdn.net/fangxing80/article/details/8170441
版权

一、前言

Windows Presentation Foundation (WPF) 具有一个丰富数据绑定系统。除了作为通过 Model-View-ViewModel (MVVM) 模式从支持逻辑和数据对 UI 定义进行松散耦合的关键推动力之外，数据绑定系统还为业务数据验证方案提供强大而灵活的支持。WPF 中的数据绑定机制包括多个选项，可用于在创建可编辑视图时校验输入数据的有效性。

**验证机制****说明**
异常通过在某个 Binding 对象上设置 ValidatesOnExceptions 属性，如果在尝试对源对象属性设置已修改的值的过程中引发异常，则将为该 Binding 设置验证错误。
ValidationRulesBinding 类具有一个用于提供 ValidationRule 派生类实例的集合的属性。这些 ValidationRules 需要覆盖某个 Validate 方法，该方法由 Binding 在每次绑定控件中的数据发生更改时进行调用。如果 Validate 方法返回无效的 ValidationResult 对象，则将为该 Binding 设置验证错误。
IDataErrorInfo通过在绑定数据源对象上实现 IDataErrorInfo 接口并在 Binding 对象上设置 ValidatesOnDataErrors 属性，Binding 将调用从绑定数据源对象公开的 IDataErrorInfo API。如果从这些属性调用返回非 null 或非空字符串，则将为该 Binding 设置验证错误。

在使用 WPF 中的数据绑定来呈现业务数据时，通常应使用 Binding 对象在目标控件的单个属性与数据源对象属性之间提供数据管道。
若要使绑定验证有效，首先需要进行 TwoWay 数据绑定。这意味着，除了从源属性流向目标属性以进行显示的数据之外，编辑过的数据也会从目标流向源。
当 TwoWay 数据绑定中输入或修改数据时，将启动以下工作流：

  • 用户通过击键、鼠标、触摸或与各元素间的手写笔交互来输入或修改数据，从而更改元素的属性。
  • 如果需要，可将数据转换为数据源属性类型。
  • 设置源属性值。
  • 触发 Binding.SourceUpdated 附加事件。
  • 如果数据源属性上的 setter 引发异常，则异常会由 Binding 捕获，并可用于指示验证错误。
  • 如果实现了 IDataErrorInfo 接口，则会对数据源对象调用该接口的方法获得该属性的错误信息。
  • 向用户呈现验证错误指示，并触发 Validation.Error 附加事件。

本篇主要介绍MVVM模式下， IDataErrorInfo 的校验以及结合 DataAnnotation 的实现方法。比较来说，在 set 里直接 throw Exception 实现最为简单，但不适合组合校验且Model里需要编写过重的校验代码；ValidationRules 更适合在用户控件或者自定义控件场合使用。IDataErrorInfo 则是比较普遍且灵活的校验实现方式。

二、实例分析

我们先来看看 IDataErrorInfo 的实现方法： Error 属性用于指示整个对象的错误，而索引器用于指示单个属性级别的错误。
两者的工作原理相同：如果返回非 null 或非空字符串，则表示存在验证错误。否则，返回的字符串用于向用户显示错误。

Person.cs 的 Age 属性进行了校验。

public class Person : INotifyPropertyChanged, IDataErrorInfo
    {
        private string _name;
        public string Name
        {
            get { return _name; }
            set 
            {
                if (_name != value)
                {
                    _name = value;
                    RaisePropertyChanged("Name");
                }
            }
        }
 
        private int _age;
        public int Age
        {
            get { return _age; }
            set
            {
                if (_age != value)
                {
                    _age = value;
                    RaisePropertyChanged("Age");
                }
            }
        }
 
        public string Error
        {
            get { return ""; }
        }
 
        public string this[string columnName]
        {
            get 
            {
                if (columnName == "Age")
                {
                    if (_age < 18)
                    {
                        return "年龄必须在18岁以上。";
                    }
                }
                return string.Empty;
            }
        }
 
        public event PropertyChangedEventHandler PropertyChanged;
 
        internal virtual void RaisePropertyChanged(string propertyName)
        {
            if (PropertyChanged != null)
            {
                PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
            }
        }
    }

Xmal 绑定：

<TextBox Text="{Binding Age, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged, ValidatesOnExceptions=True, ValidatesOnDataErrors=True, NotifyOnValidationError=True}" Grid.Row="1" Grid.Column="1" Margin="5"/>

（注意： TextBox 默认的 UpdateSourceTrigger 是 LostFocus，如果你想内容一改变立刻进行校验那么需要修改为 PropertyChanged )
那么，在输入非法的年龄时提示出错误信息。

利用 IDataErrorInfo 的好处是它可用于轻松地处理交叉耦合属性。但也具有一个很大的弊端：
索引器的实现通常会导致较大的 switch-case 语句（对象中的每个属性名称都对应于一种情况），
必须基于字符串进行切换和匹配，并返回指示错误的字符串。而且，在对象上设置属性值之前，不会调用 IDataErrorInfo 的实现。

为了避免出现大量的 switch-case，并且将校验逻辑进行分离提高代码复用，于是 DataAnnotations 华丽登场。
改造下上面的 Person 类，加上 [Range] ValidationAttribute：（需要添加 System.ComponentModel.DataAnnotations.dll）

[Range(19, 99, ErrorMessage="年龄必须在18岁以上。")]
public int Age
{
    get { return _age; }
    set
    {
        if (_age != value)
        {
            _age = value;
            RaisePropertyChanged("Age");
        }
    }
}

修改 IDataErrorInfo 的索引器，让它通过 Validator 校验属性：

 public string this[string columnName]
 {
     get 
     {
         var vc = new ValidationContext(this, null, null);
         vc.MemberName = columnName;
         var res = new List<ValidationResult>();
         var result = Validator.TryValidateProperty(this.GetType().GetProperty(columnName).GetValue(this, null), vc, res);
         if (res.Count > 0)
         {
             return string.Join(Environment.NewLine, res.Select(r => r.ErrorMessage).ToArray());
         }
         return string.Empty;
     }
 }

用 DataAnnotions 后，Model 的更加简洁，校验也更加灵活。还可以利用 CustomerValidation 或者 自定义 ValidationAttribute 来进行校验逻辑的进一步分离，错误消息格式化。并且通过反射等技术，完全可以将 IDataErrorInfo 的实现抽成一个抽象类进行封装，编程更加便利。

(1) 自定义 ValidationAttribute
添加了一个针对上面 Person 的 Name 属性是否存在的校验：

class NameExists : ValidationAttribute
{
    public override bool IsValid(object value)
    {
        var name = value as string;
        // 这里可以到数据库等存储容器中检索
        if (name != "Felix")
        {
            return false;
        }
        return true;
    }
 
    public override string FormatErrorMessage(string name)
    {
        return "请输入存在的用户名。";
    }
}

将 NameExistsAttribute 添加到 Person.Name 属性上：

[NameExists]
public string Name
{
    get { return _name; }
    set 
    {
        if (_name != value)
        {
            _name = value;
            RaisePropertyChanged("Name");
        }
    }
}

(2) 利用 CustomerValidationAttribute
先实现一个 public static 的校验方法（必须返回 ValidationResult )

public class CustomerValidationUtils
{
    public static ValidationResult CheckName(string value)
    {
        if (value.Length < 8)
        {
            return new ValidationResult("名字长度必须大于等于8位。");
        }
        return ValidationResult.Success;
    }
}

然后在 Person 的 Name 属性上加上 CustomerValidation 特性：

[CustomValidation(typeof(CustomerValidationUtils), "CheckName")]
public string Name
{
    get { return _name; }
    set 
    {
        if (_name != value)
        {
            _name = value;
            RaisePropertyChanged("Name");
        }
    }
}

在实际开发中，我们还经常使用 EF 等 ORM 来做数据访问层，Model 通常会由这个中间件自动生成（利用T4等代码生成工具）。而他们通常是 POCO 数据类型，这时候如何能把属性的校验特性加入其中呢。这时候， TypeDescriptor.AddProviderTransparent + AssociatedMetadataTypeTypeDescriptionProvider 可以派上用场，它可以实现在另一个类中增加对应校验特性来增强对原类型的元数据描述。按照这种思路，将上面的 Person 类分离成两个文件：第一个分离类，可以想象是中间件自动生成的 Model 类。第二个分离类中实现 IDataErrorInfo，并定义一个Metadata 类来增加校验特性。（EF CodeFirst 也可以使用这一思路）

Person.cs （原生的 Person 类，没有校验特性）

public partial class Person : INotifyPropertyChanged
{
    private string _name;
 
    public string Name
    {
        get { return _name; }
        set 
        {
            if (_name != value)
            {
                _name = value;
                RaisePropertyChanged("Name");
            }
        }
    }
 
    private int _age;
 
   
    public int Age
    {
        get { return _age; }
        set
        {
            if (_age != value)
            {
                _age = value;
                RaisePropertyChanged("Age");
            }
        }
    }
 
    public event PropertyChangedEventHandler PropertyChanged;
 
    internal virtual void RaisePropertyChanged(string propertyName)
    {
        if (PropertyChanged != null)
        {
            PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
        }
    }
}

PersonMetadata.cs （分离的 Person 类中，实现 IDataErrorInfo 接口，在其内部类中增加了校验特性）

public partial class Person: IDataErrorInfo
{
    class PersonMetadata
    {
        [Required]
        [NameExists]
        [CustomValidation(typeof(CustomerValidationUtils), "CheckName")]
        public string Name { get; set; }
 
        [Range(19, 99, ErrorMessage = "年龄必须在18岁以上。")]
        public string Age { get; set; }
    }
 
    public string Error
    {
        get { throw new NotImplementedException(); }
    }
 
    public string this[string columnName]
    {
        get
        {
            return this.ValidateProperty<PersonMetadata>(columnName);
        }
    }
}

ValidateProperty 方法，是一个基于 object 类型的扩展方法。通过泛型指定增强信息的类型。

 public static class ValidationExtension
 {
     public static string ValidateProperty
  
  
   
   (this object obj, string propertyName)
     {
         if (string.IsNullOrEmpty(propertyName))
             return string.Empty;
 
         var targetType = obj.GetType();
         //你也可以利用 MetadataType 在分离类上声明
         //var targetMetadataAttr = targetType.GetCustomAttributes(false)
         //    .FirstOrDefault(a => a.GetType() == typeof(MetadataTypeAttribute)) as MetadataTypeAttribute;
         //if (targetMetadataAttr != null && targetType != targetMetadataAttr.MetadataClassType)
         //{
         //    TypeDescriptor.AddProviderTransparent(
         //           new AssociatedMetadataTypeTypeDescriptionProvider(targetType, targetMetadataAttr.MetadataClassType), targetType);
         //}
         if (targetType != typeof(MetadataType))
         {
             TypeDescriptor.AddProviderTransparent(
                    new AssociatedMetadataTypeTypeDescriptionProvider(targetType, typeof(MetadataType)), targetType);
         }
 
         var propertyValue = targetType.GetProperty(propertyName).GetValue(obj, null);
         var validationContext = new ValidationContext(obj, null, null);
         validationContext.MemberName = propertyName;
         var validationResults = new List
   
   
    
    ();
 
         Validator.TryValidateProperty(propertyValue, validationContext, validationResults);
 
         if (validationResults.Count > 0)
         {
             return validationResults.First().ErrorMessage;
         }
         return string.Empty;
     }
}

利用这一思路，可以很容易的实现各种 POCO Model 类型的校验逻辑分离，这对于开发分层架构的应用框架时非常有用。

码学弟
关注
专栏目录
【愚公系列】2023年11月 WPF+上位机+工业互联 067-MVVM模式中的数据校验
时光隧道
09-29 4万+
MVVM模式中的数据校验是通过绑定数据模型和视图模型实现的。数据模型通常包含了实际的数据和数据校验规则，视图模型则负责将数据模型中的数据和规则转换成适合视图的数据和规则，并且将视图的输入绑定回数据模型，进行数据的更新和校验。MVVM模式中的数据校验通常包含以下几个步骤：定义数据模型和视图模型。数据模型中包含了实际数据和校验规则，视图模型中负责将数据模型中的数据和规则转换成适合视图的数据和规则。视图中绑定视图模型，并根据视图模型中的规则，在视图中显示出相应的校验信息。
WPF MVVM从入门到精通8：数据验证
LJianDong的博客
12-18 244
WPF MVVM从入门到精通8：数据验证 到目前为止，登录窗口的基本功能似乎都完成了。但我们知道，很多时候用户名的格式是有要求的，例如是只有字母数字下划线，或者字数有限制。这要求我们在登录之前，验证输入内容的正确性。在这一节，我们需要验证用户名和密码的正确性，如果上...
WPF数据验证（6）—— IDataErrorInfo + DataAnnotations
iHuoBaby
02-07 2052
前面介绍过居于 IDataErrorInfo 接口的数据验证。利用 IDataErrorInfo 的好处是它可用于轻松地处理交叉耦合属性。但也具有一个很大的弊端：索引器的实现通常会导致较大的 switch-case 语句（对象中的每个属性名称都对应于一种情况），必须基于字符串进行切换和匹配，并返回指示错误的字符串。而且，在对象上设置属性值之前，不会调用 IDataErrorInfo 的实现。
WPF使用IDataErrorInfo进行数据校验
01-10
WPF使用IDataErrorInfo进行数据校验
WPF MVVM 验证
weixin_33935505的博客
04-27 238
WPF MVVM（Caliburn.Micro） 数据验证 书接前文 前文中仅是WPF验证中的一种，我们暂且称之为View端的验证（因为其验证规是写在Xaml文件中的）。 还有一种我们称之为Model端验证，Model通过继承IDataErrorInfo接口来实现，这个还没研究透，后面补上。 WPF MVVM Model端验证-待续 今天的主要内容是MVVM下的数据验证，主要使用View端验证，需...
WPF 数据库增删改查
dxm809的博客
03-29 3699
&lt;Window x:Class="DataBindingExam.MainWindow"        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"        Title="Mai...
MVVM表单验证
yishengqianan的博客
05-29 167
表单验证是MVVM体系中的重要一块。而绑定除了推动 Model-View-ViewModel (MVVM) 模式松散耦 合 逻辑、数据 和 UI定义 的关系之外，还为业务数据验证方案提供强大而灵活的支持。 WPF 中的数据绑定机制包括多个选项，可用于在创建可编辑视图时校验输入数据的有效性。常见的表单验证机制有如下几种 Exception 验证:通过在某个 Binding 对象上设置 ValidatesOnExceptions 属性，如果源对象属性设置已修改的值的过程中引发异常，则抛出错误并为该 Bindin
WPF MVVM 开源框架，包含数据验证，很不错的
03-27
一个开源的清爽MVVM小框架，需要的赶紧，很不错的，适合一些不是非常大的项目。简单，易用！
WPF使用IDataErrorInfo进行数据校验-附件资源
03-05
WPF使用IDataErrorInfo进行数据校验-附件资源
wpf窗口输入验证
06-06
WPF TextBox ,ComboBox等 验证
WPF使用IDataErrorInfo接口进行数据校验 - 简书
weixin_30599769的博客
04-10 251
WPF使用IDataErrorInfo接口进行数据校验 - 简书 原文:WPF使用IDataErrorInfo接口进行数据校验 - 简书 class ValidationBindableBase : BindableBase, IDataErrorInfo { public string this[string...
WPF mvvm 验证，耗时两天的解决方案
码农01号的博客
09-27 348
常用类 类名 介绍 ValidationRule 所有自定义验证规则的基类。提供了让用户定义验证规则的入口。 ExceptionValidation 表示一个规则，该规则检查在绑定源属性更新过程中引发的异常。它是一个内置的规则，它检查在绑定源属性更新过程中引发的异常。 ValidationResult 数据验证结果的表现方式。ValidationRule对象的Validate方法执行完毕后通过ValidationResult来表示验证的结果。这里包含了错误信息—ErrorConten
wpf IDataErrorInfo 验证
最新发布
08-13 423
然后，在XAML中，你需要为绑定到该模型的UI元素（如TextBox）设置一些样式和触发器，以便在验证失败时显示错误信息。集合本身并不直接支持数据绑定到UI元素（如TextBlock的Text属性）。接口来显示错误信息，并通过样式（Style）和触发器（Trigger）来在UI上反映这些错误。（通常用于整个对象的错误，但在这个例子中我们可能不会用到它）和。我可以给你一个简单的例子来说明如何在WPF中使用。附加属性来触发样式更改或显示错误模板。（用于获取指定属性的错误信息）。首先，你需要一个实现了。
WPF绑定(Binding)下的数据验证IDataErrorInfo
03-07 401
从上面看出，利用索引器和属性名称可以判断是否为某些特性的值，但是这样写仍然太过麻烦，如果一个类中有大量的属性，要为每个属性进行判断，这样会有大量的if语句，可读性和可维护性都不太好。上面的这种写法可以简化验证所需要的代码，而且有很强的可读性和可维护性，如果直接把自定义的特性直接加到类上，使得该类中所有的属性都应用验证规则可以修改苏索引器，在上面所写的代码中加上。既然在索引器中我们已经有了属性名称，我们可以利用反射来简化上面的步骤。建一个继承自IDataErrorInfo的类。在重写索引器中的get方法。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值