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