借助Helper实现对象属性变更通知及PasswordBox占位符异常排查

问题描述 #

在WPF中实现PasswordBox占位符效果时出现异常：当Model的Password属性在构造函数中设置string.Empty默认值时，占位符TextBlock始终可见，即使输入密码后也不消失。移除该默认值后，属性变更通知恢复正常。绑定逻辑通过附加属性Helper将PasswordBox与Model的Password属性双向绑定，Model同时被ViewModel和DbContext使用。

原代码片段 #

View #

<Grid >
    <PasswordBox helper:PasswordBoxHelper.Password="{Binding User.Password, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" VerticalContentAlignment="Center" FontSize="14" />
    <TextBlock Padding="12" IsHitTestVisible="False" Text="Password" VerticalAlignment="Center" FontSize="14">
        <TextBlock.Style>
            <Style TargetType="{x:Type TextBlock}">
                <Setter Property="Visibility" Value="Collapsed" />
                <Style.Triggers>
                    <DataTrigger Binding="{Binding User.Password}" Value="">
                        <Setter Property="Visibility" Value="Visible" />
                    </DataTrigger>
                </Style.Triggers>
            </Style>
        </TextBlock.Style>
    </TextBlock>
</Grid>

Helper #

public static class PasswordBoxHelper
{
    public readonly static DependencyProperty PasswordProperty = 
        DependencyProperty.RegisterAttached("Password", typeof(string), typeof(PasswordBoxHelper), new FrameworkPropertyMetadata(string.Empty, OnPasswordPropertyChanged));

    public static string GetPassword(DependencyObject dp)
    {
        return (string)dp.GetValue(PasswordProperty);
    }

    public static void SetPassword(DependencyObject dp, string value)
    {
        dp.SetValue(PasswordProperty, value);
    }

    private static void OnPasswordPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
    {
        var pwdBox = sender as PasswordBox;
        pwdBox.PasswordChanged += PasswordChangedHandler;
    }

    private static void PasswordChangedHandler(object sender, RoutedEventArgs e)
    {
        var pwdBox = sender as PasswordBox;
        SetPassword(pwdBox, pwdBox.Password);
    }
}

Model #

public class User
{
    private string _password;
    public User()
    {
      _password = string.Empty;
    }

    public string Password 
    { 
        get => _password; 
        set
        {
            _password = value;
            NotifyPropertyChanged();
        } 
    }

    public event PropertyChangedEventHandler PropertyChanged;
    private void NotifyPropertyChanged([CallerMemberName] String propertyName = "")  
    {  
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }    
}

ViewModel #

public class IndexViewModel
{
    public User User { get; } = new();
}

问题原因 #

核心问题出在附加属性初始化逻辑缺陷和初始值匹配导致回调未触发：

• 当User构造函数将Password初始化为string.Empty时，该值与附加属性PasswordProperty的默认值完全一致。WPF绑定初始化时，若源值与目标附加属性默认值相同，不会触发OnPasswordPropertyChanged回调。
• 原Helper仅在OnPasswordPropertyChanged回调中注册PasswordBox.PasswordChanged事件，导致事件从未被绑定。用户输入密码时，Helper无法捕获变更，无法同步新值到Model的Password属性，DataTrigger始终检测到Password为空字符串，占位符持续显示。
• 移除Model中Password的默认值后，Password初始值为null，与附加属性默认值string.Empty不匹配，绑定初始化时触发回调，成功注册事件，后续密码变更能正常同步，占位符逻辑恢复正常。

解决方案 #

修正PasswordBoxHelper的逻辑，确保：

1. 无论初始值是否匹配，都能注册PasswordChanged事件（避免重复注册）；
2. 实现附加属性与PasswordBox控件的双向同步；
3. 显式设置附加属性默认支持双向绑定。

修正后的PasswordBoxHelper #

public static class PasswordBoxHelper
{
    public readonly static DependencyProperty PasswordProperty = 
        DependencyProperty.RegisterAttached(
            "Password", 
            typeof(string), 
            typeof(PasswordBoxHelper), 
            new FrameworkPropertyMetadata(
                string.Empty, 
                FrameworkPropertyMetadataOptions.BindsTwoWayByDefault,
                OnPasswordPropertyChanged));

    public static string GetPassword(DependencyObject dp)
    {
        return (string)dp.GetValue(PasswordProperty);
    }

    public static void SetPassword(DependencyObject dp, string value)
    {
        dp.SetValue(PasswordProperty, value);
    }

    private static void OnPasswordPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
    {
        if (sender is not PasswordBox pwdBox) return;

        // 移除旧事件，避免重复注册
        pwdBox.PasswordChanged -= PasswordChangedHandler;
        // 注册新事件
        pwdBox.PasswordChanged += PasswordChangedHandler;

        // 将附加属性的新值同步到PasswordBox，避免源变更时控件不更新
        if (!string.Equals(pwdBox.Password, e.NewValue as string, StringComparison.Ordinal))
        {
            pwdBox.Password = e.NewValue as string ?? string.Empty;
        }
    }

    private static void PasswordChangedHandler(object sender, RoutedEventArgs e)
    {
        if (sender is not PasswordBox pwdBox) return;

        // 将PasswordBox的当前值同步到附加属性，进而更新绑定源
        SetPassword(pwdBox, pwdBox.Password);
    }
}

可选：优化Model的属性逻辑 #

若需保留Model中Password的空字符串默认值，可优化属性setter避免不必要的变更通知：

public class User
{
    private string _password = string.Empty; // 直接字段初始化替代构造函数赋值

    public string Password 
    { 
        get => _password; 
        set
        {
            // 仅当值真正变化时触发通知
            if (string.Equals(_password, value, StringComparison.Ordinal)) return;
            
            _password = value;
            NotifyPropertyChanged();
        } 
    }

    public event PropertyChangedEventHandler PropertyChanged;
    private void NotifyPropertyChanged([CallerMemberName] string propertyName = "")  
    {  
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }    
}

修正后的Helper解决了初始值匹配导致的事件未注册问题，完善了双向同步逻辑，无论Model的Password是否有显式空字符串默认值，占位符都能正常根据密码内容显示/隐藏。

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