使用MVVM Toolkit简化WPF开发
最近. NET 8 的 WPF 推出了 WPF File Dialog改進,這樣無需再引用 Win32 命名空間就可以實現(xiàn)文件夾的選擇與存儲了,算是一個很方便的改進了。順手寫了一個小的 WPF 程序,在使用 Model-View-ViewModel(MVVM) 模式的時候,我不想使用 Prism 等重量級的框架,找了一個輕量級的 MVVM Community Toolkit (以下簡稱 MVVM Toolkit)。
在現(xiàn)代 WPF 應(yīng)用程序開發(fā)中,遵循 MVVM(Model-View-ViewModel)模式已成為一種標(biāo)準做法。MVVM 模式視圖和邏輯分離,提高了代碼的可測試性、可維護性。
MVVM Toolkit 核心功能
MVVM Toolkit 提供了一系列的功能,使得在 WPF 等程序中實現(xiàn) MVVM 更加簡單。
-
ViewModel 基類:基類(例如
ObservableObject)為實現(xiàn)屬性更改通知提供了基礎(chǔ)結(jié)構(gòu),簡化了 ViewModel 的創(chuàng)建過程。 -
命令的實現(xiàn):MVVM Toolkit 提供了易于使用的命令實現(xiàn)(
RelayCommand),允許 View 以聲明方式綁定到 ViewModel 上的方法。 -
弱消息機制:弱消息機制(
WeakReferenceMessenger)允許不同對象之間收發(fā)消息,而不會造成內(nèi)存泄漏。
安裝
使用 nuget 安裝到 WPF 項目中即可。由于 MVVM Toolkit 面向. NET Standard,所以可在任何應(yīng)用平臺上使用:UWP、WinForms、WPF、Xamarin、Uno 等。
Install-Package CommunityToolkit.Mvvm
代碼生成
在 MVVM Toolkit 中,代碼生成器扮演著重要的角色。通過利用代碼生成器,它能夠自動化諸如屬性更改通知和命令實現(xiàn)等常見任務(wù),減少樣板代碼,提高開發(fā)效率。
例如,開發(fā)者可以通過簡單的屬性標(biāo)記,自動實現(xiàn) INotifyPropertyChanged 接口:
partial class MyViewModel : ObservableObject
{
[ObservableProperty]
private string name;
[ObservableProperty]
private bool isEnabled;
}
以上代碼會通過 Roslyn 的代碼生成器功能生成如下代碼:
partial class MyViewModel
{
public string Name
{
get => name;
set => SetProperty(ref name, value);
}
public bool IsEnabled
{
get => isEnabled;
set => SetProperty(ref isEnabled, value);
}
}
在沒有 MVVM Toolkit 的情況下,開發(fā)者需要手動實現(xiàn) MVVM 的各個部分。例如,實現(xiàn) INotifyPropertyChanged 接口通常涉及創(chuàng)建大量樣板代碼:
public class MyViewModel : INotifyPropertyChanged
{
private string myProperty;
public string MyProperty
{
get => myProperty;
set
{
myProperty = value;
OnPropertyChanged(nameof(MyProperty));
}
}
public event PropertyChangedEventHandler PropertyChanged;
protected virtual void OnPropertyChanged(string propertyName)
{
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}
}
相比之下,MVVM Toolkit 不僅減少了需要編寫的代碼量,也降低了出錯的可能性,使得開發(fā)更加專注于業(yè)務(wù)邏輯本身。
使用 MVVM Toolkit 創(chuàng)建 ViewModel
依賴屬性與命令
以下是使用 MVVM Toolkit 創(chuàng)建 ViewModel 的一個簡單示例:
public partial class MainViewModel : ObservableObject
{
[ObservableProperty]
private string title = "Hello, MVVM Toolkit!";
[RelayCommand]
private void DealWithData()
{
// 數(shù)據(jù)處理邏輯
}
}
ObservableProperty 和 RelayCommand 屬性標(biāo)記自動處理了屬性更改通知和命令實現(xiàn)的細節(jié),開發(fā)者只需關(guān)注業(yè)務(wù)邏輯,并在 XAML 中綁定對應(yīng)的屬性/命令,組件會自動生成對應(yīng)的依賴屬性。
注意,請一定使用 camelCase 命名法(可以帶前導(dǎo)_),代碼生成器會生成符合 PascalCase 標(biāo)準的屬性/方法名稱。
弱引用消息
再看 WeakReferenceMessenger 在不同 ViewModel 或組件間發(fā)送和接收消息:
1. 定義消息類型
首先定義一個消息類型。消息可以是任何類或結(jié)構(gòu),通常包含發(fā)送者想要傳遞的數(shù)據(jù):
public class MyMessage
{
public string Text { get; }
public MyMessage(string text)
{
Text = text;
}
}
2. 發(fā)送消息
在一個 ViewModel 或組件中,你可以發(fā)送消息。假設(shè)有一個 SenderViewModel:
public class SenderViewModel
{
private void SendMessage()
{
var message = new MyMessage("Hello from SenderViewModel");
WeakReferenceMessenger.Default.Send(message);
}
}
SendMessage 方法創(chuàng)建了一個 MyMessage 實例,并通過 WeakReferenceMessenger.Default.Send 方法發(fā)送。
3. 接收消息
在另一個 ViewModel 或組件中,你可以注冊以接收特定類型的消息。例如,你可能有一個 ReceiverViewModel:
public class ReceiverViewModel
{
public ReceiverViewModel()
{
// 注冊以接收 MyMessage 類型的消息
WeakReferenceMessenger.Default.Register<MyMessage>(this, (recipient, message) =>
{
// 處理接收到的消息
string receivedText = message.Text;
// Do something with receivedText
});
}
}
在 ReceiverViewModel 的構(gòu)造函數(shù)中,使用 WeakReferenceMessenger.Default.Register 方法注冊了消息接收器,當(dāng)發(fā)送方發(fā)送 MyMessage 類型的消息時,這個接收器將被調(diào)用。
4. 解除消息注冊
在不再需要接收消息時,或者在對象被銷毀之前,應(yīng)該解除消息的注冊,以避免內(nèi)存泄漏:
public class ReceiverViewModel
{
public ReceiverViewModel()
{
WeakReferenceMessenger.Default.Register<MyMessage>(this, OnMessageReceived);
}
private void OnMessageReceived(object recipient, MyMessage message)
{
// 處理消息
}
~ReceiverViewModel()
{
WeakReferenceMessenger.Default.Unregister<MyMessage>(this);
}
}
ReceiverViewModel 通過其析構(gòu)函數(shù)取消注冊(也可以使用 IDispose 實現(xiàn)),確保當(dāng) ViewModel 被回收時,不會有消息處理器的引用殘留。
總結(jié)
MVVM Toolkit 為 WPF 開發(fā)者提供了一個強大且易用的工具,它極大地簡化了 MVVM 模式實現(xiàn)過程,雖然其他框架(MVVM Light/Prism 等)也提供了類似功能,但它非常輕量,使用簡單,非常適合小型工程使用。
本文使用 AI 幫助潤色了部分內(nèi)容,文章經(jīng)過人工校對。
總結(jié)
以上是生活随笔為你收集整理的使用MVVM Toolkit简化WPF开发的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 一键整合,万用万灵,Python3.10
- 下一篇: Kafka 集群如何实现数据同步?