CommunityToolkit.Mvvm 中 ObservableProperty 与数据验证的配合使用

理解 ObservableProperty 的基础功能

CommunityToolkit.Mvvm 是一个强大的 MVVM 工具库，其中的 [ObservableProperty] 特性是它的核心功能之一。这个特性通过源生成器自动为属性生成完整的通知实现，包括 INotifyPropertyChanged 和 INotifyPropertyChanging 接口的支持。

当我们在属性上简单地标记 [ObservableProperty] 时，生成的代码会包含属性变更通知的基本机制，但不包含任何数据验证逻辑。这是设计上的有意为之，因为数据验证是一个可选的、独立的功能层。

数据验证的需求场景

在实际开发中，我们经常需要对属性值进行验证。例如：

• 检查必填字段是否为空
• 验证字符串格式是否符合正则表达式
• 确保数值在有效范围内

这些验证需求通常通过数据注解(DataAnnotations)来实现，如 [Required] 和 [RegularExpression] 等特性。

完整的验证解决方案

要使 ObservableProperty 支持数据验证，需要三个关键组件的协同工作：

1. 数据注解特性：定义验证规则
2. [NotifyDataErrorInfo] 特性：启用验证基础设施
3. ObservableValidator 基类：提供验证实现

正确用法示例

[ObservableProperty]
[NotifyDataErrorInfo]
[Required]
[RegularExpression(@"\S+")]
public partial string MatchText { get; set; } = "";

这种组合会产生完整的验证支持代码，包括：

• 属性变更通知
• 自动验证触发
• 错误状态管理

技术实现原理

当添加 [NotifyDataErrorInfo] 特性后，生成的代码会包含对 ValidateProperty 方法的调用。这个方法来自 ObservableValidator 基类，它会：

1. 检查属性上的所有数据注解
2. 执行相应的验证逻辑
3. 维护错误状态集合
4. 触发错误状态变更通知

常见误区与最佳实践

开发者常见的误区是只添加数据注解而忘记 [NotifyDataErrorInfo] 特性。要记住：

• 数据注解只定义规则，不提供执行机制
• [NotifyDataErrorInfo] 是连接规则和执行的桥梁
• 视图模型必须继承自 ObservableValidator

最佳实践是：

1. 明确区分纯通知属性和需要验证的属性
2. 为验证属性完整配置所有必需组件
3. 考虑将验证规则集中管理以提高可维护性

总结

CommunityToolkit.Mvvm 通过清晰的职责分离提供了灵活而强大的属性通知和验证系统。理解 [ObservableProperty]、[NotifyDataErrorInfo] 和数据注解之间的关系，可以帮助开发者构建更加健壮和可维护的 MVVM 应用程序。这种设计既保持了核心功能的简洁性，又通过可选扩展提供了高级功能，体现了良好的框架设计哲学。