在 .NET 开发领域,MVVM(Model - View - ViewModel)模式凭借其分离视图与业务逻辑的特性,有效提升了代码的可维护性和可测试性。然而,传统的 MVVM 实现往往伴随着大量的样板代码,这无疑增加了开发的复杂度和工作量。CommunityToolkit.Mvvm 库正是为解决这一问题而诞生的,它利用先进的代码生成技术,自动生成 MVVM 模式所需的部分代码,极大地简化了编程体验,让开发者能够将更多精力集中于核心业务逻辑的实现。
由于编译程序会自动将一些特性标签生成代码,使用该库的类需声明为 Partial 类,以便从其他地方获取补充代码。下面介绍几个该库中常用特性及其展开规则。
1.[RelayCommand]标记
[RelayCommand] 特性可自动为标记的方法生成 ICommand 类型的属性。属性名是在原方法名后加上 Command。示例代码如下:
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
public partial class SettingsPageViewModel : ObservableObject
{
[RelayCommand]
public void SaveSettings()
{
// 保存设置的逻辑
}
}
编译器会生成如下代码:
public partial class SettingsPageViewModel : ObservableObject
{
private ICommand _saveSettingsCommand;
public ICommand SaveSettingsCommand => _saveSettingsCommand ??= new RelayCommand(SaveSettings);
public void SaveSettings()
{
// 保存设置的逻辑
}
}
在 XAML 中,应将按钮的 Command 属性绑定到自动生成的 SaveSettingsCommand 属性,如<Button Text="保存设置" Command="{Binding SaveSettingsCommand}" />,而非直接绑定方法名。
2.[ObservableProperty]标记
[ObservableProperty] 特性用在私有属性字段上,编译器会自动生成对应的公共属性及属性更改通知代码。例如:
[ObservableProperty]
private bool _isBufferOn = true;
编译器生成的公共属性代码如下:
public bool IsBufferOn
{
get => _isBufferOn;
set
{
if (_isBufferOn != value)
{
_isBufferOn = value;
OnPropertyChanged(nameof(IsBufferOn));
}
}
}
生成的公共属性名是去掉私有字段名前的下划线 _ 并大写首字母。在 XAML 中可直接绑定该公共属性,如 IsChecked="{Binding IsBufferOn, Mode=TwoWay}" 。
3.[NotifyPropertyChangedFor]标记
当一个属性的变更会影响另一个属性时,可使用 [NotifyPropertyChangedFor] 特性。例如:
public partial class ViewModel : ObservableObject
{
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(FullName))]
private string _firstName;
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(FullName))]
private string _lastName;
public string FullName => $"{FirstName} {LastName}";
}
当 FirstName 或 LastName 属性值改变时,FullName 属性的变更通知也会被触发,确保绑定到 FullName 的视图能及时更新。
4.[INotifyCanExecuteChanged]标记
[INotifyCanExecuteChanged] 特性用于自动处理命令的可执行状态变更通知。例如:
public partial class ViewModel : ObservableObject
{
[ObservableProperty]
private bool _isValid;
[RelayCommand(CanExecute = nameof(CanSave))]
[INotifyCanExecuteChangedFor(nameof(SaveCommand))]
public void Save()
{
// 保存逻辑
}
private bool CanSave()
{
return IsValid;
}
}
当 IsValid 属性值改变时,SaveCommand 的可执行状态会自动更新,从而正确反映在绑定的 UI 元素上,如按钮的启用或禁用状态。
总结
CommunityToolkit.Mvvm 库提供的这些特性,如 [RelayCommand]、[ObservableProperty]、[NotifyPropertyChangedFor] 和 [INotifyCanExecuteChanged],显著简化了 MVVM 模式的开发过程。它们利用编译时的代码生成机制,自动完成了许多样板代码的编写,减少了手动编写属性和命令实现的工作量。这不仅提高了开发效率,还增强了代码的可读性和可维护性,使得开发者能够将更多精力放在业务逻辑的实现上,而不是繁琐的 MVVM 基础代码搭建上。通过合理运用这些特性,开发者可以构建出更加简洁、高效的 MVVM 应用程序。