WPF PasswordBox中的Password属性绑定

涔涔OVER

3042人浏览 · 2024-03-23 16:24:52

涔涔OVER · 2024-03-23 16:24:52 发布

WPF中Password绑定

WPF中Password绑定

前言

在 WPF（Windows Presentation Foundation）开发中，PasswordBox 控件用于处理用户密码输入。然而，由于安全考虑，PasswordBox.Password 属性并非依赖属性（Dependency Property），因此无法直接通过数据绑定（Data Binding）与 ViewModel 中的属性进行双向同步。这限制了 MVVM 模式下密码处理的表现力。

为了解决这一问题，我们可以通过附加属性（Attached Property）机制，优雅地实现 PasswordBox 的密码绑定。本文将详细介绍如何通过自定义附加属性实现安全的密码绑定，同时提供完整的代码示例和使用指南。

实现原理

PasswordBox 的 Password 属性无法直接绑定，我们可以通过以下步骤实现绑定功能：

创建附加属性：定义一个附加属性 Password，用于存储密码值，并通过绑定与 ViewModel 交互
事件同步：监听 PasswordBox 的 PasswordChanged 事件，将用户输入的密码同步到附加属性
防止循环更新：通过状态标记避免绑定更新和事件触发之间的无限循环
集成 MVVM：确保附加属性与 ViewModel 的属性无缝衔接，支持双向绑定

这种方法既保留了 PasswordBox 的安全性，又实现了 MVVM 模式下的灵活性

代码实现

以下是实现密码绑定的完整代码，分为 XAML 界面、辅助类和 ViewModel 三部分

LoginWindow.xaml

xmlns:Helper="clr-namespace:DataMaster_PLC.Helpers"

 <!-- Password Input -->
 <StackPanel Orientation="Horizontal" Margin="0,0,0,10">
     <materialDesign:PackIcon Kind="KeyVariant" VerticalAlignment="Center" Margin="0,0,5,0"/>
     <PasswordBox Width="230"
                  Helper:PasswordBoxHelper.Attach="True"
                  Helper:PasswordBoxHelper.Password="{Binding Password, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"
                  materialDesign:HintAssist.Hint="Password"
                  Style="{StaticResource MaterialDesignPasswordBox}"/>
 </StackPanel>

在 XAML 中，我们通过附加属性 PasswordBoxHelper.Password 将 PasswordBox 的密码绑定到 ViewModel 的 Password 属性。Attach=“True” 启用绑定功能

PasswordHelper.cs

using System.Windows;
using System.Windows.Controls;

namespace DataMaster_PLC.Helpers {
    /// <summary>
    /// 提供一个辅助工具，用于使PasswordBox的Password属性能够进行数据绑定。
    /// </summary>
    public class PasswordBoxHelper {
        /// <summary>
        /// 注册附加依赖属性"Password"，类型为string，当其值改变时触发OnPasswordPropertyChanged方法
        /// </summary>
        public static readonly DependencyProperty PasswordProperty = DependencyProperty.RegisterAttached(
            "Password", 
            typeof(string), 
            typeof(PasswordBoxHelper), 
            new FrameworkPropertyMetadata(string.Empty, OnPasswordPropertyChanged));

        /// <summary>
        /// 注册附加依赖属性"Attach"，表示是否需要启用密码绑定功能，当其值改变时触发Attach方法
        /// </summary>
        public static readonly DependencyProperty AttachProperty = DependencyProperty.RegisterAttached(
            "Attach", 
            typeof(bool), 
            typeof(PasswordBoxHelper), 
            new PropertyMetadata(false, Attach));

        /// <summary>
        /// 私有静态依赖属性"IsUpdating"，用于跟踪PasswordBox密码更新状态
        /// </summary>
        private static readonly DependencyProperty IsUpdatingProperty = DependencyProperty.RegisterAttached(
            "IsUpdating", 
            typeof(bool), typeof(PasswordBoxHelper));

        /// <summary>
        /// 设置附加属性"Attach"的值
        /// </summary>
        public static void SetAttach(DependencyObject dp, bool value) {
            dp.SetValue(AttachProperty, value);
        }

        /// <summary>
        /// 取附加属性"Attach"的值
        /// </summary>
        public static bool GetAttach(DependencyObject dp) {
            return (bool)dp.GetValue(AttachProperty);
        }

        /// <summary>
        /// 获取附加属性"Password"的值
        /// </summary>
        public static string GetPassword(DependencyObject dp) {
            return (string)dp.GetValue(PasswordProperty);
        }

        /// <summary>
        /// 置附加属性"Password"的值
        /// </summary>
        public static void SetPassword(DependencyObject dp, string value) {
            dp.SetValue(PasswordProperty, value);
        }

        /// <summary>
        /// 获取附加属性"IsUpdating"的值
        /// </summary>
        private static bool GetIsUpdating(DependencyObject dp) {
            return (bool)dp.GetValue(IsUpdatingProperty);
        }

        /// <summary>
        /// 设置附加属性"IsUpdating"的值
        /// </summary>
        private static void SetIsUpdating(DependencyObject dp, bool value) {
            dp.SetValue(IsUpdatingProperty, value);
        }

        /// <summary>
        /// 当"Password"属性发生变化时调用此方法，同步PasswordBox的实际密码与绑定值
        /// </summary>
        private static void OnPasswordPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) {
            if (sender is PasswordBox passwordBox) {
                passwordBox.PasswordChanged -= PasswordChanged;

                // 防止在更新过程中引发无限循环
                if (!(bool)GetIsUpdating(passwordBox)) {
                    passwordBox.Password = (string)e.NewValue;
                }
                passwordBox.PasswordChanged += PasswordChanged;
            }
        }

        /// <summary>
        /// 当"Attach"属性值变化时（即绑定或解绑事件处理程序）调用此方法
        /// </summary>
        private static void Attach(DependencyObject sender, DependencyPropertyChangedEventArgs e) {
            if (sender is not PasswordBox passwordBox)
                return;
            if ((bool)e.OldValue) {
                passwordBox.PasswordChanged -= PasswordChanged;
            }
            if ((bool)e.NewValue) {
                passwordBox.PasswordChanged += PasswordChanged;
            }
        }

        /// <summary>
        /// 密码更改事件处理程序，当PasswordBox的密码发生更改时，更新绑定到Password属性的值
        /// </summary>
        private static void PasswordChanged(object sender, RoutedEventArgs e) {
            if (sender is PasswordBox passwordBox) {
                SetIsUpdating(passwordBox, true);
                SetPassword(passwordBox, passwordBox.Password);
                SetIsUpdating(passwordBox, false);
            }
        }
    }
}

PasswordBoxHelper 是核心实现类，通过附加属性和事件处理实现密码的绑定与同步。IsUpdating 属性防止了循环更新的问题

LoginViewModel.cs

 private string _password = string.Empty;
/// <summary>
/// 密码属性
/// </summary>
public string Password {
    get => _password;
    set {
        _password = value;
        OnPropertyChanged(nameof(Password));
    }
}