AvalonDock DocumentContent 没有被垃圾收集

Question

我创建了一个使用 AvalonDock 框架的应用程序。一个关键部分是使用AvalonDock.DocumentContent 派生编辑器编辑域模型实体的能力。我遇到了一个问题，发现我的编辑器在关闭并从 DockingManager.Documents 集合中删除后没有被垃圾回收。

经过一番徒劳的搜索后，我创建了一个可以通过以下方式重新创建的小型测试应用程序：

• 在 Visual Studio（我使用的是 2008）中，创建一个名为 AvalonDockLeak 的新 WPF 应用程序；
• 添加对AvalonDock库的引用（我的版本是1.3.3571.0）；
• 添加一个名为Document 的新用户控件；

• 将 Document.xmal 更改为：

  <ad:DocumentContent x:Class="AvalonDockLeak.Document"
                      xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                      xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                      xmlns:ad="clr-namespace:AvalonDock;assembly=AvalonDock">
      <Grid>
          <TextBox />
      </Grid>
  </ad:DocumentContent>
  

• 将 Document.xmal.cs 更改为：

  namespace AvalonDockLeak
  {
      using AvalonDock;
  
      public partial class Document : DocumentContent
      {
          public Document()
          {
              InitializeComponent();
          }
  
          ~Document()
          {
          }
      }
  }
  

  我添加的析构函数能够诊断问题，在打开 { 的方法上添加断点，并查看它是否被命中。它总是在关闭测试应用程序时这样做，但不是更早。

• 现在将 Window1.xaml 更改为：

  <Window x:Class="AvalonDockLeak.Window1"
          xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
          xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
          xmlns:ad="clr-namespace:AvalonDock;assembly=AvalonDock"
          Title="Memory Leak Test" Height="300" Width="300">
      <Grid>
          <Grid.RowDefinitions>
              <RowDefinition Height="Auto" />
              <RowDefinition />
          </Grid.RowDefinitions>
          <Button Name="NewButton" Click="NewButton_Click" Content="New" Height="26" Width="72" />
          <ad:DockingManager x:Name="DockManager" Grid.Row="1">
              <ad:DocumentPane />
          </ad:DockingManager>
      </Grid>
  </Window>
  

• 将 Window1.xaml.cs 更改为：

  namespace AvalonDockLeak
  {
      using System.Windows;
  
      public partial class Window1 : Window
      {
          private int counter = 0;
  
          public Window1()
          {
              InitializeComponent();
          }
  
          private void NewButton_Click(object sender, RoutedEventArgs e)
          {
              string name = "Document" + (++this.counter).ToString();
              var document = new Document()
              {
                  Name = name,
                  Title = name,
                  IsFloatingAllowed = false
              };
  
              document.Show(this.DockManager);
              document.Activate();
          }
      }
  }
  

这个简单的应用程序也包含泄漏。这可以通过~Document() 开头的断点观察到{关闭DocumentContent 后没有被命中。

现在我想要的是，这是一个已知问题吗？有没有办法防止它？如果对象只是在很长一段时间后才被垃圾收集，那么我能做些什么来加快这一点？顺便说一下，调用 GC.Collect() 也无济于事。

Answer 1

显然，您的 DocumentContent 的引用由事件处理程序保存在某处。你应该使用像微软的CLR-Profiler 这样的内存分析器来确定原因。

您应该注意始终取消注册已注册的活动。否则你会得到内存泄漏。为此，您可以使用 -= 运算符。

Answer 2

DocumentContent 默认在关闭时隐藏，这意味着引用保持活动状态。

如果您希望 DocumentContent 关闭并随后处置，您需要在派生的 DocumentConcent 中指定几个属性或修改 AvalonDock 源。

        this.IsCloseable = true;
        this.HideOnClose = false;

现在关闭时，它会处理引用而不是挂在它上面，因为它只是被隐藏了。

Answer 3

我强烈建议您和任何使用 AvalonDock 1.3 的人升级到 2.0 版。 最新版本是 MVVM 友好的，不会遇到这个问题（文档和锚点被正确地垃圾收集）。 更多信息：avalondock.codeplex.com

谢谢

Answer 4

我在这个方向上也遇到了问题。关闭选项卡会导致内存泄漏。我用分析器检查了它，结果发现 ActiveContent 仍然会保留引用，从而阻止 GarbageCollector 启动。

我关闭标签的代码：

dc // DocumentContent, I want to close it
documentPane // DocumentPane, containing the dc

documentPane.Items.Remove(dc);

这完成了关闭选项卡的工作，但得知我需要调用

dc.Close();

如果我希望将 ActiveContent 设置为 null 并让 GC 完成工作，则在从 documentPane 中删除内容之前。

注意：我使用的是 1.2 版的 AvalonDock，这可能在新版本中有所改变。

Answer 5

这看起来像是一个长期未解决的错误...：

http://avalondock.codeplex.com/workitem/9113