1. 项目概述
CommunityToolkit.Mvvm（原Microsoft.Toolkit.Mvvm）是一个轻量级的MVVM框架，专门为.NET开发者设计。我在最近的一个WPF项目中深度使用了这个框架，发现它确实能显著提升开发效率。相比传统的MVVM实现方式，这个框架用更少的代码实现了相同的功能，而且学习曲线非常平缓。
这个框架最吸引我的地方在于它完美平衡了功能完整性和使用简便性。它提供了ObservableObject、RelayCommand等核心组件，但又不会像某些重型框架那样引入过多复杂性。对于中小型项目来说，CommunityToolkit.Mvvm往往是最佳选择。
2. 核心组件解析
2.1 ObservableObject 实现原理
ObservableObject是MVVM模式中的基石，它通过实现INotifyPropertyChanged接口来实现属性变更通知。传统实现需要为每个属性编写大量样板代码：
csharp复制private string _name;
public string Name
{
get => _name;
set
{
if (_name != value)
{
_name = value;
OnPropertyChanged();
}
}
}
而使用CommunityToolkit.Mvvm只需要：
csharp复制[ObservableProperty]
private string _name;
框架会在编译时自动生成完整的属性实现。我通过反编译工具查看过生成的代码，发现它不仅实现了基本功能，还包含了性能优化：
- 使用了CallerMemberName特性避免硬编码属性名
- 添加了null值检查
- 实现了属性值变化比较
提示：虽然代码生成很方便，但要注意生成的属性默认是public的。如果需要internal或protected可见性，需要使用[ObservableProperty(Visibility = ...)]显式指定。
2.2 RelayCommand 的进化
RelayCommand解决了ICommand接口的实现痛点。传统实现需要手动处理CanExecute变化通知，而CommunityToolkit的版本提供了多种简化方式：
csharp复制// 基础用法
[RelayCommand]
private void Submit()
{
// 命令逻辑
}
// 带CanExecute的版本
[RelayCommand(CanExecute = nameof(CanSubmit))]
private void Submit()
{
// 命令逻辑
}
private bool CanSubmit => !string.IsNullOrEmpty(Name);
我在项目中发现几个实用技巧：
-
异步命令只需将方法标记为async：
csharp复制[RelayCommand] private async Task LoadDataAsync() { // 异步操作 } -
可以通过BroadcastChange方法手动触发CanExecuteChanged：
csharp复制
SubmitCommand.BroadcastChange(); -
命令参数支持自动类型转换：
csharp复制[RelayCommand] private void DeleteItem(Item item) { // 直接获取强类型参数 }
3. 实战项目搭建
3.1 环境配置
首先通过NuGet安装必要的包：
bash复制Install-Package CommunityToolkit.Mvvm
对于.NET 6+项目，建议使用隐式using指令，在项目文件中添加：
xml复制<ItemGroup>
<Using Include="CommunityToolkit.Mvvm.ComponentModel" />
<Using Include="CommunityToolkit.Mvvm.Input" />
</ItemGroup>
这样就不需要在每个文件中重复using语句了。我在实际项目中还配置了以下内容：
- 启用nullable引用类型（在csproj中设置
enable ） - 配置代码分析器：
xml复制<PackageReference Include="CommunityToolkit.Mvvm.Analyzers" Version="8.2.0" />
3.2 ViewModel实现示例
下面是一个完整的用户管理ViewModel示例：
csharp复制public partial class UserViewModel : ObservableObject
{
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(FullName))]
[NotifyCanExecuteChangedFor(nameof(SubmitCommand))]
private string _firstName = string.Empty;
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(FullName))]
[NotifyCanExecuteChangedFor(nameof(SubmitCommand))]
private string _lastName = string.Empty;
public string FullName => $"{FirstName} {LastName}";
[ObservableProperty]
private ObservableCollection<User> _users = new();
[RelayCommand(CanExecute = nameof(CanSubmit))]
private void Submit()
{
Users.Add(new User(FirstName, LastName));
FirstName = string.Empty;
LastName = string.Empty;
}
private bool CanSubmit =>
!string.IsNullOrEmpty(FirstName) &&
!string.IsNullOrEmpty(LastName);
[RelayCommand]
private async Task LoadUsersAsync()
{
try {
var users = await _userService.GetAllAsync();
Users = new ObservableCollection<User>(users);
}
catch (Exception ex) {
_logger.LogError(ex, "加载用户失败");
}
}
}
这个示例展示了几个关键特性：
- 属性间的依赖关系（FullName依赖FirstName和LastName）
- 属性变化自动触发命令可用性检查
- 异步命令的最佳实践
- 集合属性的处理方式
4. 高级技巧与优化
4.1 性能优化策略
-
批量更新：当需要同时更新多个属性时，使用SetProperty的变体：
csharp复制public void UpdateAll(string firstName, string lastName) { OnPropertyChanging(nameof(FirstName)); OnPropertyChanging(nameof(LastName)); _firstName = firstName; _lastName = lastName; OnPropertyChanged(nameof(FirstName)); OnPropertyChanged(nameof(LastName)); OnPropertyChanged(nameof(FullName)); } -
避免频繁通知：对于频繁变化的属性（如进度条值），可以添加节流：
csharp复制[ObservableProperty] private int _progress; partial void OnProgressChanged(int value) { if (DateTime.Now - _lastUpdate > TimeSpan.FromMilliseconds(200)) { _lastUpdate = DateTime.Now; // 执行高开销操作 } }
4.2 测试方案
ViewModel的单元测试可以非常直观：
csharp复制[Test]
public async Task LoadUsersCommand_ShouldPopulateUsers()
{
// 准备
var mockService = new Mock<IUserService>();
mockService.Setup(x => x.GetAllAsync())
.ReturnsAsync(new List<User> { new("Test", "User") });
var vm = new UserViewModel(mockService.Object);
// 执行
await vm.LoadUsersCommand.ExecuteAsync(null);
// 验证
Assert.That(vm.Users, Has.Count.EqualTo(1));
mockService.VerifyAll();
}
对于命令测试，有几个要点需要注意：
- 测试CanExecute的各种边界条件
- 验证命令执行后的状态变化
- 对异步命令要测试取消和异常情况
5. 常见问题排查
5.1 属性通知不工作
可能原因及解决方案：
- 未继承ObservableObject：确保ViewModel类继承自ObservableObject
- 字段命名不规范：标记为[ObservableProperty]的字段必须以下划线开头
- 编译时代码生成失败：检查错误列表，确保没有代码生成错误
5.2 命令不触发
检查清单：
- 命令绑定的属性名称是否正确（区分大小写）
- CanExecute逻辑是否正确返回true
- 对于异步命令，确保没有未处理的异常
5.3 内存泄漏问题
常见泄漏场景：
- 事件未注销：当ViewModel引用View时，确保在View卸载时注销所有事件
- 强引用命令：避免在命令中捕获View引用
- 静态资源：不要在静态资源中保存ViewModel实例
诊断工具：
- 使用Visual Studio的内存分析工具
- 检查WeakReference的引用状态
6. 项目扩展建议
在实际项目中，我通常会根据需求扩展基础功能：
-
验证扩展：
csharp复制public partial class UserViewModel { [Required(ErrorMessage = "姓不能为空")] [MaxLength(50, ErrorMessage = "姓不能超过50字符")] [ObservableProperty] private string _firstName; public string this[string columnName] => // 实现索引器 } -
消息总线集成：
csharp复制public class NavigationMessage { /* 导航参数 */ } // 发送消息 _messenger.Send(new NavigationMessage()); // 接收消息 _messenger.Register<NavigationMessage>(this, (r, m) => { /* 处理消息 */ }); -
DI集成：
csharp复制
services.AddSingleton<UserViewModel>(); services.AddSingleton<IMessenger, WeakReferenceMessenger>();
对于大型项目，可以考虑将ViewModel分为功能模块，每个模块专注于特定业务功能。我通常会创建以下目录结构：
code复制ViewModels/
├── UserManagement/
│ ├── UserListViewModel.cs
│ └── UserDetailViewModel.cs
├── ProductManagement/
│ ├── ProductListViewModel.cs
│ └── ProductEditViewModel.cs
└── Shared/
├── NotificationService.cs
└── DialogService.cs