使用MVVM Toolkit簡化WPF開發

波多爾斯基發表於2023-11-16
MVVM

最近. 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 更加簡單。

  1. ViewModel 基類：基類（例如 ObservableObject）為實現屬性更改通知提供了基礎結構，簡化了 ViewModel 的建立過程。
  2. 命令的實現：MVVM Toolkit 提供了易於使用的命令實現（RelayCommand ），允許 View 以宣告方式繫結到 ViewModel 上的方法。
  3. 弱訊息機制：弱訊息機制（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 幫助潤色了部分內容，文章經過人工校對。

相關文章