.NET Framework 4.8下WPF通用可绑定属性失效问题排查

前提 #

使用.NET Framework 4.8进行WPF开发

背景 #

在WPF开发中，为减少绑定属性的样板代码，先实现了通用的BindableBase基类封装属性变更通知逻辑：

public class BindableBase : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;

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

    /// <summary>
    /// 设置字段值，若新值与旧值不同则返回true，否则返回false
    /// </summary>
    /// <typeparam name="T">属性/字段类型</typeparam>
    /// <param name="field">要更新的字段引用</param>
    /// <param name="value">新值</param>
    /// <param name="propertyName">属性名，留空由编译器自动填充</param>
    /// <returns>值变更则返回true，否则false</returns>
    protected bool SetField<T>(ref T field, T value, [CallerMemberName] string propertyName = null)
    {
        if (EqualityComparer<T>.Default.Equals(field, value)) return false;
        field = value;
        OnPropertyChanged(propertyName);
        return true;
    }

    public delegate void PropertyValueChangedEventHandler<T>(T newValue);
}

原先的绑定属性写法如下：

private object privateProp;
public object PublicProp
{
    get => privateProp;
    set => SetField(ref privateProp, value);
}

为进一步简化代码，尝试封装BindableProperty<T>类：

public class BindableProperty<T> : BindableBase
{
    private T value;
    public T Value
    {
        get => value;
        set => SetField(ref value, value);
    }
}

期望的使用方式：
XAML部分：

<StackPanel Name="PermissionsPanel">
    <CheckBox Name="ReadCheckBox" IsChecked="{Binding ReadFlag.Value}" />
    <CheckBox Name="WriteCheckBox" IsChecked="{Binding WriteFlag.Value}" />
</StackPanel>

C#部分：

public class Permissions
{
    BindableProperty<bool> ReadFlag = new BindableProperty<bool>();
    BindableProperty<bool> WriteFlag = new BindableProperty<bool>();
}

public class SomeWindow : Window
{
    private readonly Permissions permissions = new Permissions();

    public SomeWindow()
    {
        InitializeComponent();
        
        PermissionsPanel.DataContext = permissions;
    }
}

但实际运行时绑定完全失效，以下是问题原因和修复方法：

失效原因 #

1. 绑定目标不是公共属性：WPF数据绑定仅能访问公共属性，Permissions类中的ReadFlag和WriteFlag是私有字段，绑定引擎无法识别并访问。
2. 参数名冲突导致字段未更新：BindableProperty<T>的Value属性setter中，SetField(ref value, value)存在变量名冲突——字段名与参数名均为value，导致实际传入的是字段原有值，字段根本不会被更新，自然无法触发属性变更通知。

修复方案 #

步骤1：将私有字段改为公共属性 #

修改Permissions类，把字段改为公共只读属性：

public class Permissions
{
    public BindableProperty<bool> ReadFlag { get; } = new BindableProperty<bool>();
    public BindableProperty<bool> WriteFlag { get; } = new BindableProperty<bool>();
}

步骤2：修正BindableProperty<T>的参数冲突 #

重命名字段以区分参数，比如将字段名改为_value：

public class BindableProperty<T> : BindableBase
{
    private T _value;
    public T Value
    {
        get => _value;
        set => SetField(ref _value, value);
    }
}

可选优化：支持值变更监听 #

若需要监听BindableProperty<T>的值变化，可在BindableBase中添加对应事件并在SetField中触发：

public class BindableBase : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;
    public event PropertyValueChangedEventHandler<object> PropertyValueChanged;

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

    protected bool SetField<T>(ref T field, T value, [CallerMemberName] string propertyName = null)
    {
        if (EqualityComparer<T>.Default.Equals(field, value)) return false;
        field = value;
        OnPropertyChanged(propertyName);
        PropertyValueChanged?.Invoke(value);
        return true;
    }

    public delegate void PropertyValueChangedEventHandler<T>(T newValue);
}

修改后绑定即可正常工作，既保留了代码简化的优势，又符合WPF数据绑定的规范。

内容的提问来源于stack exchange，提问作者Elias Verstappe