MVVM light Messenger中的操作,局部变量和垃圾收集的奇怪行为

时间:2014-03-24 15:34:31

标签: c# wpf mvvm garbage-collection mvvm-light

我对MVVM Light中的Messenger系统有一个非常奇怪的问题。这很难解释,所以这里有一个小程序来证明这个问题:

using System;
using GalaSoft.MvvmLight.Messaging;

namespace TestApp
{
    class Program
    {
        static void Main(string[] args)
        {
            var prog = new Program();
            var recipient = new object();

            prog.RegisterMessageA(recipient);
            prog.RegisterMessageB(recipient);

            prog.SendMessage("First Message");
            GC.Collect();
            prog.SendMessage("Second Message");
        }

        public void RegisterMessageA(object target)
        {
            Messenger.Default.Register(this, (Message msg) =>
            {
                Console.WriteLine(msg.Name + " recieved by A");
                var x = target;
            });
        }

        public void RegisterMessageB(object target)
        {
            Messenger.Default.Register(this, (Message msg) =>
            {
                Console.WriteLine(msg.Name + " received by B");
            });
        }

        public void SendMessage(string name)
        {
            Messenger.Default.Send(new Message { Name = name });
        }

        class Message
        {
            public string Name { get; set; }
        }
    }
}

如果您运行该应用程序,这是控制台输出:

First Message recieved by A
First Message received by B
Second Message received by B

如您所见,收件人A从未收到第二条消息。但是,B和A之间的唯一区别是一行:语句var x = target;。如果删除此行,A会收到第二条消息。

此外,如果您删除GC.Collect();,则A会收到第二条消息。但是,这只会隐藏问题,因为在真实程序中,垃圾收集器最终会自动运行。

为什么会这样?我假设,不知何故,如果收件人操作引用包含方法范围的变量,它会将操作的生命周期与该范围联系起来,这样一旦超出范围,就可以对其进行垃圾收集。我不明白为什么会这样。我也不明白为什么不引用定义范围变量的动作没有这个问题。

有谁能解释这里发生了什么?

2 个答案:

答案 0 :(得分:11)

好吧,我现在明白为什么会这样(我相信,无论如何)。我以较短的形式复制了它,没有使用lambda表达式,然后我将解释为什么lambdas很重要。

using System;
using GalaSoft.MvvmLight.Messaging;

class Program
{
    static void Main(string[] args)
    {
        Receiver r1 = new Receiver("r1");
        Receiver r2 = new Receiver("r2");
        var recipient = new object();

        Messenger.Default.Register<object>(recipient, r1).ShowMessage;
        Messenger.Default.Register<object>(recipient, r2).ShowMessage;

        GC.Collect();
        Messenger.Default.Send(recipient, null);
        // Uncomment one of these to see the relevant message...
        // GC.KeepAlive(r1);
        // GC.KeepAlive(r2);
    }
}

class Receiver
{
    private string name;

    public Receiver(string name)
    {
        this.name = name;
    }

    public void ShowMessage(object message)
    {
        Console.WriteLine("message received by {0}", name);
    }
}

基本上,messenger只为消息处理程序保留弱引用。 (也是收件人,但这不是问题。)更具体地说,它似乎对处理程序的目标对象有一个弱引用。它似乎并不关心委托对象本身,但目标很重要。所以在上面的代码中,当你保持Receiver时 对象存活,仍然使用将该对象作为目标的委托。但是,当允许对目标进行垃圾回收时,不使用使用该对象的处理程序。

现在让我们看看你的两个处理程序:

public void RegisterMessageA(object target)
{
    Messenger.Default.Register(target, (Message msg) =>
    {
        Console.WriteLine(msg.Name + " received by A");
        var x = target;
    });
}

此lambda表达式捕获 target参数。为了捕获它,编译器会生成一个新类 - 所以RegisterMessageA是有效的:

public void RegisterMessageA(object target)
{
    GeneratedClass x = new GeneratedClass();
    x.target = target;
    Messenger.Default.Register(x.target, x.Method);
}

private class GeneratedClass
{
    public object target;

    public void Method(Message msg)
    {
        Console.WriteLine(msg.Name + " received by A");
        var x = target;
    }
}

现在,只有委托才能使GeneratedClass的实例保持活动状态。将其与您的第二个处理程序进行比较:

public void RegisterMessageB(object target)
{
    Messenger.Default.Register(target, (Message msg) =>
    {
        Console.WriteLine(msg.Name + " received by B");
    });
}

这里没有捕获的变量,所以编译器生成的代码有点像这样:

public void RegisterMessageB(object target)
{
    Messenger.Default.Register(target, RegisterMessageB_Lambda);
}

private static void RegisterMessageB_Lambda(Message msg)
{
    Console.WriteLine(msg.Name + " received by B");
}

这是一个静态方法,因此根本没有委托目标。如果委托捕获this,则它将作为实例方法生成。但重要的是,没有必要生成额外的类...所以没有什么可以被垃圾收集。

我没有仔细研究过MvvmLight是如何做到这一点的 - 无论是只是得到了对委托的弱引用,而且CLR正在以某种特殊的方式处理它,或者是否MvvmLight是将目标与委托本身分开。无论哪种方式,我希望这能解释你所看到的行为。关于如何使用真正的代码解决您遇到的任何问题 - 基本上您需要确保对所需的任何委托目标保持强有力的引用。

编辑:好的,它现在看起来像WeakActionGeneric及其基类WeakAction。我不知道这种行为是否是期望的行为(作者),但那是负责的代码:)

答案 1 :(得分:2)

我同意,这个程序的行为真的很奇怪。

我自己尝试了,因为你已经发现问题与这一行有某种关系:

var x = target;

我不知道为什么这条线会造成任何麻烦,但您可能会考虑这种解决方法:

class Program
    {
        static void Main(string[] args)
        {
            var prog = new Program();
            var recipient = new object();

            prog.RegisterMessageA(recipient);
            prog.RegisterMessageB(recipient);

            prog.SendMessage("First Message");
            GC.Collect();
            prog.SendMessage("Second Message");
        }

        public void RegisterMessageA(object target)
        {
            Messenger.Default.Register(target, (Message msg) =>
            {
                Console.WriteLine(msg.Name + " received by A");
                var x = msg.Target;
            });
        }

        public void RegisterMessageB(object target)
        {
            Messenger.Default.Register(target, (Message msg) =>
            {
                Console.WriteLine(msg.Name + " received by B");
            });
        }

        public void SendMessage(string name)
        {
            Messenger.Default.Send(new Message { Name = name });
        }

        class Message : MessageBase //part of the MVVM Light framework
        {
            public string Name { get; set; }
        }
    }

MessageBase是MVVM Light Framework中的一个类,它提供了从消息本身检索目标的可能性。

但我不确定这是否是你想要实现的......