发布和订阅消息

重要

MessagingCenter 在 .NET 10 中已弃用。 建议从 CommunityToolkit.Mvvm 包迁移到WeakReferenceMessenger，或使用具有简单方案弱引用的事件。 有关详细信息，请参阅 Messenger。

MessagingCenter 是一种方便的 API，用于实现发布-订阅模式，而无需在发布服务器和订阅服务器之间直接引用。 在 .NET 10 及更高版本中，应首选以下项之一：

• 用于分离、可测试的基于消息的通信的 CommunityToolkit.Mvvm WeakReferenceMessenger 。
• 用于本地通信的常规 .NET 事件，最好是 WeakEventManager 避免内存泄漏。

迁移到 WeakReferenceMessenger

Toolkit messenger 使用强类型邮件和对收件人的弱引用。 最少的迁移如下所示：

1. 将 CommunityToolkit.Mvvm 包添加到项目。 在项目文件中（.csproj）：

   <ItemGroup>
     <PackageReference Include="CommunityToolkit.Mvvm" Version="8.*" />
   </ItemGroup>
   

2. 定义消息类型（可选）发送单个有效负载值时使用 ValueChangedMessage<T> ）：

   using CommunityToolkit.Mvvm.Messaging.Messages;
   
   public sealed class HiMessage : ValueChangedMessage<string>
   {
       public HiMessage(string name) : base(name) { }
   }
   

3. 从发布者发送消息：

   using CommunityToolkit.Mvvm.Messaging;
   
   // Send without a direct reference to any recipients
   WeakReferenceMessenger.Default.Send(new HiMessage("John"));
   

4. 接收收件人中的邮件：

   • 实现 IRecipient<TMessage> 并注册信使，或
   • 继承 ObservableRecipient 并启用接收。

   using CommunityToolkit.Mvvm.Messaging;
   using CommunityToolkit.Mvvm.Messaging.Messages;
   
   public sealed class GreetingViewModel : IRecipient<HiMessage>
   {
       public GreetingViewModel()
       {
           // Register this instance to receive HiMessage notifications
           WeakReferenceMessenger.Default.Register(this);
       }
   
       public void Receive(HiMessage message)
       {
           var name = message.Value; // "John"
           // Handle the message (e.g., update state)
       }
   
       // Call this when the recipient is disposed/no longer needed
       public void Unregister()
       {
           WeakReferenceMessenger.Default.Unregister<HiMessage>(this);
       }
   }
   

映射常见的 MessagingCenter 模式

• 无有效负载发送： MessagingCenter.Send<TSender>(sender, message) →定义空消息类型（无有效负载）和 Send(new MyMessage())。
• 使用有效负载发送： MessagingCenter.Send<TSender, TArgs>(sender, message, args) →使用 ValueChangedMessage<TArgs> 或具有属性的自定义消息。
• 订阅回调： MessagingCenter.Subscribe<TSender>(subscriber, message, callback) →实现 IRecipient<TMessage> 和注册;方法是 Receive 回调。
• 取消订阅： MessagingCenter.Unsubscribe → WeakReferenceMessenger.Default.Unregister<TMessage>(recipient)。

何时改用事件

对于简单的本地通信（例如，控件与其父级之间），标准 .NET 事件通常足够。 若要降低长期发布者内存泄漏的风险，请使用 WeakEventManager：

public class Counter
{
    readonly Microsoft.Maui.WeakEventManager _weakEventManager = new();

    public event EventHandler<int> CountChanged
    {
        add => _weakEventManager.AddEventHandler(value);
        remove => _weakEventManager.RemoveEventHandler(value);
    }

    int _count;
    public void Increment()
    {
        _count++;
        _weakEventManager.HandleEvent(this, _count, nameof(CountChanged));
    }
}

小窍门

如果已在 CommunityToolkit 中使用 MVVM， ObservableRecipient 则可以在设置时 IsActive 自动管理注册生存期。