WeakEventManager保存订阅者的引用。

6

我一直在使用WeakEventManager来避免内存泄漏,但是我开始过度使用它们了。 例如,我为INotifyPropertyChanged创建了扩展方法:


public static void AddWeakPropertyChanged(this INotifyPropertyChanged item, Action handler)
{
    PropertyChangedEventManager.AddHandler(item, (s, e) => handler(e.PropertyName), string.Empty);
}

现在我很快意识到这样做是不起作用的。实际上,您不能真正使用匿名方法来进行弱事件处理。(如果我理解正确的话,编译器会为它创建一个'闭包类'(来保存引用的值),其中包含处理程序,但由于您的闭包类没有在任何地方引用,GC将清除它,并且事件处理程序将不会被调用)。
问题#1:这是正确的吗?我的意思是说,当使用匿名方法(或lambda)作为弱事件处理程序时,只有在GC未运行的同时(例如,它是不确定的)才会调用处理程序?
嗯,我认为是这样的,所以我进行了一些单元测试,以确保我理解得正确。在进行以下单元测试之前,它似乎都很好。

        class DidRun
        {
            public bool Value { get; set; }
        }
        class TestEventPublisher
        {
            public event EventHandler<EventArgs> MyEvent;
            public void RaiseMyEvent()
            {
                if (MyEvent != null)
                    MyEvent(this, EventArgs.Empty);

            }
        }
        class TestClosure
        {
            public DidRun didRun { get; set; }
            public EventHandler<EventArgs> Handler { get; private set; }
            public TestClosure()
            {
                this.Handler = new EventHandler<EventArgs>((s, e) => didRun.Value = true);
            }
        }
        [TestMethod]
        public void TestWeakReference()
        {
            var raiser = new TestEventPublisher();
            var didrun = new DidRun();
            var closure = new TestClosure { didRun = didrun };
            WeakEventManager<TestEventPublisher, EventArgs>.AddHandler(raiser, "MyEvent", closure.Handler);
            closure = null;

            GC.Collect();
            GC.Collect();
            raiser.RaiseMyEvent();
            Assert.AreEqual(false, didrun.Value);
        }


问题#2:有人能够解释一下为什么这个测试失败吗?
期望结果:在这里,我没有任何闭包(我将它们取出来,以确保发生了什么),我只是有一个对象(闭包),它使用WeakEventManager订阅事件,然后我放弃对它的引用(closure = null;)。
我希望两个GC.Collect()调用可以清理我的旧闭包类,因此WeakEventManager会取消订阅者并不运行处理程序,但测试失败了。有任何想法吗?
编辑:抱歉,泛型参数之前看不到,现在已经可见。
1个回答

5

您说得没错,如果没有引用,GC会收集围绕lambda创建的闭包。

在您的单元测试中,您将TestClosure的本地实例设置为null,但是您将处理程序的硬引用传递到了WeakEventManager中,而不是TestClosure的实例。 因此,处理程序仍然存在...

我相信这些示例说明了您对闭包的困扰:

class DidRun
{
    public bool Value { get; set; }
}

class TestEventPublisher
{
    public event EventHandler<EventArgs> MyEvent;
    public void RaiseMyEvent()
    {
        if (MyEvent != null)
            MyEvent(this, EventArgs.Empty);
    }
}

class TestClosure
{
    static public EventHandler<EventArgs> Register(TestEventPublisher raiser, DidRun didrun)
    {
        EventHandler<EventArgs> handler = (s, e) => didrun.Value = true;
        WeakEventManager<TestEventPublisher, EventArgs>.AddHandler(raiser, "MyEvent", handler);
        return handler;
    }
}

[TestMethod]
public void Test1()
{
    var raiser = new TestEventPublisher();
    var didrun = new DidRun();

    TestClosure.Register(raiser, didrun);

    // The reference to the closure 'handler' is not being held,
    //  it may or may not be GC'd (indeterminate result)

    raiser.RaiseMyEvent();
    Assert.IsTrue(didrun.Value);
}

[TestMethod]
public void Test2()
{
    var raiser = new TestEventPublisher();
    var didrun = new DidRun();

    // The reference to the closure 'handler' is not being held, it's GC'd
    TestClosure.Register(raiser, didrun);

    GC.Collect();
    GC.Collect();

    raiser.RaiseMyEvent();
    Assert.IsFalse(didrun.Value);
}

[TestMethod]
public void Test3()
{
    var raiser = new TestEventPublisher();
    var didrun = new DidRun();

    // Keep local copy of handler to prevent it from being GC'd
    var handler = TestClosure.Register(raiser, didrun);

    GC.Collect();
    GC.Collect();

    raiser.RaiseMyEvent();
    Assert.IsTrue(didrun.Value);
}

关于您原来的问题,您可以尝试保存处理程序(闭包)以防止其被垃圾回收。 ConditionalWeakTable 可以起到这个作用:

// ConditionalWeakTable will hold the 'value' as long as the 'key' is not marked for GC
static private ConditionalWeakTable<INotifyPropertyChanged, EventHandler<PropertyChangedEventArgs>> _eventMapping =
  new ConditionalWeakTable<INotifyPropertyChanged, EventHandler<PropertyChangedEventArgs>>();

public static void AddWeakPropertyChanged(this INotifyPropertyChanged item, Action<string> handlerAction)
{
    EventHandler<PropertyChangedEventArgs> handler;

    // Remove any existing handler for this item in case it's registered more than once
    if (_eventMapping.TryGetValue(item, out handler))
    {   
        _eventMapping.Remove(item);
        PropertyChangedEventManager.RemoveHandler(item, handler, string.Empty);
    }   

    handler = (s, e) => handlerAction(e.PropertyName);

    // Save handler (closure) to prevent GC
    _eventMapping.Add(item, handler);

    PropertyChangedEventManager.AddHandler(item, handler, string.Empty);
}

class DidRun
{
    static public string Value { get; private set; }
    public void SetValue(string value) { Value = value; }
}

[TestMethod]
public void Test4()
{
    var property = new ObservableObject<string>();

    var didrun = new DidRun();
    property.AddWeakPropertyChanged(
        (x) => 
        {
            didrun.SetValue("Property Name = " + x);
        });

    GC.Collect();
    GC.Collect();

    property.Value = "Hello World";

    Assert.IsTrue(DidRun.Value != null);
}

哇,非常感谢,我对此感到困惑,实际上我忽略了传递的值是处理程序的硬引用这一点。现在我明白了。再次感谢您的帮助!!! - MBoros
1
同样适用于本地方法,即它们也不能用作事件处理程序,基本上是出于相同的原因。 - mike

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接