总所周知,WPF提供了多种数据校验的方式,但是在实际应用中并不是那么得心应手,每种验证都有自己的缺点。ValidationRule 验证比较繁琐,Exception 验证需要书写的逻辑比较多,IDataErrorInfo 验证初始化的时候即进行验证,然后如果是需要确定的界面,确定的时候还是需要一次校验。以前的时候都是放弃了校验,依旧采取确认的时候判断每个需要校验的属性,然后提示。最近在新做一个项目的时候,研究了一下校验方式及网上的一些实现方式,在此提出一种实现,供大家参考。
代码如下:
/// <summary>
/// 带有数据校验功能的通知基类
/// </summary>
public class ViewModelValidationBase : ViewModelBase, IDataErrorInfo
{
/// <summary>
/// 需要校验的属性集合
/// </summary>
private List<string> validationKeys = new List<string>();
/// <summary>
/// 错误信息字典
/// </summary>
private Dictionary<string, string> errorDic = new Dictionary<string, string>();
/// <summary>
/// 是否开始校验,以此控制IDataErrorInfo接口校验的时候界面刚初始化即开始校验
/// </summary>
public bool IsBeginValidation { get; set; }
public string this[string columnName]
{
get
{
if (!IsBeginValidation)
{
return string.Empty;
}
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)
{
string errorMessage = string.Join(Environment.NewLine, res.Select(r => r.ErrorMessage).ToArray());
AddErrorDic(columnName, errorMessage);
return errorMessage;
}
RemoveErrorDic(columnName);
return string.Empty;
}
}
public string Error => string.Join(Environment.NewLine, errorDic.Values.ToArray());
/// <summary>
/// 添加进行校验的属性集合
/// </summary>
/// <param name="keys"></param>
protected virtual void ValidationKey(string[] keys)
{
if (keys == null)
{
return;
}
foreach (var item in keys)
{
validationKeys.Add(item);
}
}
/// <summary>
/// 强制进行以此校验
/// </summary>
protected void Validation()
{
if (validationKeys != null)
{
foreach (var item in validationKeys)
{
RaisePropertyChanged(item);
}
}
}
private void AddErrorDic(string key, string value)
{
if (!errorDic.Keys.Contains(key))
{
errorDic.Add(key, value);
}
}
private void RemoveErrorDic(string key)
{
errorDic.Remove(key);
}
}
其中ViewModelBase类我使用的是MVVMLight中的通知基类。
使用的时候继承该类,然后使用属性IsBeginValidation控制校验的时机,方法 ValidationKey(string[] keys) 添加需要校验的属性,方法Validation()可以触发校验,属性Error显示校验信息,为空则校验正确,不为空校验错误。
校验规则是使用特性的方式,引用名称空间
using System.ComponentModel.DataAnnotations;
/// <summary>
/// 获取或设置
/// </summary>
private string name;
/// <summary>
/// 获取或设置
/// </summary>
[Required(ErrorMessage = "用户名称不能为空")]
public string Name
{
get { return name; }
set { Set<string>(ref name, value, "Name"); }
}
如果大家有什么更好的意见欢迎讨论。