淺談WPF之屬性系統

老码识途呀發表於2024-03-29

在WPF開發中，經常聽到各種屬性，如：依賴屬性，附加屬性，CLR屬性，那這些不同型別的屬性，具體又有什麼作用呢？今天以一些簡單的小例子，簡述一下WPF開發中，各種屬性的相關概念和應用，僅供學習分享使用，如有不足之處，還請指正。

淺談WPF之屬性系統

CLR屬性

CLR屬性（Common Language Runtime），又稱為.Net 標準屬性，是對類中私有欄位（private）的安裝訪問包裝。透過屬性，可以對呼叫物件輸入的值進行校驗，攔截等。

在屬性出現之前，如果要對公開欄位進行內容校驗，則需要透過公開的方法進行呼叫，而且無法進行強制性校驗，這樣增加了資料校驗的難度和程式的複雜度。具體程式碼如下所示：

public class Person
{
	/// <summary>
	/// 私有欄位
	/// </summary>
	private int id = 0;

	/// <summary>
	/// 公共欄位
	/// </summary>
	public string Name = "Alan";

	/// <summary>
	/// 欄位校驗函式
	/// </summary>
	/// <param name="name"></param>
	/// <returns></returns>
	public bool SetName(string name)
	{
		if (string.IsNullOrEmpty(name) || name == "Admin")
		{
			return false;
		}
		this.Name = name;
		return true;
	}

	public void Do()
	{
		//在此示例中，Name的值，可透過公共欄位進行賦值，也可透過SetName方法賦值，但是我們無法要求呼叫物件強制採用哪一種，，因為看起來兩種都可以。
		Console.WriteLine($"Name={this.Name}");
	}
}

注意：在此示例中，Name的值，可透過公共欄位進行賦值，也可透過SetName方法賦值，但是我們無法要求呼叫物件強制採用哪一種，，因為看起來兩種都可以。

在引入了屬性概念以後，則可以很方便的解決些問題，程式本身看起來也會變得整潔，如下所示：

public class Person
{ 
	private string name =String.Empty;
	/// <summary>
	/// 屬性
	/// </summary>
	public string Name {
		get { return name; }
		set
		{
			if (string.IsNullOrEmpty(value) || value == "Admin")
			{
				return;
			}
			name = value;
		}
	}

	public void Do()
	{
		//引入屬性後，可以在屬性的set方法中進行校驗。
		Console.WriteLine($"Name={this.Name}");
	}
}

透過程式對比發現，屬性封裝了對私有欄位的安全訪問，等於在欄位外增加了一層防護膜，且簡化了程式，使得程式看起來更加簡潔明瞭。

依賴屬性

在WPF中，微軟將屬性這個概念又向前推進了一步，推出了“依賴屬性”這個新概念。那什麼是依賴屬性呢？

簡言之，依賴屬性就是一種可以自己沒有值，並能透過使用Binding 從資料來源獲得值(依賴在別人身上)的屬性。擁有依賴屬性的物件被稱為“依賴物件”。

依賴屬性相關概念和術語，如下所示：

  • 依賴屬性：DependencyProperty 支援的屬性。

  • 依賴屬性識別符號：一個 DependencyProperty 例項，在註冊依賴屬性時以返回值形式獲取它，之後將其儲存為類的靜態成員。 對於與 WPF 屬性系統互動的許多 API，此識別符號用作一個引數。

  • CLR“包裝器”：屬性的實際 get 和 set 實現。 這些實現透過在 GetValue 和 SetValue 呼叫中使用依賴屬性識別符號來併入依賴屬性識別符號，從而使用 WPF 屬性系統為屬性提供支援。

依賴屬性的建立示例，如下所示：

public partial class Test : UserControl
{
	public int Age
	{
		get { return (int)GetValue(AgeProperty); }
		set { SetValue(AgeProperty, value); }
	}

	public static readonly DependencyProperty AgeProperty =
		DependencyProperty.Register("Age", typeof(int), typeof(Test), new PropertyMetadata(0, AgeChangedCallBack));


	private static void AgeChangedCallBack(DependencyObject d, DependencyPropertyChangedEventArgs e)
	{
		//處理變更後的邏輯
		var test = d as Test;
		var newValue = e.NewValue;
        test.txtAge.Text = newValue.ToString();
	}

	public Test()
	{
		InitializeComponent();
	}
}

在Test.xaml中程式碼如下所示：

<UserControl x:Class="DemoMVVM.Views.Test"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
             xmlns:local="clr-namespace:DemoMVVM.Views"
             mc:Ignorable="d" 
             d:DesignHeight="450" d:DesignWidth="800">
    <Grid>
        <StackPanel Orientation="Vertical">
            <TextBlock Text="年齡：" FontSize="14"></TextBlock>
            <TextBox x:Name="txtAge" Height="30" Width="150" HorizontalAlignment="Left" VerticalContentAlignment="Center" FontSize="14"></TextBox>
        </StackPanel>
    </Grid>
</UserControl>

當依賴屬性建立完成後，可以在呼叫的地方，進行賦值或者進行Binding其他依賴屬性，如下所示：

<Window x:Class="DemoMVVM.TestWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:DemoMVVM"
        xmlns:localView="clr-namespace:DemoMVVM.Views"
        mc:Ignorable="d"
        Title="TestWindow" Height="450" Width="800">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"></RowDefinition>
            <RowDefinition></RowDefinition>
        </Grid.RowDefinitions>
        <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}"></localView:Test>
        <Slider x:Name="t1" Width="200" Height="30" Grid.Row="1" Minimum="0" Maximum="100" HorizontalAlignment="Left" VerticalAlignment="Top" Margin="10" Interval="1"></Slider>
    </Grid>
</Window>

在上述示例中，將依賴屬性Age繫結到Slider，透過Slider控制元件的滑動，數值改變，觸發Age屬性的回撥函式。

淺談WPF之屬性系統

在Visual Studio開發工具中，建立依賴屬性可透過模板進行建立。輸入propd，然後tab鍵即可完成一個int型別的依賴屬性建立。

如果需要新增程式碼片段模板，可以在Visual Studio中，工具選單--程式碼片段管理器，開啟程式碼片段管理視窗，然後選擇CSharp，如下所示：

淺談WPF之屬性系統

透過程式碼片段管理器，可以檢視快捷方式和片段儲存位置，修改後自動生效。如下所示：

淺談WPF之屬性系統

與傳統的CLR屬性和麵向物件思想相比依賴屬性有很多新穎之處，其中包括：
（1）節省例項對記憶體的開銷。
（2）屬性值可以透過Binding依賴在其他物件上。

附加屬性

顧名思義，附加屬性是說一個屬性本來不屬於某個物件，但由於某種需求而被後來附加上。也就是把物件放入一個特定環境後物件才具有的屬性(表現出來就是被環培賦予的屬性）就稱為附加屬性（(Attached Properties)。

例如：放在Grid裡就讓Grid為它附加上 Column和Row屬性，放在Canvas裡就讓Canvas為它附加上Top、Left等屬性，放在 DockPanel裡就讓DockPanel 為它附加Dock屬性。可見，附加屬性的作用就是將屬性與資料型別(宿主）解耦，讓資料型別的設計更加靈活。

附加屬性建立語法：

public static int GetDistance(DependencyObject obj)
{
    return (int)obj.GetValue(DistanceProperty);
}

public static void SetDistance(DependencyObject obj, int value)
{
    obj.SetValue(DistanceProperty, value);
}


public static readonly DependencyProperty DistanceProperty =
    DependencyProperty.RegisterAttached("Distance", typeof(int), typeof(Test), new PropertyMetadata(0));

透過對比，附加屬性和依賴屬性，存在以下差異：

首先不同就是註冊附加屬性使用的是名為RegisterAttached 的方法，但引數卻與使用 Register方法無異。

附加屬性的包裝器也與依賴屬性不同——依賴屬性使用CLR屬性對GetValue和 SetValue兩個方法進行包裝，附加屬性則使用兩個方法分別進行包裝。

建立附加屬性後，即可在其子元素上，進行應用，使用方法和Grid.Column，Grid.Row等方式一致。如下所示：

<localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
    <TextBlock localView:Test.Distance="10"></TextBlock>
</localView:Test>

參考文件

在本示例中，主要參考官方文件：

官方文件：https://learn.microsoft.com/zh-cn/dotnet/desktop/wpf/advanced/properties-wpf?view=netframeworkdesktop-4.8

以上就是【淺談WPF之屬性系統】的全部內容，旨在拋磚引玉，一起學習，共同進步。

相關文章