萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

C# 實作屬性變更觸發自訂事件 (INotifyPropertyChanged 進階模式)

前言

在 MVVM、資料繫結、領域模型中,屬性變更通知是核心需求。.NET 標準介面 `INotifyPropertyChanged` 僅提供 `PropertyChanged` 事件。本文示範如何實作**帶有舊值/新值、可取消**的強型別屬性變更事件,並提供可重用基底類別。

基本模式:INotifyPropertyChanged (標準)

public class Person : INotifyPropertyChanged
{
    private string _name;
    public string Name
    {
        get => _name;
        set
        {
            if (_name != value)
            {
                _name = value;
                OnPropertyChanged(nameof(Name));
            }
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;
    protected virtual void OnPropertyChanged(string propertyName) 
        => PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}

進階模式:PropertyChanging / PropertyChanged 帶舊新值、可取消

using System;
using System.ComponentModel;

public class PropertyChangingEventArgs : EventArgs
{
    public string PropertyName { get; }
    public object OldValue { get; }
    public object NewValue { get; }
    public bool Cancel { get; set; }

    public PropertyChangingEventArgs(string propertyName, object oldValue, object newValue)
    {
        PropertyName = propertyName;
        OldValue = oldValue;
        NewValue = newValue;
    }
}

public class ObservableObject : INotifyPropertyChanged
{
    // 變更前事件 (可取消)
    public event EventHandler PropertyChanging;
    // 變更後事件 (標準)
    public event PropertyChangedEventHandler PropertyChanged;

    protected virtual bool OnPropertyChanging(string propertyName, object oldValue, object newValue)
    {
        var args = new PropertyChangingEventArgs(propertyName, oldValue, newValue);
        PropertyChanging?.Invoke(this, args);
        return !args.Cancel; // true = 允許變更
    }

    protected virtual void OnPropertyChanged(string propertyName) 
        => PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));

    // 通用設值方法
    protected bool SetProperty(ref T field, T value, string propertyName)
    {
        if (EqualityComparer.Default.Equals(field, value)) return false;
        
        if (!OnPropertyChanging(propertyName, field, value)) return false; // 被取消
        
        field = value;
        OnPropertyChanged(propertyName);
        return true;
    }
}

// 使用範例
public class Product : ObservableObject
{
    private decimal _price;
    public decimal Price
    {
        get => _price;
        set => SetProperty(ref _price, value, nameof(Price));
    }

    private int _stock;
    public int Stock
    {
        get => _stock;
        set => SetProperty(ref _stock, value, nameof(Stock));
    }
}

// 消費端:驗證價格不得小於 0
var product = new Product();
product.PropertyChanging += (s, e) => 
{
    if (e.PropertyName == nameof(Product.Price) && (decimal)e.NewValue < 0)
    {
        e.Cancel = true;
        Console.WriteLine("價格不可為負數,變更已取消。");
    }
};
product.Price = -10; // 不會生效,_price 維持原值

原始碼中提供的兩種寫法比較

特性原始寫法 1 (CustomClass)原始寫法 2 (MyClass + PropertyChagedEventArgs)本文推薦 (ObservableObject)
事件參數無參數 (僅通知)含 PropertyName、OldValue、NewValue、Cancel同寫法 2,但封裝於基底類別
可取消否是是
重用性需每個類別重寫需複製 EventArgs 類別繼承即用
標準相容否部分實作 INotifyPropertyChanged

進階:自動屬性織入

若不想手寫 `SetProperty`,可使用:

  • Fody.PropertyChanged (NuGet):編譯時自動注入 `INotifyPropertyChanged` 實作,屬性寫成 `public string Name { get; set; }` 即可。
  • CommunityToolkit.Mvvm:`[ObservableProperty]` Source Generator 自動產生通知程式碼。

適用場景

  • **資料驗證攔截**:PropertyChanging 中檢查業務規則,違規則 Cancel。
  • **審計日誌**:記錄每次屬性變更的舊值、新值、時間、操作使用者。
  • **撤銷/重做**:將 PropertyChangingEventArgs 推入 Undo Stack。
  • **跨執行緒 UI 同步**:PropertyChanged 觸發 UI 更新 (WPF/WinForms 需 Dispatcher/Invoke)。
copyright © 萬盛學電腦網 all rights reserved