引言

在现代应用程序开发中，MVVM（Model-View-ViewModel） 模式已成为构建可维护、可扩展和可测试应用程序的主流架构。微软的 CommunityToolkit.Mvvm（原名 Microsoft.Toolkit.Mvvm） 是一个轻量级且强大的库，旨在简化 MVVM 模式的实现。

在 MVVM 模式中，ObservableObject 基类是核心组件之一。它实现了 INotifyPropertyChanged 接口，用于通知视图属性的更改，从而更新 UI。本文将详细介绍 ObservableObject 基类的功能、用法，并通过 CMD（控制台应用程序）和 WinForms 下的示例，加深对其理解。

什么是 ObservableObject

ObservableObject 是一个抽象基类，位于
CommunityToolkit.Mvvm.ComponentModel 命名空间中。它实现了 INotifyPropertyChanged 接口，提供了属性更改通知的基础设施。

主要特性

• 简化属性通知：通过内置的方法，减少手动编写重复的通知代码。
• Source Generator 支持：利用 C# 的 Source Generator 特性，进一步减少样板代码。
• 与 MVVM 模式完美结合：在 ViewModel 中继承 ObservableObject，即可轻松实现数据绑定。

如何使用 ObservableObject

安装 CommunityToolkit.Mvvm

在开始之前，确保已在项目中安装了 CommunityToolkit.Mvvm 包：

Install-Package CommunityToolkit.Mvvm

基本用法

继承 ObservableObject，并使用 SetProperty 方法设置属性值：

using CommunityToolkit.Mvvm.ComponentModel;

public class MyViewModel : ObservableObject
{
    private string _name;

    public string Name
    {
        get => _name;
        set => SetProperty(ref _name, value);
    }
}

当 Name 属性被更改时，SetProperty 方法将触发 PropertyChanged 事件，通知 UI 更新。

使用 [ObservableProperty] 属性

为简化代码，可以使用 CommunityToolkit.Mvvm 提供的 [ObservableProperty] 属性：

using CommunityToolkit.Mvvm.ComponentModel;

public partial class MyViewModel : ObservableObject
{
    [ObservableProperty]
    private string name;
}

编译时，Source Generator 会自动生成对应的属性和通知代码。

在 CMD 应用程序中的示例

即使在控制台应用程序中，ObservableObject 也能用于演示属性变化的通知机制。

示例：监控属性变化

using System;
using CommunityToolkit.Mvvm.ComponentModel;

public partial class Person : ObservableObject
{
    [ObservableProperty]
    private string name;
}

public class Program
{
    public static void Main()
    {
        var person = new Person();

        person.PropertyChanged += (sender, e) =>
        {
            Console.WriteLine($"属性 {e.PropertyName} 已更改");
        };

        Console.WriteLine("请输入姓名：");
        person.Name = Console.ReadLine();
    }
}

运行结果

当用户输入姓名时，设置 Name 属性并触发 PropertyChanged 事件。

在 WinForms 应用程序中的示例

在 WinForms 中，ObservableObject 可用于构建 ViewModel，实现数据与 UI 的双向绑定。

示例：数据绑定实现

1. 创建 ViewModel

using CommunityToolkit.Mvvm.ComponentModel;

public partial class PersonViewModel : ObservableObject
{
    [ObservableProperty]
    private string name;
}

2. 设计 WinForms 界面

• 添加一个 TextBox 控件，命名为 txtName。
• 添加一个 Label 控件，命名为 lblName。

1. 绑定数据

public partial class MainForm : Form
{
    private PersonViewModel viewModel = new PersonViewModel();

    public MainForm()
    {
        InitializeComponent();

        // 绑定 TextBox 的 Text 属性到 ViewModel 的 Name 属性
        textBoxName.DataBindings.Add("Text", viewModel, "Name", false, DataSourceUpdateMode.OnPropertyChanged);

        // 绑定 Label 的 Text 属性到 ViewModel 的 Name 属性
        labelName.DataBindings.Add("Text", viewModel, "Name");
    }
}

效果

当用户在 textBoxName 中输入内容时，labelName 会实时显示当前输入的姓名。

深入了解 ObservableObject

SetProperty 方法

SetProperty 方法用于设置属性值并触发 PropertyChanged 事件。其签名为：

protected bool SetProperty(ref T field, T value, [CallerMemberName] string propertyName = null);

• field：属性对应的私有字段。
• value：要设置的值。
• propertyName：属性名称，通常由编译器自动提供。

属性更改前后的操作

可以重载 OnPropertyChanging 和 OnPropertyChanged 方法，处理属性更改前后的逻辑：

protected override void OnPropertyChanging(PropertyChangingEventArgs e)
{
    // 属性更改前的逻辑
    base.OnPropertyChanging(e);
}

protected override void OnPropertyChanged(PropertyChangedEventArgs e)
{
    // 属性更改后的逻辑
    base.OnPropertyChanged(e);
}

使用属性通知的注意事项

• 线程安全：默认情况下，ObservableObject 的属性通知不是线程安全的。如果需要跨线程更新 UI，需要使用 Dispatcher 或 SynchronizationContext。
• 性能考虑：过度使用属性通知可能影响性能，尤其是在大量数据绑定的情况下。

结论

ObservableObject 基类是 CommunityToolkit.Mvvm 提供的强大工具，简化了属性通知的实现，减少了样板代码。在 CMD 和 WinForms 应用程序中，都可以利用其特性，提高开发效率和代码可维护性。

通过本文的介绍，相信你已经对 ObservableObject 有了深入的了解，能够在实际项目中灵活运用。