MvvmValidation 使用教程

1. 项目介绍

MvvmValidation 是一个轻量级的库，旨在帮助开发者在 XAML MVVM 应用程序中实现验证功能时减少样板代码。该库允许开发者：

• 在一个地方定义并维护所有的验证规则。
• 减少为每个验证目标（属性）维护错误列表的样板代码。
• 验证目标并获取验证结果，而无需担心需要检查哪些规则。
• 轻松实现 INotifyDataErrorInfo 接口，以便与 XAML 绑定引擎集成，在视图中显示验证错误。

2. 项目快速启动

安装

首先，通过 NuGet 安装 MvvmValidation 包：

dotnet add package MvvmValidation --version 3.1.2

创建验证实例

在你的 ViewModel 中创建一个 ValidationHelper 实例：

public class ViewModelBase
{
    public ViewModelBase()
    {
        Validator = new ValidationHelper();
    }

    protected ValidationHelper Validator { get; private set; }
}

添加验证规则

添加一个简单的验证规则：

Validator.AddRule(nameof(FirstName), () => RuleResult.Assert(!string.IsNullOrEmpty(FirstName), "First Name is required"));

或者使用 AddRequiredRule 方法：

Validator.AddRequiredRule(() => FirstName, "First Name is required");

执行验证

验证所有规则：

ValidationResult validationResult = Validator.ValidateAll();

验证特定目标：

ValidationResult validationResult = Validator.Validate(nameof(FirstName));

3. 应用案例和最佳实践

实现 INotifyDataErrorInfo 接口

MvvmValidation 提供了 NotifyDataErrorInfoAdapter 类，使得在 ViewModel 中实现 INotifyDataErrorInfo 接口变得非常简单：

public class ValidatableViewModelBase : INotifyDataErrorInfo
{
    protected ValidationHelper Validator { get; private set; }
    private NotifyDataErrorInfoAdapter NotifyDataErrorInfoAdapter { get; set; }

    public ValidatableViewModelBase()
    {
        Validator = new ValidationHelper();
        NotifyDataErrorInfoAdapter = new NotifyDataErrorInfoAdapter(Validator);
    }

    public IEnumerable GetErrors(string propertyName)
    {
        return NotifyDataErrorInfoAdapter.GetErrors(propertyName);
    }

    public bool HasErrors
    {
        get { return NotifyDataErrorInfoAdapter.HasErrors; }
    }

    public event EventHandler<DataErrorsChangedEventArgs> ErrorsChanged
    {
        add { NotifyDataErrorInfoAdapter.ErrorsChanged += value; }
        remove { NotifyDataErrorInfoAdapter.ErrorsChanged -= value; }
    }
}

异步验证规则

对于需要长时间或不能同步执行的验证（例如调用 Web 服务），可以使用异步验证规则：

Validator.AddAsyncRule(nameof(UserName), async () =>
{
    var isAvailable = await UserRegistrationService.IsUserNameAvailable(UserName).ToTask();
    return RuleResult.Assert(isAvailable, string.Format("User Name {0} is taken, Please choose a different one", UserName));
});

4. 典型生态项目

MvvmValidation 主要用于 XAML 平台上的 MVVM 应用程序，特别是以下项目：

• WPF (Windows Presentation Foundation)
• UWP (Universal Windows Platform)
• Xamarin.Forms

这些项目都支持 XAML 绑定和 MVVM 模式，MvvmValidation 可以很好地集成到这些项目中，提供强大的验证功能。

---

通过以上步骤，你可以快速上手并使用 MvvmValidation 库来简化你的 MVVM 应用程序中的验证逻辑。