最近. NET 8 的 WPF 推出了 WPF File Dialog改進,這樣無需再引用 Win32 命名空間就可以實現文件夾的選擇與存儲了,算是一個很方便的改進了。順手寫了一個小的 WPF 程式,在使用 Model-View-ViewModel(MVVM) 模式的時候,我不想使用 Prism 等 ...
最近. NET 8 的 WPF 推出了 WPF File Dialog改進,這樣無需再引用 Win32
命名空間就可以實現文件夾的選擇與存儲了,算是一個很方便的改進了。順手寫了一個小的 WPF 程式,在使用 Model-View-ViewModel(MVVM)
模式的時候,我不想使用 Prism
等重量級的框架,找了一個輕量級的 MVVM Community Toolkit (以下簡稱 MVVM Toolkit)。
在現代 WPF 應用程式開發中,遵循 MVVM(Model-View-ViewModel)模式已成為一種標準做法。MVVM 模式視圖和邏輯分離,提高了代碼的可測試性、可維護性。
MVVM Toolkit 核心功能
MVVM Toolkit 提供了一系列的功能,使得在 WPF
等程式中實現 MVVM 更加簡單。
- ViewModel 基類:基類(例如
ObservableObject
)為實現屬性更改通知提供了基礎結構,簡化了 ViewModel 的創建過程。 - 命令的實現:MVVM Toolkit 提供了易於使用的命令實現(
RelayCommand
),允許 View 以聲明方式綁定到 ViewModel 上的方法。 - 弱消息機制:弱消息機制(
WeakReferenceMessenger
)允許不同對象之間收發消息,而不會造成記憶體泄漏。
安裝
使用 nuget 安裝到 WPF 項目中即可。由於 MVVM Toolkit 面向. NET Standard,所以可在任何應用平臺上使用:UWP、WinForms、WPF、Xamarin、Uno 等。
Install-Package CommunityToolkit.Mvvm
代碼生成
在 MVVM Toolkit 中,代碼生成器扮演著重要的角色。通過利用代碼生成器,它能夠自動化諸如屬性更改通知和命令實現等常見任務,減少樣板代碼,提高開發效率。
例如,開發者可以通過簡單的屬性標記,自動實現 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 的情況下,開發者需要手動實現 MVVM 的各個部分。例如,實現 INotifyPropertyChanged 介面通常涉及創建大量樣板代碼:
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 不僅減少了需要編寫的代碼量,也降低了出錯的可能性,使得開發更加專註於業務邏輯本身。
使用 MVVM Toolkit 創建 ViewModel
依賴屬性與命令
以下是使用 MVVM Toolkit 創建 ViewModel 的一個簡單示例:
public partial class MainViewModel : ObservableObject
{
[ObservableProperty]
private string title = "Hello, MVVM Toolkit!";
[RelayCommand]
private void DealWithData()
{
// 數據處理邏輯
}
}
ObservableProperty
和 RelayCommand
屬性標記自動處理了屬性更改通知和命令實現的細節,開發者只需關註業務邏輯,併在 XAML 中綁定對應的屬性/命令,組件會自動生成對應的依賴屬性。
註意,請一定使用 camelCase 命名法(可以帶前導_),代碼生成器會生成符合 PascalCase 標準的屬性/方法名稱。
弱引用消息
再看 WeakReferenceMessenger
在不同 ViewModel 或組件間發送和接收消息:
1. 定義消息類型
首先定義一個消息類型。消息可以是任何類或結構,通常包含發送者想要傳遞的數據:
public class MyMessage
{
public string Text { get; }
public MyMessage(string text)
{
Text = text;
}
}
2. 發送消息
在一個 ViewModel 或組件中,你可以發送消息。假設有一個 SenderViewModel
:
public class SenderViewModel
{
private void SendMessage()
{
var message = new MyMessage("Hello from SenderViewModel");
WeakReferenceMessenger.Default.Send(message);
}
}
SendMessage
方法創建了一個 MyMessage
實例,並通過 WeakReferenceMessenger.Default.Send
方法發送。
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
的構造函數中,使用 WeakReferenceMessenger.Default.Register
方法註冊了消息接收器,當發送方發送 MyMessage
類型的消息時,這個接收器將被調用。
4. 解除消息註冊
在不再需要接收消息時,或者在對象被銷毀之前,應該解除消息的註冊,以避免記憶體泄漏:
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
通過其析構函數取消註冊(也可以使用 IDispose 實現),確保當 ViewModel 被回收時,不會有消息處理器的引用殘留。
總結
MVVM Toolkit 為 WPF 開發者提供了一個強大且易用的工具,它極大地簡化了 MVVM 模式實現過程,雖然其他框架(MVVM Light/Prism 等)也提供了類似功能,但它非常輕量,使用簡單,非常適合小型工程使用。
本文使用 AI 幫助潤色了部分內容,文章經過人工校對。