WPF CommunityToolkit.MVVM库的简单使用

CommunityToolkit.MVVM 是 .NET 社区工具包中的一部分，它为实现 MVVM（Model-View-ViewModel）模式提供了一系列实用的特性和工具，能帮助开发者更高效地构建 WPF、UWP、MAUI 等应用程序。以下是关于它的详细使用介绍：

1. 安装

你可以通过 NuGet 包管理器来安装 CommunityToolkit.MVVM。在 Visual Studio 中，右键点击项目，选择“管理 NuGet 包”，然后搜索“CommunityToolkit.MVVM”并安装。也可以使用以下命令在包管理器控制台安装：

Install-Package CommunityToolkit.MVVM

2. 主要特性及使用方法

2.1 ObservableObject 和属性通知

ObservableObject 是一个基类，它实现了 INotifyPropertyChanged 接口，用于在属性值发生变化时通知视图进行更新。

using CommunityToolkit.Mvvm.ComponentModel;

public class MyViewModel : ObservableObject
{
    
    
    private string _name;
    public string Name
    {
    
    
        get => _name;
        set => SetProperty(ref _name, value);
    }
}

在上述代码中，SetProperty 方法会自动处理属性值的更新，并触发 PropertyChanged 事件，通知视图更新。

2.2 RelayCommand

RelayCommand 用于实现命令模式，将视图中的操作（如按钮点击）绑定到 ViewModel 中的方法。

using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;

public class MyViewModel : ObservableObject
{
    
    
    public RelayCommand MyCommand {
    
     get; }

    public MyViewModel()
    {
    
    
        MyCommand = new RelayCommand(ExecuteMyCommand);
    }

    private void ExecuteMyCommand()
    {
    
    
        // 执行命令的逻辑
    }
}

在视图中，可以将按钮的 Command 属性绑定到 MyCommand：

<Button Content="Click Me" Command="{Binding MyCommand}" />

2.3 异步命令

AsyncRelayCommand 用于处理异步操作，例如网络请求或文件读写。

using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
using System.Threading.Tasks;

public class MyViewModel : ObservableObject
{
    
    
    public AsyncRelayCommand MyAsyncCommand {
    
     get; }

    public MyViewModel()
    {
    
    
        MyAsyncCommand = new AsyncRelayCommand(ExecuteMyAsyncCommand);
    }

    private async Task ExecuteMyAsyncCommand()
    {
    
    
        // 执行异步操作
        await Task.Delay(1000);
    }
}

2.4 自动生成属性

使用 ObservableProperty 特性可以自动生成属性和属性通知代码，减少样板代码。

using CommunityToolkit.Mvvm.ComponentModel;

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

上述代码会自动生成 Description 属性以及相应的 SetProperty 调用和 PropertyChanged 事件触发。

2.5 消息传递

CommunityToolkit.MVVM 提供了 IRecipient<TMessage> 接口和 IMessenger 服务，用于在不同的 ViewModel 之间进行消息传递。

using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Messaging;
using CommunityToolkit.Mvvm.Messaging.Messages;

// 定义消息类
public class MyMessage : ValueChangedMessage<string>
{
    
    
    public MyMessage(string value) : base(value)
    {
    
    
    }
}

// 发送消息的 ViewModel
public class SenderViewModel : ObservableObject
{
    
    
    private readonly IMessenger _messenger;

    public SenderViewModel(IMessenger messenger)
    {
    
    
        _messenger = messenger;
    }

    public void SendMessage()
    {
    
    
        _messenger.Send(new MyMessage("Hello, World!"));
    }
}

// 接收消息的 ViewModel
public class ReceiverViewModel : ObservableObject, IRecipient<MyMessage>
{
    
    
    private readonly IMessenger _messenger;

    public ReceiverViewModel(IMessenger messenger)
    {
    
    
        _messenger = messenger;
        _messenger.Register(this);
    }

    public void Receive(MyMessage message)
    {
    
    
        // 处理接收到的消息
    }
}

3. 总结

CommunityToolkit.MVVM 提供了丰富的工具和特性，帮助开发者更轻松地实现 MVVM 模式。通过使用 ObservableObject 实现属性通知、RelayCommand 和 AsyncRelayCommand 处理命令、ObservableProperty 自动生成属性代码以及消息传递机制，能有效减少样板代码，提高开发效率和代码的可维护性。