1. 概述
依赖属性(DependencyProperty)是UWP的核心概念,它是有DependencyObject提供的一种特殊的属性。由于UWP的几乎所有UI元素都是集成于DependencyObject的FramewordElement,并且这些UI元素的几乎所有属性及它们出现在XAML中的几乎所有属性都是依赖属性,所以可以说依赖属性是专门为UI设计的属性系统。
依赖属性的定义:
///
/// 获取或设置Title的值
///
public string Title
{
get { return (string)GetValue(TitleProperty); }
set { SetValue(TitleProperty, value); }
}
///
/// 标识 Title 依赖属性。
///
public static readonly DependencyProperty TitleProperty =
DependencyProperty.Register("Title", typeof(string), typeof(MyPage), new PropertyMetadata(string.Empty));
如上述代码所示,和CLR属性不同依赖属性需要定义TitleProperty ,然后在属性包装器(Getter和Setter)中通过GetValue和SetValue函数操作属性值。
2. 使用的场景
UWP的依赖属性经过大幅简化(相对于WPF),更关注它的核心功能:使用绑定,通过多个输入计算属性值,属性值变化通知,节约内存使用。
2.1 绑定
通过属性包装器,依赖属性可以像CLR属性那样使用,也可以在XAML中通过绑定来使用,这是CLR属性不能提供的功能。
在XAML中使用:
在代码中使用:
var binding = new Windows.UI.Xaml.Data.Binding();
binding.Path = new PropertyPath("Title");
TextElement.SetBinding(TextBlock.TextProperty, binding);
2.2 通过多个输入计算属性值
在UWP中依赖属性通过多个输入源计算属性的值,从而使开发人员就避免了不必要的属性设置值或者处理属性值变更通知。以下列表从优先级由高到低列出了依赖属性的使用顺序。
- 动画值 正在运行的动画,或具有 HoldEnd 行为的动画。若要进行动画处理,动画的目标属性必须是依赖项属性。
- 本地值 在代码中直接为对象实例设置的属性值,或者在 XAML 中设置的属性值。
本地值可以通过调用ClearValue函数清除,从而使属性值还原成默认值(以我的经验来说,很少会用到)。
- 模板属性 如果在某个模板(来自 ControlTemplate 或 DataTemplate)中创建一个元素,该元素就会拥有这些模板属性。
- 样式设置器 Style中的Setter。
- 继承值 元素可以从其在对象树中的父级继承依赖项属性的值。譬如开发人员不必为每个TextBlock设置FontSize,只需要为父容器设置FontSize即可套用到父容器中的所有TextBlock上。
- 默认值 不是指数据类型的默认值,是指PropertyMetadata中指定的默认值。在上面Title的例子中,默认值是string.Empty。
2.3 属性值变化通知
使用依赖属性,不必再实现INotifyPropertyChanged即可在属性改变时通知UI更新。也可以在PropertyMeta中使用PropertyChangedCallback或DependencyObject.RegisterPropertyChangedCallback监视依赖属性的属性值改变。
2.4 节约内存使用
前面提到,UWP可以不必为所有值都设置值,UI元素的依赖属性可以从样式、继承值、默认值等计算出实际值,并不需要分配内存;如果设置了本地值,这个本地值将存储在HashTable中,之后从这个HashTable中读取。这是一种以时间换空间的做法。
假设一个Control自身及所继承的FrameworkElement等父类型中所有的属性加起来大概50个,它的控件模板中大概有3个FrameworkElement,所有属性都是double类型并且所有都不必要设置值,一个Control就可以节省50 * 3 * 8=1200字节的内存空间。我做过的系统最多同时在UI上放了10W个Control,那么就总共节省了大概100M内存。
这么极端的情况也才节省这点内存,作用好像也没那么大(难道我算错了?)。关于节约内存这点稍微了解下就好,有助于了解依赖属性的原理,并且面试的时候有可能有帮助。
3 依赖属性和CLR属性之间的选择
使用依赖属性的情况
- 基本上所有继承DependencyObject的类中的属性都应该是依赖属性;
- 需要使用Binding、Style或动画设置值的属性;
- 需要监视属性值变化通知;
- 内存真的真的不够用;
使用CLR属性的情况
- 集合属性。在UWP中常见的集合属性,只有ItemsControl的ItemsSource等少数几个是依赖属性,其它大部分都是CLR属性,譬如Hub的Sections;
- CPU性能敏感的场合。依赖属性是用时间换空间的概念,假如需要频繁读写而又不需要绑定,可以考虑使用CLR属性;
4. 依赖属性和线程
所有依赖属性都只能在UI线程上使用,否则会抛异常(“应用程序调用一个已为另一线程整理的接口。”)。不过如果使用Async模式的话通常会回避了线程的问题。
5. 完整的自定义依赖属性
5.1 定义
///
/// 标识 Title 依赖属性。
///
public static readonly DependencyProperty TitleProperty =
DependencyProperty.Register("Title", typeof(string), typeof(MyPage), new PropertyMetadata(string.Empty));
///
/// 获取或设置Content的值
///
public object Content
{
get { return (object)GetValue(ContentProperty); }
set { SetValue(ContentProperty, value); }
}
///
/// 标识 Content 依赖属性。
///
public static readonly DependencyProperty ContentProperty =
DependencyProperty.Register("Content", typeof(object), typeof(MyPage), new PropertyMetadata(null, OnContentChanged));
private static void OnContentChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
{
MyPage target = obj as MyPage;
object oldValue = (object)args.OldValue;
object newValue = (object)args.NewValue;
if (oldValue != newValue)
target.OnContentChanged(oldValue, newValue);
}
protected virtual void OnContentChanged(object oldValue, object newValue)
{
}
以上代码为一个相对完成的依赖属性例子(还有一些功能比较少用就不写出了),从这段代码可以看出,自定义依赖属性的步骤如下:
注册依赖属性并生成依赖属性标识符。依赖属性标识符为一个public static readonly DependencyProperty字段,在上面这个例子中,依赖属性标识符为ContentProperty。依赖属性标识符的名称必须为“属性名+Property”。在PropertyMetadata中指定属性默认值。
实现属性包装器。为属性提供 CLR get 和 set 访问器,在Getter和Setter中分别调用GetValue和SetValue。Getter和Setter中不应该有其它任何自定义代码。
注意: Setter中不要写其它任何自定义代码这点很重要,如果使用Binding或其它XAML中赋值的方式,程序并不会使用Setter,而是直接调用SetValue函数赋值。这也是为什么需要使用一个PropertyChangedCallback统一处理所有值变更事件,而不是直接写在Setter里面。
- 如果需要监视属性值变更。可以在PropertyMetadata中定义一个PropertyChangedCallback方法。因为这个方法是静态的,可以再实现一个同名的实例方法(可以参考ContentControl的OnContentChanged方法)。
5.2 代码段
注册依赖属性的语法比较难记,可以使用VisualStudio自带的代码段propdp(输入propdp后按两次tab)自动生成,这个代码段生成的代码只有基本功能,如下所示:
public int MyProperty
{
get { return (int)GetValue(MyPropertyProperty); }
set { SetValue(MyPropertyProperty, value); }
}
// Using a DependencyProperty as the backing store for MyProperty. This enables animation, styling, binding, etc...
public static readonly DependencyProperty MyPropertyProperty =
DependencyProperty.Register("MyProperty", typeof(int), typeof(MyPage), new PropertyMetadata(0));
要生成完整的依赖属性代码,可以使用自定义的代码段,以下代码段生成的就是完整的依赖属性定义,快捷键是dp:
dp
SurroundsWith
Dependency Property
dino.c
For Dependency Property
dp
int
int
int
MyProperty
属性名
MyProperty
defaultvalue
默认值
0
classname
类名
ClassName()
ClassNamePlaceholder
/// 获取或设置$MyProperty$的值
///
public $int$ $MyProperty$
{
get { return ($int$)GetValue($MyProperty$Property); }
set { SetValue($MyProperty$Property, value); }
}
///
/// 标识 $MyProperty$ 依赖属性。
///
public static readonly DependencyProperty $MyProperty$Property =
DependencyProperty.Register("$MyProperty$", typeof($int$), typeof($classname$), new PropertyMetadata($defaultvalue$,On$MyProperty$Changed));
private static void On$MyProperty$Changed(DependencyObject obj,DependencyPropertyChangedEventArgs args)
{
$classname$ target= obj as $classname$;
$int$ oldValue = ($int$)args.OldValue;
$int$ newValue = ($int$)args.NewValue;
if (oldValue != newValue)
target.On$MyProperty$Changed(oldValue, newValue);
}
protected virtual void On$MyProperty$Changed($int$ oldValue,$int$ newValue)
{
}]]>
6. Slider与OneWayBinding的"Bug"
UWP的依赖属性比起WPF有了大幅简化,需要学习的地方少了很多,但是功简化了也不一定是一件好事。譬如下面这个代码:
理想的情况下,拖动SliderSource到100以后,因为SliderTarget的Value已经超过Maximum设置的100,所以没有反应;再次把SliderSource拖动到100以下,SliderTarget才会重新跟随SliderSource改变。但实际上,之后无论再怎么拖动SliderSource,SliderTarget都不会有反应。
估计所有继承自RangeBase的控件都会有这个BUG,如果要写一个RangeBase控件(包含Value,Minimum,Maximum三个double值的控件,Value必须在后两个值的范围之间),这是个很让人烦恼的问题。既然现在知道Value会被Maximum及Minimum约束,那么就可以猜想到问题出在ValueProperty的PropertyChangedCallback函数中。产生这个BUG的原因可以参考下面的代码。
private static void OnValuePropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
RangeBase range = d as RangeBase;
double minimum = range.Minimum;
double maximum = range.Maximum;
double value = (double)e.NewValue;
double initialVal = (double)e.OldValue;
if (value < minimum)
{
SetValue(ValueProperty, minimum);
}
if (value > maximum)
{
SetValue(ValueProperty, maximum);
}
range.OnValueChanged(initialVal, value);
}
实际的代码要复杂些,但基本的逻辑就是这样。如果新的Value值超过了Maximum或Minimum,就将Value重新设置为Maximum或Minimum,保证Value不会超过设定的范围。在这个例子里,如果在这个函数开头的位置调用 range.ReadLocalValue(range.ValueProperty),返回的是一个Binding,在结尾的位置调用,返回的则是double类型的100,因为这段代码将Value由OneWay Binding覆盖为maximum的double值了。
在WPF中,这个问题并不存在,因为WPF的依赖属性可以使用CoerceValueCallback约束属性值,而UWP的依赖属性被简化了,缺少这个功能。可以在网上用“Silverlight CoerceValue Helper”或“Silverlight CoerceValue Utils”等关键字试试搜索一些解决方案。为什么使用Silverlight的关键字来搜索?因为Silverlight同样存在这个问题。虽然网上能找到不少解决方案,但以我的经验来说没有方案能很好地解决这个问题。最后我的解决方案如下:
///
/// 不要使用OneWayBinding,只能使用TwoWayBinding
///
public object MyProperty
{
get { return (object)GetValue(MyPropertyProperty); }
set { SetValue(MyPropertyProperty, value); }
}
反正不是写控件库给别人用,写个注释并且和同事打声招呼就算了。
有兴趣的话可以参考Silverlight RangeBase的源代码,由于Silverlight和UWP比较接近,参考Silverlight的源码基本就可以理解RangeBase的实现细节。
RangeBase.cs
这个是Silverlight的开源实现Moonlight的源码,Moonlight的源码对理解UWP、Silverlight都很有参考价值。顺便一提,Silverlight的依赖属性参考文档也比UWP的依赖属性参考文档好用一些。
提示: 为什么使用TwoWay Binding可以解决这个问题?OneWay Binding和TwoWay Binding的内部行为不同。使用OneWay Binding的情况下,给SliderTarget.Value设置一个值,意思就只是SliderTarget的Value需要设置成一个新的值,舍弃了之前的Binding。在TwoWay Binding的情况下,设置一个值的意思不止是Value会成为那个新的值,同时绑定的对象也会更新成这个值,TwoWay Binding 理所当然地不能被舍弃。
7.参考
依赖属性概述
自定义依赖属性
Silverlight 依赖项属性概述