XAML自定义控件：避免内存泄露的小妙招

XAML自定义控件：避免内存泄露的小妙招

引用

CSDN

等

6

来源

1.

https://blog.csdn.net/wjl133/article/details/119532642

2.

https://blog.csdn.net/sD7O95O/article/details/135891257

3.

https://learn.microsoft.com/zh-cn/archive/msdn-magazine/2019/may/xaml-custom-xaml-controls

4.

https://www.cnblogs.com/wpinfo/p/xaml_control_event_bp.html

5.

https://www.cnblogs.com/duwenlong/p/14719927.html

6.

https://learn.microsoft.com/zh-cn/dotnet/desktop/wpf/events/weak-event-patterns?view=netdesktop-9.0

在开发XAML应用程序时，创建自定义控件是一个常见的需求。然而，在处理自定义控件中的事件时，如果不注意可能会导致内存泄露的问题。本文将分享一些实用技巧，教你如何通过正确的事件注册和反注册操作，避免内存泄露，让你的应用程序更加稳定高效。记住，小小的代码改动就能带来大大的性能提升哦！

在自定义控件中，我们经常需要为内部的控件添加事件处理程序。例如，你可能有一个包含按钮的自定义控件，需要在按钮点击时执行某些操作。这种情况下，你可能会写出如下代码：

public override void OnApplyTemplate()
{
    base.OnApplyTemplate();
    Button btnView = GetTemplateChild("PART_ViewButton") as Button;
    if (btnView != null)
    {
        btnView.Click += BtnView_Click;
    }
}

private void BtnView_Click(object sender, RoutedEventArgs e)
{
    // 这里写响应逻辑
}

这段代码看起来没有问题，但是实际上存在内存泄露的风险。为什么呢？

在C#中，事件监听会导致对象之间存在引用关系。具体来说，事件源（这里是按钮）会持有事件监听者（自定义控件）的引用。如果事件监听者不再使用，但由于事件源仍然引用它，那么它就不会被垃圾回收器（GC）回收，从而导致内存泄露。

为了解决这个问题，我们需要在适当的时候移除事件监听。在自定义控件中，最好的做法是在OnApplyTemplate方法中进行事件的注册和反注册。这是因为当控件的模板发生变化时，OnApplyTemplate方法会被调用，这为我们提供了一个理想的时机来清理之前的事件监听。

下面是改进后的代码示例：

private Button btnView = null;

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

    // 先反注册事件
    if (btnView != null)
    {
        btnView.Click -= BtnView_Click;
    }

    btnView = GetTemplateChild("PART_ViewButton") as Button;
    if (btnView != null)
    {
        btnView.Click += BtnView_Click;
    }
}

private void BtnView_Click(object sender, RoutedEventArgs e)
{
    // 这里写响应逻辑
}

在这个版本中，每次OnApplyTemplate被调用时，我们都会先检查是否已经有一个按钮实例，并移除之前的事件监听。这样可以确保即使控件的模板发生变化，也不会导致内存泄露。

为了进一步提高代码的可读性和可维护性，我们可以将事件的注册和反注册逻辑封装到属性中。这样可以避免在OnApplyTemplate方法中重复相同的代码。

protected const string PART_ViewButton = nameof(PART_ViewButton);
private Button btnView = null;

public Button ViewButton
{
    get
    {
        return btnView;
    }
    set
    {
        // 先反注册事件
        if (btnView != null)
        {
            btnView.Click -= BtnView_Click;
        }

        btnView = value;

        if (btnView != null)
        {
            btnView.Click += BtnView_Click;
        }
    }
}

public override void OnApplyTemplate()
{
    base.OnApplyTemplate();
    ViewButton = GetTemplateChild(PART_ViewButton) as Button;
}

通过这种方式，我们将事件处理的逻辑封装到了属性的setter中，使得OnApplyTemplate方法更加简洁。同时，这也使得代码更容易理解和维护。

在开发XAML自定义控件时，事件处理是一个常见的需求，但同时也需要注意内存泄露的问题。通过在OnApplyTemplate方法中正确地进行事件的注册和反注册，我们可以避免内存泄露，提高应用程序的性能和稳定性。记住，良好的代码习惯和对细节的关注是写出高质量代码的关键。希望这些技巧能帮助你在开发中少走弯路，写出更优秀的XAML应用程序！