CommunityToolkit.Mvvm 中 ValidationAttribute 的 MemberNames 问题解析

问题背景

在使用 CommunityToolkit.Mvvm 进行数据验证时，开发者可能会遇到一个常见问题：当自定义 ValidationAttribute 进行集合验证时，GetErrors() 方法返回的 ValidationResult 中的 MemberNames 属性为空。这会导致在获取错误信息时无法正确关联到具体的属性名称。

问题现象

在实现一个集合验证的场景中，开发者创建了一个继承自 ObservableValidator 的 ViewModel，其中包含一个 ObservableCollection 属性，并为其添加了自定义的验证特性 RequiredCheckableItemValidationAttribute。该特性用于验证集合中至少有一个元素被选中。

当调用 ValidateProperty 方法验证该集合属性后，通过 GetErrors() 方法获取验证结果时，发现每个 ValidationResult 的 MemberNames 集合为空，这使得无法正确地将错误信息与属性名称关联起来。

问题原因

经过分析，问题的根源在于 ValidationAttribute 的实现方式。在默认情况下，当创建 ValidationResult 时，如果没有显式指定 MemberNames，那么结果中的 MemberNames 集合将为空。

在 CommunityToolkit.Mvvm 的验证机制中，MemberNames 用于标识哪个属性触发了验证错误。当这个集合为空时，后续的错误信息处理（如分组、显示等）就无法正确关联到具体的属性上。

解决方案

要解决这个问题，需要在自定义 ValidationAttribute 中创建 ValidationResult 时，显式地指定 MemberNames。具体做法是：

1. 在 ValidationAttribute 的 IsValid 方法中，使用 validationContext.MemberName 获取当前验证的成员名称
2. 在创建 ValidationResult 时，将这个成员名称传入 MemberNames 集合

以下是修正后的代码示例：

protected override ValidationResult? IsValid(object? value, ValidationContext validationContext)
{
    if (value is IEnumerable<ICheckable> items)
    {
        if (items.Any(x => x.IsChecked))
        {
            return ValidationResult.Success;
        }

        // 显式指定MemberNames
        return new ValidationResult(ErrorMessage, [validationContext.MemberName!]);
    }

    return null;
}

深入理解

ValidationContext 的作用

ValidationContext 提供了验证执行的上下文信息，其中包含几个重要属性：

• MemberName：当前正在验证的成员名称
• ObjectInstance：包含要验证的成员的对象实例
• DisplayName：成员的显示名称（如果有）

在自定义验证逻辑中，合理利用这些上下文信息可以创建更精确的验证结果。

MemberNames 的设计意义

MemberNames 集合的设计允许一个验证错误关联到多个属性名称。这种设计在以下场景中特别有用：

1. 跨属性验证：当一个验证规则涉及多个属性时
2. 复合验证：当多个属性共同决定一个验证结果时
3. 级联验证：当一个属性的变化会影响其他属性的有效性时

最佳实践

1. 始终指定 MemberNames：在创建 ValidationResult 时，总是显式指定 MemberNames，即使只有一个相关属性
2. 使用 validationContext：充分利用 ValidationContext 提供的信息来构建精确的验证结果
3. 考虑多属性场景：在设计验证逻辑时，考虑是否需要支持多属性关联验证
4. 错误信息处理：在处理验证错误时，做好 MemberNames 为空的防御性编程

总结

在 CommunityToolkit.Mvvm 中使用自定义 ValidationAttribute 时，正确处理 MemberNames 是确保验证系统正常工作的关键。通过显式指定 MemberNames，可以确保验证错误能够正确关联到对应的属性，从而构建更健壮的数据验证机制。这一实践不仅适用于集合验证，也适用于所有自定义验证场景。