快捷導(dǎo)航

WPF自定義控件綁定數(shù)據(jù)對(duì)象的最佳實(shí)踐

更新時(shí)間：2025年09月22日 08:59:01 作者：code bean

這篇文章主要介紹了WPF自定義控件數(shù)據(jù)綁定最佳實(shí)踐：直接使用DataContext簡(jiǎn)單但易沖突,依賴屬性更清晰且適合列表場(chǎng)景,推薦在需回寫或列表使用時(shí)采用依賴屬性模式,需要的朋友可以參考下

引言

在 WPF 中開發(fā)自定義控件時(shí)，如何優(yōu)雅地綁定數(shù)據(jù)對(duì)象，是一個(gè)經(jīng)常遇到的問題。最近在實(shí)現(xiàn)一個(gè)自定義的 ImageView 控件時(shí)，我遇到了一個(gè)典型場(chǎng)景：

控件內(nèi)部需要使用第三方控件 HSmartWindowControlWPF 來顯示圖像；
控件需要和業(yè)務(wù)對(duì)象 GraphicInfo 綁定，并且要把自身引用回寫到 GraphicInfo.View；
控件還要支持在 ItemList（例如 ListBox）中批量使用。

本文就以這個(gè)案例為例，來總結(jié)下最佳實(shí)踐。

1. 直接使用 DataContext 的問題

最初的寫法是這樣的：

public override void OnApplyTemplate()
{
    base.OnApplyTemplate();

    var hSmart = (HSmartWindowControlWPF)GetTemplateChild("PART_hSmart");
    hSmart.Loaded += Hsmart_Loaded;
    hSmart.HMouseMove += HSmart_HMouseMove;

    if (DataContext is GraphicInfo info)
    {
        info.View = this; // 子類控件回寫到數(shù)據(jù)對(duì)象
    }
}

在 XAML 里：

<local:ImageView DataContext="{Binding MyGraphic}" />

這種方式雖然能用，但有幾個(gè)問題：

控件內(nèi)部和外部公用了同一個(gè) DataContext，如果控件內(nèi)部還需要 MVVM 綁定，會(huì)和外部沖突。
在 ItemList 中使用時(shí)不夠直觀，容易出錯(cuò)。

2. 定義依賴屬性（推薦）

更好的做法是為控件定義一個(gè)依賴屬性，例如 Graphic：

public class ImageView : Control
{
    static ImageView()
    {
        DefaultStyleKeyProperty.OverrideMetadata(typeof(ImageView),
            new FrameworkPropertyMetadata(typeof(ImageView)));
    }

    // 定義依賴屬性
    public GraphicInfo Graphic
    {
        get => (GraphicInfo)GetValue(GraphicProperty);
        set => SetValue(GraphicProperty, value);
    }

    public static readonly DependencyProperty GraphicProperty =
        DependencyProperty.Register(nameof(Graphic), typeof(GraphicInfo), typeof(ImageView),
            new PropertyMetadata(null, OnGraphicChanged));

    private static void OnGraphicChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (d is ImageView view && e.NewValue is GraphicInfo info)
        {
            info.View = view; // 在綁定時(shí)回寫
        }
    }

    public override void OnApplyTemplate()
    {
        base.OnApplyTemplate();

        var hSmart = (HSmartWindowControlWPF)GetTemplateChild("PART_hSmart");

        if (hSmart != null)
        {
            hSmart.Loaded += Hsmart_Loaded;
            hSmart.HMouseMove += HSmart_HMouseMove;
        }
    }

    private void Hsmart_Loaded(object sender, RoutedEventArgs e) { }
    private void HSmart_HMouseMove(object sender, HMouseEventArgs e) { }
}

這樣，控件就有了一個(gè)獨(dú)立的 Graphic 屬性，外部綁定時(shí)可以很清晰地寫：

<local:ImageView Graphic="{Binding MyGraphic}" />

3. 在 ItemList 中使用

在 ListBox 中批量展示多個(gè) GraphicInfo 時(shí)，就非常自然：

<ListBox ItemsSource="{Binding Graphics}">
    <ListBox.ItemTemplate>
        <DataTemplate>
            <local:ImageView Graphic="{Binding}" />
        </DataTemplate>
    </ListBox.ItemTemplate>
</ListBox>

這里的 Binding 就是每個(gè) GraphicInfo，通過依賴屬性綁定到控件，不會(huì)和 DataContext 混用。