【WPF】 数据绑定机制之INotifyPropertyChanged

INotifyPropertyChanged 是 WPF 中的一个接口,用于实现 数据绑定 中的 属性更改通知。它的主要作用是,当对象的某个属性值发生更改时,通知绑定到该属性的 UI 控件更新其显示内容。

以下是有关 INotifyPropertyChanged 的详细信息和实现方法:


1. INotifyPropertyChanged 简介

INotifyPropertyChanged 定义在 System.ComponentModel 命名空间中,它只包含一个事件:

复制代码
public interface INotifyPropertyChanged
{
    event PropertyChangedEventHandler PropertyChanged;
}
核心机制
  • PropertyChanged 是事件,当对象的属性发生更改时,触发此事件。
  • WPF 数据绑定引擎会监听这个事件,并根据通知更新 UI。

2. 使用场景

在 MVVM 模式中,INotifyPropertyChanged 通常用于 ViewModel 层,确保当属性值更改时,UI 会自动更新。


3. 实现步骤

Step 1: 实现接口
复制代码
using System.ComponentModel;

public class Person : INotifyPropertyChanged
{
    // 实现 INotifyPropertyChanged 接口
    public event PropertyChangedEventHandler PropertyChanged;

    // 用于触发 PropertyChanged 事件的方法
    protected void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }

    private string name;
    public string Name
    {
        get => name;
        set
        {
            if (name != value)
            {
                name = value;
                // 通知绑定 Name 的 UI 更新
                OnPropertyChanged(nameof(Name));
            }
        }
    }
}
Step 2: 在 XAML 中绑定

创建一个简单的 WPF 界面,绑定到 PersonName 属性。

XAML

复制代码
<Window x:Class="WpfApp.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="INotifyPropertyChanged Example" Height="200" Width="300">
    <StackPanel>
        <TextBox Text="{Binding Name, UpdateSourceTrigger=PropertyChanged}" Margin="10"/>
        <TextBlock Text="{Binding Name}" Margin="10"/>
    </StackPanel>
</Window>
Step 3: 设置 DataContext

MainWindow.xaml.cs 中,将 DataContext 设置为 Person 对象。

复制代码
using System.Windows;

namespace WpfApp
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            // 创建 Person 对象并绑定到窗口
            DataContext = new Person { Name = "John Doe" };
        }
    }
}

4. 运行效果

  1. TextBox 中修改 Name 的值时,TextBlock 会自动更新为新的值。
  2. 数据绑定引擎通过 INotifyPropertyChanged 的通知机制感知到属性的更改,并更新绑定的 UI。

5. 注意事项

  1. 避免直接使用字符串 : 使用 nameof 操作符替代硬编码的字符串,避免因属性名变更导致的问题。

    复制代码
    OnPropertyChanged(nameof(Name));
  2. 批量更新 : 如果多个属性发生更改,可以调用 OnPropertyChanged(null)OnPropertyChanged(string.Empty),通知所有属性值发生变化。

  3. 多属性通知 : 如果一个属性的更改会影响其他属性,可以触发多个 OnPropertyChanged 调用。

    复制代码
    OnPropertyChanged(nameof(Name));
    OnPropertyChanged(nameof(FullName));

6. 使用封装提高代码复用性

可以将 INotifyPropertyChanged 的逻辑封装到基类中,减少重复代码:

复制代码
public class ObservableObject : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;

    protected void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }

    protected bool SetProperty<T>(ref T field, T value, string propertyName)
    {
        if (!Equals(field, value))
        {
            field = value;
            OnPropertyChanged(propertyName);
            return true;
        }
        return false;
    }
}

子类实现

复制代码
public class Person : ObservableObject
{
    private string name;
    public string Name
    {
        get => name;
        set => SetProperty(ref name, value, nameof(Name));
    }
}

7. WPF MVVM Toolkit 实现的 INotifyPropertyChanged

WPF MVVM Toolkit(Microsoft.Toolkit.Mvvm)是 Microsoft 推出的 MVVM 框架,它在 INotifyPropertyChanged 的基础上进行了封装和简化。以下是它的特点和实现:

主要特点
  1. 提供了 ObservableObject 基类,简化了 INotifyPropertyChanged 的实现。
  2. 提供了 SetProperty 方法,避免手动触发 PropertyChanged
  3. 支持属性变更通知的自动化和高效实现。
cs 复制代码
using CommunityToolkit.Mvvm.ComponentModel;

public class Person : ObservableObject
{
    private string name;

    public string Name
    {
        get => name;
        set => SetProperty(ref name, value);
    }
}

在实现 INotifyPropertyChanged 接口时,OnPropertyChanged 方法是开发者定义的用于触发属性变更通知的辅助方法 。当某个属性的值发生变化时,通常由属性的 set 访问器 调用 OnPropertyChanged 方法,从而触发 PropertyChanged 事件。


触发过程

  1. 属性的 set 访问器检测到值发生了变化。

  2. 调用 OnPropertyChanged 方法。

  3. OnPropertyChanged 方法触发 PropertyChanged 事件。

  4. WPF 或其他数据绑定框架监听到 PropertyChanged 事件后,更新绑定到该属性的 UI。

  5. Event PropertyChangedEventHandler 用函数包裹起来触发

  6. 实际中用框架,比如Microsoft.Toolkit.Mvvm, 提供了 ObservableObject 基类,简化了 INotifyPropertyChanged 的实现

相关推荐
技术支持者python,php13 分钟前
ModbusRtc与ModbusTCP,esp32
c#
咕白m62524 分钟前
如何用 C# 将 Excel 文件转换为 HTML 格式?
c#·.net
weixin_307779131 小时前
C#程序实现将Teradata的存储过程转换为Amazon Redshift的pgsql的存储过程
数据库·c#·云计算·运维开发·aws
是萝卜干呀1 小时前
Backend - HTTP请求的常用返回类型(asp .net core MVC)
http·c#·.netcore·iactionresult
爱吃小胖橘10 小时前
Unity资源加载模块全解析
开发语言·unity·c#·游戏引擎
时光追逐者11 小时前
全面的 C#/.NET 图表构建解决方案,助力快速实现图表开发需求!
微软·c#·.net·.net core·图表
m5655bj11 小时前
通过 C# 在 Word 文档中添加文字或图片水印
c#·word·visual studio
无盐海1 天前
泛型的协变(Covariance)和逆变(Contravariance)
c#
MintYouth1 天前
【加精】C# XML差异对比 (直接用)
xml·windows·c#
刀一寸1 天前
C# WebAPI下Swagger的配置
ui·c#