WPF MVVM Community Toolkit. Mvvm 社区框架

已于 2025-05-21 15:18:30 修改
阅读量1.1k 收藏 12
点赞数 30
文章标签： wpf MVVM
于 2025-05-21 15:10:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_48990772/article/details/148116900
版权

Community Toolkit. Mvvm 社区框架

微软官方文档

主要内容：CommunityToolkit.Mvvm 框架

  1. 概念，安装，使用（重要API：ObservableObject，RelayCommand）
  2. 源生成器（[ObservableProperty]，[RelayCommand]，[INotifyPropertyChanged]）
  3. 命令详解（异步命令：AsyncRelayCommand 和 AsyncRelayCommand）
  4. 依赖注入（IServiceProvider，ServiceCollection）
  5. 信使（IMessenger，WeakReferenceMessenger、StrongReferenceMessenger 等）

ViewModel 支持通知：继承 ObservableObject

属性支持通知：SetProperty(ref name, value) 或 OnPropertyChanged( )

创建命令：直接使用类型 RelayCommand

核心功能

Community Toolkit. Mvvm 内置源生成器可以使用特性生成代码

1. [INotifyPropertyChanged] 和 [ObservableProperty]

ObservableObject 是 ViewModel 的基类，支持 INotifyPropertyChanged和 INotifyPropertyChanged

要 .Net 8.0 版本以后才可以使用源生成器这种语法

 

[INotifyPropertyChanged] //相当于 类继承 ：ObservableObject
public partial class PersonViewModel  //🔴！需要 partial 部分类
{
    [ObservableProperty] //[ObservableProperty] 会生成一个: 基于 name的字段的属性Name
    private string name; //🔴调用时，要调：Name 大写
//  相当于: public string Name
//         {
//             get => name;
//             set => SetProperty(ref name, value);
//         }

    [ObservableProperty]
    private int age;
}

这段代码会自动生成 Name 和 Age 的属性，同时自动实现 INotifyPropertyChanged 的通知。

  1. SetProperty(ref name, value)：支持通知

    • SetProperty(ref name, value) //通知的方法，相当于: 

//   ⬇⬇⬇ 相当于

if (_name != value)
{
  _name = value;
  OnPropertyChanged(); // 或 OnPropertyChanged(nameof(Name));
}

2. RelayCommand 命令

你可以轻松创建命令而不需要手动实现 ICommand 接口。

using CommunityToolkit.Mvvm.Input;

[INotifyPropertyChanged]
public partial class PersonViewModel //🔴需要 partial 部分类
{
    1️⃣//同步命令
    [RelayCommand] //在编译时会自动在方法后面加：Command
    private void SayHello() //🔴调用时要调用：SayHelloCommand
    {
        MessageBox.Show("Hello!");
    }
  
    2️⃣//异步命令
    [RelayCommand]
    private async Task GreetUserAsync() //🔴编译时会变成：GreetUserCommand
    {
        await Task.Delay(3000);
        MessageBox.Show($"Hello 源生器！");
    }

  
    3️⃣//带 CanExecute 命令
    [RelayCommand(CanExecute = nameof(CanGreetUser))] //加入 CanExecute 判断执行
    private void SayHello() 
    {
        MessageBox.Show("Hello!");
    }
    private bool CanGreetUser(User? user)
    {
      return user is not null;
    }
  
}

使用 [RelayCommand] 会自动生成一个 SayHelloCommand 属性，供 XAML 使用。

异步方法会 去掉 Async ，添加 Command ，变成 SayHelloCommand

3. ObservableValidator 验证

如果你需要验证输入数据（比如表单），可以继承 ObservableValidator：

public partial class FormViewModel : ObservableValidator
{
    [ObservableProperty]
    [Required]
    [MinLength(3)]
    private string name;
}

XAML 示例绑定命令

<Button Content="Say Hello" Command="{Binding SayHelloCommand}" />
<TextBox Text="{Binding Name, UpdateSourceTrigger=PropertyChanged}" />

信使

“信使”，在 MVVM 架构中指的是 Messenger（消息通信机制），用于实现 ViewModel 之间的解耦通信。

MVVM 工具包提供两种现用的实现：

  1. WeakReferenceMessenger
    • 在内部使用弱引用，为收件人提供自动内存管理
  2. StrongReferenceMessenger
    • 使用强引用，并要求开发人员在不再需要收件人时手动取消订阅收件人

使用场景

  • 不同 ViewModel 之间发送和接收消息
  • 让 ViewModel 通知其他模块某件事发生了
  • 解耦：不通过事件或引用直接交互

示例：发送与接收消息

1. 创建消息类（推荐继承 ValueChangedMessage<T>）
public class NameChangedMessage : ValueChangedMessage<string>
{
  public NameChangedMessage(string value) : base(value) 
  { 
    
  }
}
2. 接收消息的 ViewModel
public class ReceiverViewModel : ObservableRecipient
{
    public ReceiverViewModel()
    {
        // 必须开启 IsActive 才能自动注册接收器
        IsActive = true;

        1️⃣ Messenger.Register<ReceiverViewModel, NameChangedMessage>(this, (r, m) =>
        { 
            // 处理消息
            //在这里处理消息，r为接收方，m为发送方
            //输入消息。使用传递的接收者作为输入使得
            // lambda表达式不会捕获“this”，从而提高性能。
            Console.WriteLine($"接收到新名字：{m.Value}");
          
        });
    }
}

2️⃣ //不继承ObservableRecipient 的方案
WeakReferenceMessenger.Default.Register<ReceiverViewModel>(this, (r, m) =>
{

});

Messenger 基类自带的属性，

不继承 ObservableRecipient 也可以直接用 WeakReferenceMessenger.Default.Register

3. 发送消息的 ViewModel
public class SenderViewModel
{
    public void SendMessage()
    {
        WeakReferenceMessenger.Default.Send(new NameChangedMessage("新名字张三"));
    }
}

使用 DI 注入 IMessenger（可选）

你也可以将 Messenger 注入进来，而不是使用静态默认实例：

public class SenderViewModel
{
    private readonly IMessenger _messenger;

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

    public void SendMessage()
    {
        _messenger.Send(new NameChangedMessage("李四"));
    }
}

在 App.xaml.cs 中注册：

services.AddSingleton<IMessenger>(WeakReferenceMessenger.Default);

注销收件人

当不再需要收件人时，应将其注销，以便停止接收消息。 可以按消息类型、注册令牌或收件人取消注册：

//取消对消息类型的接收者的注册
WeakReferenceMessenger.Default.Unregister<LoggedInUserChangedMessage>(this);

//取消指定通道中消息类型的接收者的注册
WeakReferenceMessenger.Default.Unregister<LoggedInUserChangedMessage, int>(this, 42);

//取消所有通道中所有消息的接收方注册
WeakReferenceMessenger.Default.UnregisterAll(this);
项说明
ObservableRecipient让 ViewModel 支持消息监听，需设置 IsActive = true
WeakReferenceMessenger默认静态全局信使，可直接用
Register<TMessage>注册监听消息
Send<TMessage>发送消息

总结：

功能实现方式
ViewModel 通信使用 Messenger.Register 和 Send
解耦 ViewModel不直接引用其他 ViewModel 或服务
支持 DI可注入 IMessenger



IServiceProvider 服务提供者接口

IServiceProvider：服务提供者接口

在 WPF + MVVM 应用中，IServiceProvider 常用于实现 依赖注入（DI），尤其是在使用 CommunityToolkit.Mvvm 配合 .NET Core/5+/6+ 的 WPF 应用时，这个接口是核心组成之一。

什么是 IServiceProvider：

  1. IServiceProvider服务器提供者接口，主要给VM提供各种服务（数据库操作服务，日志服务，定位服务等）
  2. IServiceProvider接口中只有一个GetService()方法，用来获取服务
  3. 它通常与 Microsoft.Extensions.DependencyInjection 一起使用，用于解析依赖项，比如 ViewModel、服务类等。

使用示例

需要安装 Microsoft.Extensions.DependencyInjection 包

后引用：using Microsoft.Extensions.DependencyInjection;

通用依赖注入容器库，可以：

  • 注册服务：services.AddSingleton<T>() / AddTransient<T>()
  • 构建服务提供器：services.BuildServiceProvider()
  • 获取服务：provider.GetRequiredService<T>()
  • 与 MVVM 模式完美配合
1. 注册依赖（Startup）

你需要在 App.xaml.cs 中设置依赖注入容器：

using Microsoft.Extensions.DependencyInjection;

public partial class App : Application
{
  public App()
  {
    Services = ConfigureServices();
    this.InitializeComponent();  
  }

  //获取当前应用程序实例并转换为App类型
  //在全项目范围通过 App.Current 安全访问自定义的 App 对象
  public new static App Current => (App)Application.Current; 

  public IServiceProvider Services { get; } //用来接收 服务提供器 的字段

  // 配置服务
  public static IServiceProvider ConfigureServices()
  {
    //1️⃣ 定义一个服务集合，服务集合编译之后，产生一个ServiceProvider
    // 而ServiceProvider类型实现了IServiceProvider接口
    var services = new ServiceCollection();

    //2️⃣ 注册 ViewModel 和服务
    // services.AddTransient<MainWindowViewModel>();
    // Transient 瞬间模式;
    // Singleton 单例模式
    services.AddSingleton<MainWindowViewModel>();
    services.AddSingleton<AnimalWindowViewModel>();

    // 注册服务
    //services.AddSingleton<接口, 实现类>();
    //AddSingleton 使用时会自动创建一个唯一的实现实例，注入后直接调用接口就可以使用其实现类实现的方法
    services.AddSingleton<IMyService, MyService>();
    services.AddSingleton<IPerson<Person,ViewPerson>, PersonService>();
    services.AddSingleton<IAnimal<Animal,ViewAnimal>, AnimalService>();

    //3️⃣ 构建服务提供器 services.BuildServiceProvider() 并返回
    return services.BuildServiceProvider();
  }
}

  1. 你注册的时候：

    ✅//这表示 MainViewModel 需要的服务（IMyService）会自动注入。
services.AddSingleton<IMyService, MyService>();
services.AddSingleton<MainViewModel>();

  2. 在上面代码中：

    ✅//是 WPF 应用中为了更方便地获取当前应用程序实例的一种做法。
public new static App Current => (App)Application.Current;

    • Application.Current 是一个静态属性，返回当前运行的 WPF 应用实例，其类型Application。

    • 你自定义的 App 类一般是继承自 Application 的

    • 为了能够在程序其他地方方便地访问你自定义的 App 类型，而不是基类 Application，你需要做一次类型转换。

2. 如：在构造函数中使用依赖注入

比如在 MainViewModel 中注入一个服务：

public class MainViewModel : ObservableObject
{
    private readonly IMyService _service;

    public MainViewModel(IMyService service)
    {
        _service = service;
    }
}
3. 获取服务

你可以随时通过 App.Services.GetService() 获取已注册的对象：

var vm = App.Services.GetRequiredService<MainViewModel>();

//1. 如： App.xaml.cs 中启动主窗口
var mainWindow = Services.GetRequiredService<MainWindow>();
mainWindow.Show();

//2. 如：View 构造函数中注入 ViewModel
public partial class MainWindow : Window
{
    public MainWindow(MainViewModel viewModel)
    {
        InitializeComponent();
        DataContext = viewModel;
    }
}

//3. ViewModel 构造函数中注入服务
public class MainViewModel : ObservableObject
{
    private readonly IMyService _myService;

    public MainViewModel(IMyService myService)
    {
        _myService = myService;
    }

    // 使用 _myService 来执行操作
}

//4. 绑定上下文

// MainWindowViewModel视图模型和MainWindow窗体耦合了。
//this.DataContext = new MainWindowViewModel();

// 依赖注入，但没有完全解耦。
//this.DataContext = App.Current.Services.GetService(typeof(MainWindowViewModel));

// 完全解耦了
Type type = Type.GetType("_1.CommunityToolkit.Mvvm基本使用.ViewModels.MainWindowViewModel");
this.DataContext = App.Current.Services.GetService(type);
//this.DataContext = new MainWindowViewModel(new PersonService(), new AnimalService());

搭配 MVVM Toolkit 的建议：

虽然 CommunityToolkit.Mvvm 本身没有内建 DI 容器，但它 完全支持 DI 的设计理念。只要你配合 .NET Generic Host 或 Microsoft.Extensions.DependencyInjection，就能构建清晰的 MVVM 架构。

  • 注册 IServiceProvider
  • 自动注入 ViewModel
  • 使用 RelayCommand 和 ObservableProperty



📁 附：推荐的文件夹命名约定

推荐的文件夹命名结构（基于 MVVM 模式）：

MyWpfApp/
├── Models/              # 业务模型、数据结构类
├── ViewModels/          # 视图模型（含 ObservableObject / RelayCommand 等）
├── Views/               # XAML 视图文件（*.xaml + *.xaml.cs）
├── Services/            # 服务类（如导航、API 调用、本地存储等）
├── Converters/          # IValueConverter 实现
├── Behaviors/           # 附加行为（例如交互逻辑）
├── Helpers/             # 帮助类、扩展方法
├── Resources/           # 资源文件（样式、模板、图片等）
└── App.xaml             # 应用入口

各文件夹用途说明：

文件夹用途说明
Models定义实体类、DTO、业务模型，如 User.cs、Order.cs 等
ViewModels每个 View 对应一个 ViewModel，例如 MainViewModel.cs
Views存放 XAML 视图文件，如 MainView.xaml 和 MainView.xaml.cs
Services例如 INavigationService, IDataService 等
Converters转换器类，如 BoolToVisibilityConverter.cs
Behaviors附加行为（Blend SDK 或自定义）
Helpers静态辅助类、扩展方法
Resources包括 Styles.xaml, Themes, 图片等资源
C#WPF框架Microsoft.Toolkit.MvvM应用实例
qq_30725967的博客
09-28 1680
本文实例演示C#WPF框架Microsoft.Toolkit.MvvM应用
WPF使用Microsoft.Toolkit.Mvvm框架记录
爪哇盘古
11-16 1496
为了解决WPF UI与程序逻辑之间得到解耦，所以使用Microsoft.Toolkit.Mvvm框架来实现，说真的开发逻辑真的有些不适应，不过理解就好。框架大体支持ICommand、IMessenger等。
WPF MVVM框架：CommunityToolkit.Mvvm包使用介绍
zhaotianff的专栏
07-25 2332
40 MvvmLight中的命令类也叫RelayCommand，使用方法大同小异，但是在引发CanExeCutechanged事件时，有点区分，这点会在后面说明。
WPF中MVVM工具包 CommunityToolkit.Mvvm
去追随使你安宁的东西，去做你觉得有用的事情
11-11 3017
也称为MVVM工具包，是Microsoft Community Toolkit的一部分。它是一个轻量级但功能强大的MVVM（Model-View-ViewModel）库，旨在帮助开发者更容易地实现MVVM设计模式。
WPF -- MVVM框架 - CommunityToolkit.Mvvm
哈怂的博客
08-12 1万+
使用依赖项注入，它包括创建大量注入后端类的服务，这允许使用这些服务的代码不依赖于这些服务的实现详细信息，并且还可以轻松地交换这些服务的具体实现。添加引用 using CommunityToolkit.Mvvm.DependencyInjection;MVVM 工具包由 Microsoft 维护和发布，也是 .NET Foundation 的一部分。此模式还使平台特定的功能更易于后端代码使用，方法是通过服务进行抽象化，然后在需要时注入这些功能。目标，用于在 .NET 6 上运行时启用更多内部优化。...
WPF MvvM框架（MvvMLight，Microsoft Toolkit Mvvm，CommunityToolkit.Mvvm；鼠标，键盘，手写等事件绑定如：抬起按下事件）
qq_48492162的博客
07-28 2479
2. 禁止自动添加行：CanUserAddRows="False"，列：AutoGenerateColumns="False"，Microsoft Toolkit Mvvm 框架被废弃之后，微软官方推荐使用CommunityToolkit.Mvvm框架，4.WeakReferenceMessenger.Default.Register()注册消息;步骤3：可以直接套用，其中 Eventname所绑定的事件，在上面已经提供了相关文章；4.读写过程中关键点：如何把PLC的数据类型转换成C#数据类型。
WPF之Microsoft.Toolkit.Mvvm（一）
wanxiweilai的博客
03-14 5188
第一步： 安装package从nuget：查询Microsoft.Toolkit.MVVM. 第二步： 在Model和ViewModel中引入命名空间 Model.cs ViewModel.cs 第三步： 在UI界面绑定数据源 小结： Microsoft继承了mvvm的属性绑定，命令绑定 、以及Messager（Weak...
Wpf在.Net 6 下该用哪个Mvvm框架-Microsoft.Toolkit.Mvvm
热门推荐
chenlinhsfl的博客
12-30 1万+
前言 在Wpf下最常使用的就是Mvvm模式了，有自己造轮子构建Mvvm框架的，也有使用现成的开源项目，我之前一直使用的是轻量级的MvvmLight了，这个框架还是非常不错的，使用也简单，不占用太大空间，其中最喜欢的莫过于全局Messenger了，可谓是神器。最近有个项目使用.Net6开发，在NuGet发现MvvmLight已经很久不更新了，上一次还是2018年9月12日，偶然发现微软官方出的Microsoft.Toolkit.Mvvm 完全继承了Messenger的优良传统，这是一个官方社区套件(Windo
WPF--CommunityToolkit.Mvvm框架详解
Blue
09-18 1675
WPF--CommunityToolkit.Mvvm框架详解
MvvmMicro:用于WPF，UWP和Xamarin的干净轻巧的MVVM框架。受MVVM Light Toolkit启发的表格
03-07
一个干净轻巧的MVVM框架，适用于WPF，UWP和Xamarin.Forms受MVVM Light Toolkit启发。 目标 没有第三方依赖项，例如CommonServiceLocator或System.Windows.Interactivity 。 避免出现–仅包含核心MVVM类型和服务，...
WPF MVVM框架
hccee的博客
11-15 2513
MVVM即Model-View-ViewModel，MVVM模式与MVP（Model-View-Presenter）模式相似，主要目的是分离视图（View）和模型（Model），具有低耦合、可重用性、独立开发、可测试性等优点。
web基础
2301_80329775的博客
05-20 1044
域名的概念：IP 地址不易记忆，域名是互联网络上识别和定位计算机的层次结构式的字符标识，与该计算机的互联网协议 (IP) 地址相对应，用于在数据传输时标识计算机的电子方位，方便人们记忆和输入。早期使用 Hosts 文件解析域名：存在主机名称重复、主机维护困难等问题。在早期计算机数量较少时，可通过修改本地 hosts 文件（C:\Windows\System32\drivers\etc\hosts）解决域名解析工作，但随着互联网发展，这种方式难以满足海量计算机与域名的对应关系需求。
【上位机——WPF】命名空间
weixin_39723539的博客
05-18 527
【上位机——WPF】命名空间
高性能图表库SciChart WPF v8.8全新发布——提升渐变颜色映射高度
需要界面开发、IDE工具研发中文教程资料的小伙伴，记得私信我~
05-22 775
高性能的WPF图表库SciChart WPF v8.8全新发布，新版本是一个累积更新，包含修复和少量增强，向后兼容于SciChart WPF v8.0，欢迎下载最新版体验！
界面组件DevExpress WPF中文教程：Grid - Bands分隔符
需要界面开发、IDE工具研发中文教程资料的小伙伴，记得私信我~
05-19 1096
本文主要介绍如何使用DevExpress WPF Grid控件中的Bands分隔符，欢迎下载最新版组件体验！
5.2.4 wpf中MultiBinding的使用方法
qq_34047402的博客
05-20 174
MultiBinding 允许将多个绑定（Binding）组合成一个逻辑结果，并通过一个转换器（IMultiValueConverter）处理这些值，最终影响目标属性
【竖排繁体识别】如何将竖排繁体图片文字识别转横排繁体，转横排简体导出文本文档，基于WPF和腾讯OCR的实现方案
05-22 586
本文介绍了一个基于WPF和腾讯OCR的竖排繁体文字识别与转换工具的开发过程。该工具主要应用于古籍数字化、繁体文档处理及两岸三地文化交流等场景，能够将竖排繁体文字转换为横排简体格式。文章详细描述了工具的功能需求、界面设计、代码实现步骤，包括OCR认证、竖排文字识别、繁简体转换及文本导出等功能。此外，还提出了性能优化、功能增强、用户体验优化及技术优化等方面的改进建议，以提升工具的实用性和效率。通过该工具，用户可以方便地处理竖排繁体文字，满足多种应用场景的需求。
WPF 常见坑：ContentControl 不绑定 Content 时，命令为何失效？
最新发布
玉面小浪君的博客
05-22 842
在 WPF 开发中，Content="{Binding}" 是一个容易被忽视但至关重要的绑定设置。本文通过一个托盘菜单的案例，详细解析了它的核心作用。当使用 ContentControl 时，如果没有设置 Content="{Binding}"，ContentControl.Content 默认为 null，导致样式触发器和命令无法生效。即使设置了 ContentTemplate，也需要通过 Content="{Binding}" 提供内容对象。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值