补漏：MVVM编写控件时忘记说明的一个问题（keng)
补漏：MVVM编写控件时忘记说明的一个问题（keng)
在前文《浅谈MVVM模式在控件编写中的一些概念和操作方法》中我做出了这样子的说明：
在编写ViewModel和UserControl的依赖属性的setter的时候我们需要添加一个是否更新的判断来解决循环通知的问题。
但事实上基于这个说法是有一个不容易发现的坑的，这个问题主要发生在UserControl的依赖属性上。问题在哪儿呢？我们把之前编写的UserControl的后台代码拿出来看看：
TestContro.xaml.cs：
using GalaSoft.MvvmLight.Messaging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;
namespace MVVM_for_UserControl_Test
{
/// <summary>
/// UserControl1.xaml 的交互逻辑
/// </summary>
public partial class TestControl : UserControl
{
public String MyText
{
get { return (String)GetValue(MyTextProperty); }
set {
if(value == (String)GetValue(MyTextProperty))
{
return;
}
SetValue(MyTextProperty, value);
}
}
// Using a DependencyProperty as the backing store for MyProperty. This enables animation, styling, binding, etc...
public static readonly DependencyProperty MyTextProperty =
DependencyProperty.Register("MyText", typeof(String), typeof(TestControl), new PropertyMetadata("", OnMyTextChanged));
private static void OnMyTextChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
var control = d as TestControl;
Messenger.Default.Send<String>(control.MyText, MessageTokens.MyTextChangedFromView);
}
public TestControl()
{
InitializeComponent();
Messenger.Default.Register<String>(this, MessageTokens.MyTextChangedFromViewModel, (msg) =>
{
MyText = msg;
});
}
}
}
注意到这一行：
public static readonly DependencyProperty MyTextProperty =
DependencyProperty.Register("MyText", typeof(String), typeof(TestControl), new PropertyMetadata("", OnMyTextChanged));
这里我们注册了这个依赖属性，看起来并没有什么问题，我们指定这个依赖属性的默认值为空字符串，一切看起来似乎都很正常。
现在我们考虑这么一个问题，假设我想要让这个依赖属性的默认值为"Hello, World"，并且我们确实这样子设置了：
public static readonly DependencyProperty MyTextProperty =
DependencyProperty.Register("MyText", typeof(String), typeof(TestControl), new PropertyMetadata("Hello, World", OnMyTextChanged));
同时当我们Main View中的要绑定到这个依赖属性上的Model的依赖属性的初始值刚好也是"Hello, World"的话，那么在进行数据绑定的时候会发生什么问题？
那么将会因为我们之前的那个if(value == (String)GetValue(MyTextProperty))导致后面的SetValue(MyTextProperty, value);根本不执行，也就间接地导致MyText属性的修改后的回调函数不会被调用，因此我们的应用在初始化绑定的时候，ViewModel将不会向View发送任何消息以要求View更新界面**，BUG就出现了。
针对这个问题，解决方法很简单，那就是不为UserControl的依赖属性指定任何初始值，直接写成：
public static readonly DependencyProperty MyTextProperty =
DependencyProperty.Register("MyText", typeof(String), typeof(TestControl), new PropertyMetadata(OnMyTextChanged));
即可，这样一来，初始化绑定的时候无论传什么值进来，MyText都会被修改进而触发OnMyTextChanged回调方法。
那么可能就有这么一个问题了：那么UserControl的依赖属性的初始值要在哪里设置呢？答案是在ViewModel中设置：
using GalaSoft.MvvmLight;
using GalaSoft.MvvmLight.Messaging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace MVVM_for_UserControl_Test
{
enum MessageTokens
{
MyTextChangedFromView,
MyTextChangedFromViewModel,
}
public class TestViewModel : ViewModelBase
{
private String _myText = "Hello, World";
public String ThisText
{
get { return _myText; }
set
{
if(_myText == value)
{
return;
}
_myText = value;
Messenger.Default.Send<String>(value, MessageTokens.MyTextChangedFromViewModel);
RaisePropertyChanged(() => ThisText);
}
}
public TestViewModel()
{
Messenger.Default.Register<String>(this, MessageTokens.MyTextChangedFromView, (msg) =>
{
ThisText = msg;
});
}
}
}
因此总结出来一个规定那就是：
- 不应该在UserControl的依赖属性注册的时候为它设定任何初始值；
- 应该在ViewModel中为相应的UserControl的依赖属性注册初始值。
这个问题也可能是相当不容易察觉到的，放到之前的代码中没有提到是因为我们的初始值是一个String，大多数情况我们的Model是不会绑定一个空字符串上去的，所以也就不会触发上面所说的Bug。但是，如果我们为UserControl定义了一个依赖属性是double类型的，并且限制它的范围是0.0-1.0，那么有极大的可能我们绑上去的Model对应的属性一开始就设置成了1.0，于是BUG就发生了。
