WPF里的DependencyProperty

转自： http://www.cnblogs.com/yayx/archive/2008/04/20/1162963.html

 
一 引入DependencyProperty

这个概念可以说是WPF核心中的核心了。在WPF的框架中随时都能见到它的身影。关于DependencyProperty能带来的诸多方便,很多介绍性的文章里都有,我这里就不介绍了,今天先从什么是DependencyProperty说起。

 
从属性开始属性

在CLR中有属性(Property)这个概念，它可以用来封装字段。

 这种属性应用的非常多，我们还可以在set或get方法中加入某些逻辑，确定读取或者设置属性的值的时候我们是不是需要某些其他的判断，一个经典的例子是在Age属性的set方法中加入对年龄范围的判断。这些就不多说了。

private   string  _myString;
public   string  MyString
{
         get{return _myString;}
        set{_myString=value;}
}

 

但是WPF框架的编程经常和界面打交道，经常遇到的一个情况是某个属性的值的变化会影响到多个其他对象。比如当一个Button的改变大小超过了它的容器，他的容器应该自动调整大小。于是我们考虑在每个属性的set方法中触发一些事件，但很快我们发现现有的功能很难满足我们的需求，至少不能简洁漂亮的满足这些需求。
实际上我们的需求更加复杂，WPF中的数据绑定，XAML语法等很多地方都和属性密切相关，我们迫切需要一种功能更加强大的属性。

 于是在WPF中，引入了一种特殊的属性，Dependency Property。这种属性和普通的属性最大不同在于,它的值的来源并不单一。对这种属性的取值和赋值都会能与其他对象有影响，因此能得到很大的灵活性。

这很抽象，也许很难懂。不明白不要紧，先接着看。一步步来，先看看DependencyProperty长什么样，从定义DependencyProperty开始：

public   static   readonly  DependencyProperty MyStringProperty  =  DependencyProperty.Register(
             " MyString " ,
             typeof ( string ),
             typeof (ClassMyDependency),
             new  PropertyMetadata( " defaultValue " ,  new  PropertyChangedCallback(onMyStringPropertyChange)));

 

一眼看上去很复杂，首先使用public static readonly的方式（其实就是设计模式里的单键 这是.net里的一种简单实现）定义了一个全局的DenpendencyProperty成员，这个成员的值通过DependencyProperty的Register方法获得,这个成员我们称做DependencyProperty标识。

我们传入了一些参数，分别表示属性名，属性类型，父元素（也就是包含属性的元素）类型，属性元数据（这些以后再详细介绍）。
要注意的是, 虽然我们定义的名称是MyStringProperty,但是属性的名称不是成员的名称,它由第一个参数指定.这个Property的后缀不是可选的,虽说不按照这个规则编译能通过,但是.net中很多地方都遵循了这种规则,这里我们了解这个规则并保证自己定义的DependecyProperty都遵循它就行了,以后会有更详细的解释.

实际上我们得到了一个属性的标识，这个数据是全局的且是唯一确定的，当需要访问属性的值时，只需要调用对象的GetValue()和SetValue()方法来访问()。语法是：

GetValue(property)
SetValue(property, value)

方法的调用者，不仅可以是定义DependencyProperty的对象，它可以是任何继承了DependencyObject的对象，换句话说,这个属性定义在了这里,但是它并不完全属于这个对象。这很不好理解，不过也正是DependencyProperty功能的强大之处之一，现在先不必深究这个。 
 
不过使用GetValue和SetValue方法给属性赋值让我们很不习惯，于是我们可以对这两个方法进行封装，在上面DependencyProperty的定义之后加上：

 

 

这在 MSDN 中称为 ”CLR 封装 (wrapper)” ，这是可选的，不过经过封装之后，这样对于外界来说， DependencyProperty 就和传统属性没有什么区别了，实现了完全的“向下兼容”。 

  虽然我们还不很清楚DependencyProperty到底可以用来做什么，但现在为止至少已经实现了传统属性的所有功能，注意到，我们并没有定义那个private的私有字段。实际上，.net自动为我们创建了用来存储属性值的区域，这是一种基于Hash的数据存储机制，效率肯定低于传统属性，不过这些效率损失不足以影响我们。插一句，牺牲一点点性能来换取强大的功能是DotNet的一贯做法，呵呵

 关于为DependencyProperty的赋值，实际上和传统的属性没有太大区别，XAML和 code中都可以为其赋值：
code中就不介绍了，和传统属性赋值相同，在XAML中，使用一个XML属性即可：
<l:ClassMyDependency MyString="11111" MyString1="22222" x:Key="myclass" />

l是实现定义的名字空间前缀，MyString是一个DependencyProperty,MyString1是一个普通属性，实际上这两个属性都能实现XAML下的赋值。
这一句XAML如果翻译成C# code大概是这个样子:
DependencyProperty主要功能是为了能让XAML代码为后台属性赋值，这是错误的。
不过使用XAML使用DependencyProperty也是有道理的。至于具体为什么，我准备在后续的POST里面会详细的说明。

        ClassMyDependency myclass  =   new  ClassMyDependency();
        myclass.MyString = " 11111 " ;
        mycalss.MyString1 = " 22222 " ;

网上有一些地方介绍说

 

好了，就这么多。今天的第一篇里,我们看到了DependencyProperty的样子，大概了解它的定义，它的存储方式。不过事实上我们到现在还并不知道这到底能用在什么地方。下一篇POST中我准备介绍一下DependencyProperty的一些用途,并且从用途出发看看一下它是如何完成这些看似有点不可思议的功能的。

 

DependencyProperty用在哪儿？

这一节的内容都摘抄自MSDN^_^，因此详细的资料都可以参考MSDN，我在这里稍微解释一下，主要是为了下一个小节做下铺垫。

• Resources（资源）

• Data binding（数据绑定）

• Styles（风格）

• Animations（动画）

• Metadata overrides（元数据覆盖）

• Property value inheritance（值继承）

• WPF Designer integration（WPF设计集成）

在Resources和Data binding中，XAML提供了这样一种语法，来为属性赋值：

< Button  Background ="{DynamicResource MyBrush}" />
< Button  Content ="{Binding XPath=Team/@TeamName}" />

 

这种用{}括起来配上DynaminResource或者Binding关键字，这在WPF中叫做"Markup Extension"(标记扩展？)。这种语法非常好用，不过如果你之前没有接触过WPF一定会觉得这种语法很奇怪。如何使用这种语法不是我们现在要讨论的内容，现在的关键是如果你希望用Markup Extension来为属性赋值，那么这个属性必须是Dependency Property。

Styles中，WPF为我们提供了一个叫"Setter"的工具来为属性赋值，比如这样：

< Style  x:Key ="GreenButtonStyle" >
< Setter  Property ="Control.Background"  Value ="Green" />  
</ Style >

 

我第一次看到这种语法的时候想到了css，类似下面这样代码

.GreenButtonStyle{ Background:Green;}

对比起来，也许你很容易理解上面的XAML代码了
在这里，XAML和HTML的区别在于HTML是动态的解释性的而XAML是需要被编译的，是强类型的。你需要记住的是，如果希望使用Setter，那么目标属性必须是DependencyProperty。

在WPF的动画中，你可以使用一些方法将一个Animation对象应用在某些属性上，然后WPF会使用一个Clock让属性值进行变化从而产生动画效果。看这个简单的例子：

 

< Button > I am animated
   < Button.Background >
     < SolidColorBrush  x:Name ="AnimBrush" />
   </ Button.Background >
   < Button.Triggers >
     < EventTrigger  RoutedEvent ="Button.Loaded" >
       < BeginStoryboard >
         < Storyboard >
           < ColorAnimation
             Storyboard.TargetName ="AnimBrush"  
            Storyboard.TargetProperty ="Color"
            From ="Red"  To ="Green"  Duration ="0:0:5"  
            AutoReverse ="True"  RepeatBehavior ="Forever"   />
         </ Storyboard >
       </ BeginStoryboard >
     </ EventTrigger >
   </ Button.Triggers >
</ Button >

 

注意ColorAnimation小节，定义了TargetProperty是"Color",然后让Color从"Red"到"Greed"变化，同时设定了其他一些参数。动画过程不多介绍，你需要记住的是，如果你希望对某个属性应用动画，那么这个属性必须是DependencyProperty

下面是Metadata Overrides，这个可能比较难理解。这么说吧，每个属性都有自己的Metadata(元数据)，在里面我们可以存放比如属性的“默认值”，当然真实的元数据里还包含了更多的信息。具体的就不多讨论了，我们只需要了解，DependencyProperty可以支持元数据的覆盖。在某些时候，这是非常有用的，之后会提到。

Property Value Inheritance，属性值继承。这是DependencyProperty实现的很重要的一个功能，很多介绍DependencyProperty的文章都会用这个功能来引入DependencyProperty。举个非常常见的例子，假设我们布局时，包含了这么一个关系：

Window -> Grid -> Button

这形成了一颗“逻辑树”，很容易理解，Window里套了个Grid，Grid里有个Button。现在我们把Window的Fontsize也就是字体大小改变，你会发现在WPF中Button的字体大小也会相应变化。这在WInform中是做不到的。
也许你觉得没什么，仅仅是一个值的继承而已，但是如果你深入想想，Window包含Fontsize这个属性，Button也有，这很好，但是Grid并没有包含Fontsize属性啊，这个值又是怎么继承到Button上的呢？答案就是利用Dependency Property提供的继承功能。

最后所谓的WPF Designer integration，是指如果你在自定义控件中使用了Dependency Property，那么VS或者Blend的属性编辑器中就会自动出现相应的属性。

其实除了上面这些MSDN中提到的，DependencyProperty的用途还有很多，总的说来，就是这个属性的值不再独立，将与其他的属性值产生一定的“依赖”关系。因此名曰：Dependency Property

WPF中DependencyProperty到底实现了什么？

上面那些功能如果使用DependencyProperty，就不能解决，至少会很复杂，否则Microsoft也不会弄出这么一套东西出来。现在我们来总结一下，DependencyProperty自身到底要实现哪些传统属性无法实现或很难实现的功能（上面的应用是抄MSDN的，DependencyProperty还有些功能上面并没有提到，我一并列在下面)

高效的属性值存储
如果你对.net的属性以及元数据等概念了解比较深，也许你第一反应就是DependencyProperty封装了很多反射功能。是的，不论是"Markup Extension"还是"Setter",还是"Animation"，我们仅仅通过XAML或程序中的一些字符串就完成了对属性的访问，这正是反射的特征。由于XAML的需要，或者是WPF team项目经理的需要，WPF team决定在WPF中大量使用反射。要知道，反射一向是C#的“贵族功能”，十分损耗性能，假若所有的属性我们都直接通过反射读取，估计在WPF应用程序在性能上就无法接受了（其实现在WPF应用程序在性能上也不怎么地）。DependencyProperty在底层封装了高效的Hash算法来解决通过字符串获得值的问题，在后面的POST中，我会详细介绍DependencyProperty是如何存储值的。
因此，有了DependencyProperty，我们可以放心的使用"Markup Extension","Setter"等等一系列令人激动的功能了，这影响的功能还不只这些，WPF中实现的数据绑定，动画等等强大功能，都靠这个了。

属性的继承
正如上面Window->Grid->Button的例子，在WPF的逻辑树中，我们将使用DependencyProperty来完成属性的继承。

自动的进行重新布局
这可能不太好解释，如果你了解过WPF的layout机制可能会比较容易理解。
WPF中并没有传统窗体重绘的机制，所谓“重绘”，是通过DependencyProperty的自动更新属性值来进行的。
当WPF中某些视觉元素的属性变化时，WPF系统能够通过DependencyProperty自动进行重新的"Measure"来确定自己的尺寸大小是否发生了变化，或者自动"Arrange"来确定是否要重新排列自己子元素的位置，又或者自动"Render"来重新绘制元素的图形。
举个例子，我们通常把绘制Button的背景色代码写在Button控件的OnRender事件中，当一个Button的Background属性值变化时，通过DependencyProperty可以引起一个自动Render的过程，又比如，一个Grid对象的行数属性或者列数属性发生改时，Grid应该能够自动重新排列他的子元素。

属性值的验证和强制值
DependencyProperty还实现了验证输入值的功能，并且当这些值不满足验证条件时，强制的为属性赋一个满足条件的值。

属性改变通知
DependencyProperty实现的另外一个功能是自动的属性改变通知，也就是当某个属性的值发生变化时执行某个函数或是触发某个事件。

其他我没注意的功能
其实DependencyProperty的机制完全足以让他提供更多的功能，我不可能把它的功能实现一一罗列出来……因此，放上这最后一点。

这些功能都通过一定的机制被DependencyProperty完美的实现了，当我们需要使用这些功能的时候，我们只需要自定义一个DependencyProperty来实现就行了（很符合Microsoft的一贯风格……惯坏程序员 呵呵）

注：WPF的DependencyProperty，而非.net

如果你足够细心，也许你已经发现和去年那篇文章不同，我把标题从".Net3.0里的DependencyProperty"改为了"WPF中俄DependencyProperty"。以前我认为DependencyProperty是.net3.0的新特性，后来发现这是错误的，查看.net3.0/3.5的类库就会发现，居然有两个不同命名空间但重名的DependencyProperty！

System.Windows.DependencyProperty，这属于WPF一部分
System.Workflow.ComponentModel.DependencyProperty，这属于WWF一部分

DependencyProperty在WWF中也有很特别的应用，可以为一个属性分配ActivityBind，从而让这个属性的值依赖某Activity，这和WWF关系较大，这里不详细说明。基本用法可以参考：http://www.cnblogs.com/carysun/archive/2008/04/12/1149249.html中的内容或者其他资料。
但要注意，WWF中的DependencyProperty虽然和WPF中的用法很像，但他和WPF中的DependencyProperty完全不是一个东西
两者有什么不同呢？这么说吧，两者支持的功能不同，例如WPF的DP支持了Animation，而WWF中的DP支持了ActivityBind，而更加有意思的是两者的实现机制虽然大体类似，但具体的代码实现完全不同！如果你有兴趣，你可以使用Reflactor查看一下这两个不同的DependencyProperty的源码。似乎能看出一些MS内部重构代码的痕迹——一个team写了一些代码，另一个team拿去加入了自己的功能，重构了实现，release了两套代码……并且，相比起来感觉WPF Team的版本比WWF team的版本的DependencyProperty复杂多了……扯远了，打住。。。
所以纠正一下，我上面所说的DependencyProperty，以及之后想继续说的，是System.Windows.DependencyProperty，WPF的一部分，而非什么".net 3.0中的Dependency Property"。

小结

这一篇Post首先抄了不少MSDN，介绍了通过DependencyProperty，WPF得以实现的一些功能。然后，我又试图总结了一下DependencyProperty自身所实现的功能，给大家做个参考吧。发现我还是没有开始介绍WPF DependencyProperty的详细用法，下次一定要写了。

         public   string  MyString
         {
            get { return (string)GetValue(myStringProperty); }
            set { SetValue(myStringProperty, value); }
        }