CommunityToolkit.Mvvm Messenger

Mensagens de publicação/assinatura para ViewModels (ou quaisquer objetos) sem forçar um gráfico de referência compartilhado. Parte do CommunityToolkit.Mvvm 8.x.

RESUMO. Use WeakReferenceMessenger.Default por padrão. Registre manipuladores com a lambda (recipient, message) e o modificador static para que você nunca capture this. Herde de ObservableRecipient e alterne IsActive na ativação/desativação para obter registro/cancelamento automático.

Quando usar esta funcionalidade

• Dois ou mais ViewModels precisam reagir a um evento (login, mudança de tema, salvar, navegação) sem manter referências uns aos outros
• Um ViewModel precisa pedir um valor a outro VM (solicitar/responder)
• Você está escopando eventos para um subsistema ou janela com tokens de canal
• Diagnosticando problemas de "meu manipulador nunca é acionado" ou problemas de tempo de vida do destinatário de referência fraca

Para geradores de código-fonte, classes base e comandos, consulte a funcionalidade mvvm-toolkit. Para configuração de DI (registrar uma instância IMessenger), consulte mvvm-toolkit-di.

Escolha uma implementação

O construtor sem parâmetros de ObservableRecipient usa WeakReferenceMessenger.Default. Passe um IMessenger diferente para o seu construtor para substituir.

Definir uma mensagem

O toolkit fornece classes base; qualquer classe funciona.

using CommunityToolkit.Mvvm.Messaging.Messages;

// Single-payload broadcast
public sealed class LoggedInUserChangedMessage(User user)
    : ValueChangedMessage<User>(user);

// Custom shape (records are great for this)
public sealed record ThemeChangedMessage(AppTheme NewTheme);

// Empty signal
public sealed record RefreshRequestedMessage;

Registrar um destinatário

Estilo Lambda (recomendado)

WeakReferenceMessenger.Default.Register<MyViewModel, ThemeChangedMessage>(
    this,
    static (recipient, message) => recipient.OnThemeChanged(message.NewTheme));

O modificador static impede a alocação acidental de fechamento e mantém this fora da lambda — use o parâmetro recipient em vez disso.

Estilo de interface IRecipient<TMessage>

public sealed class MyViewModel : ObservableRecipient,
    IRecipient<ThemeChangedMessage>,
    IRecipient<RefreshRequestedMessage>
{
    public void Receive(ThemeChangedMessage message) { /* ... */ }
    public void Receive(RefreshRequestedMessage message) { /* ... */ }
}

ObservableRecipient.OnActivated() chama Messenger.RegisterAll(this), que assina cada interface IRecipient<T> implementada pelo tipo. Se você não estiver usando ObservableRecipient, registre manualmente:

WeakReferenceMessenger.Default.RegisterAll(this);

Enviar uma mensagem

WeakReferenceMessenger.Default.Send(new ThemeChangedMessage(AppTheme.Dark));

// Empty payloads use the parameterless overload:
WeakReferenceMessenger.Default.Send<RefreshRequestedMessage>();

Canais (tokens)

Escope mensagens para um subsistema ou janela com um token (qualquer valor equatable — int, string, Guid):

const int LeftPaneChannel = 1;

WeakReferenceMessenger.Default.Register<MyViewModel, RefreshRequestedMessage, int>(
    this, LeftPaneChannel,
    static (r, _) => r.RefreshLeft());

WeakReferenceMessenger.Default.Send(new RefreshRequestedMessage(), LeftPaneChannel);

Mensagens enviadas sem um token usam o canal compartilhado padrão — elas não são entregues a destinatários com escopo de canal.

Solicitar / Responder

Para cenários de "perguntar" onde um destinatário fornece um valor de volta ao remetente, use a família RequestMessage<T>.

Solicitação síncrona

public sealed class CurrentUserRequest : RequestMessage<User> { }

WeakReferenceMessenger.Default.Register<UserService, CurrentUserRequest>(
    this,
    static (r, m) => m.Reply(r.CurrentUser));

User user = WeakReferenceMessenger.Default.Send<CurrentUserRequest>();

A conversão implícita de CurrentUserRequest para User lança uma exceção se nenhum

…