mvvm-toolkit-messenger

CommunityToolkit.Mvvm Messenger

ViewModel（または任意のオブジェクト）間で、共有参照グラフを強制することなくパブリッシュ／サブスクライブ方式のメッセージングを行います。CommunityToolkit.Mvvm 8.x の一部です。

要約。 既定では WeakReferenceMessenger.Default を使用します。(recipient, message) ラムダと static 修飾子を使ってハンドラーを登録し、this をキャプチャしないようにします。ObservableRecipient を継承し、アクティブ化／非アクティブ化時に IsActive を切り替えると、登録と登録解除が自動的に行われます。

---

このスキルを使用する場面

• 互いの参照を保持せずに、2つ以上の ViewModel がイベント（ログイン、テーマ変更、保存、ナビゲーション）に反応する必要がある場合
• ある ViewModel が別の VM に値を要求する必要がある場合（リクエスト／返信）
• チャネル トークンでイベントの範囲をサブシステムまたはウィンドウに限定する場合
• 「ハンドラーがまったく呼び出されない」問題や、弱参照の受信者のライフタイムに関する問題を診断する場合

ソースジェネレーター、基底クラス、コマンドについては、mvvm-toolkit スキルを参照してください。DI の設定（IMessenger インスタンスの登録）については、mvvm-toolkit-di を参照してください。

---

実装を選択する

型	使用する場面
WeakReferenceMessenger.Default	既定。 受信者は弱参照で保持されるため、登録中でも GC の対象になります。内部のトリミングはフル GC 時に実行されるため、手動で Cleanup() を呼び出す必要はありません。
StrongReferenceMessenger.Default	プロファイラーでメッセンジャーがホットスポットとなっており、割り当てが問題になる場合。受信者は Unregister するまで固定されます。登録解除を忘れるとメモリリークが発生します。
カスタム IMessenger インスタンス	ウィンドウ単位またはスコープ単位（例：アプリのウィンドウごとに1つのメッセンジャー）。直接構築し、DI 経由で注入します。

ObservableRecipient のパラメーターなしコンストラクターは WeakReferenceMessenger.Default を使用します。別の IMessenger を コンストラクターに渡すと、既定値を上書きできます。

---

メッセージを定義する

ツールキットには基底クラスが用意されていますが、どのクラスでも使用できます。

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;

---

受信者を登録する

ラムダ形式（推奨）

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

static 修飾子を使うと、意図しないクロージャーの割り当てを防ぎ、ラムダから this を参照しないようにできます。代わりに recipient パラメーターを使います。

IRecipient<TMessage> インターフェイス形式

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

ObservableRecipient.OnActivated() は Messenger.RegisterAll(this) を呼び出し、 その型が実装するすべての IRecipient<T> インターフェイスを登録します。 ObservableRecipient を使用しない場合は、手動で登録します。

WeakReferenceMessenger.Default.RegisterAll(this);

---

メッセージを送信する

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

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

---

チャネル（トークン）

トークン（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);

トークンなしで送信されたメッセージは、既定の共有チャネルを使用します。 チャネルを指定して登録された受信者には配信されません。

---

リクエスト／返信

受信者が送信者に値を返す、問い合わせ形式のシナリオでは、 RequestMessage<T> ファミリーを使用します。

同期リクエスト

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>();

CurrentUserRequest から User への暗黙的な変換は、どの受信者も Reply を 呼び出していない場合に例外をスローします。最初にメッセージを取得して確認します。

var request = WeakReferenceMessenger.Default.Send<CurrentUserRequest>();
if (request.HasReceivedResponse)
    User user = request.Response;

非同期リクエスト

public sealed class CurrentUserRequest : AsyncRequestMessage<User> { }

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

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

コレクションリクエスト（ファンイン）

CollectionRequestMessage<T> と AsyncCollectionRequestMessage<T> は、 応答したすべての受信者からの Reply を収集します。

public sealed class OpenDocumentsRequest : CollectionRequestMessage<Document> { }

var docs = WeakReferenceMessenger.Default.Send<OpenDocumentsRequest>();
foreach (Document doc in docs) { /* ... */ }

---

ライフサイクル

WeakReferenceMessenger を使用していても、受信者の破棄時には明示的に登録解除してください。 無効になったエントリがトリミングされ、パフォーマンスが向上します。

WeakReferenceMessenger.Default.Unregister<ThemeChangedMessage>(this);
WeakReferenceMessenger.Default.Unregister<ThemeChangedMessage, int>(this, LeftPaneChannel);
WeakReferenceMessenger.Default.UnregisterAll(this);

ObservableRecipient.OnDeactivated() は、IsActive が false に切り替わると 自動的に登録解除を行います。アクティブ化フックで値を設定します。

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    base.OnNavigatedTo(e);
    ViewModel.IsActive = true;
}

protected override void OnNavigatedFrom(NavigationEventArgs e)
{
    ViewModel.IsActive = false;
    base.OnNavigatedFrom(e);
}

---

よくある落とし穴

1. ラムダで this をキャプチャする。 (r, m) => OnX(m) は暗黙的に this をキャプチャし、クロージャーを割り当てて、ライフタイムを分かりにくくします。必ず static を付けて (r, m) => r.OnX(m) を使います。
2. Unregister を使わずに受信者を強参照する。 StrongReferenceMessenger では、受信者（およびそのオブジェクトグラフ全体）が 永久に保持されます。ObservableRecipient を継承する（OnDeactivated で自動的に登録解除されます）か、UnregisterAll(this) を呼び出します。
3. 継承されたメッセージ型。 BaseMessage に登録されたハンドラーは、 DerivedMessage : BaseMessage に対しては呼び出されません。具象型ごとに登録してください。
4. 誤ったメッセンジャーインスタンス。 WeakReferenceMessenger.Default で送信し、 ウィンドウごとに注入されたメッセンジャーで登録すると、メッセージは届きません。同じ IMessenger を どこでも使います（通常は ObservableRecipient(messenger) を介して注入します）。
5. OnActivated が実行されない。 ObservableRecipient は、IsActive が false から true に切り替わったときにのみ、 IRecipient<T> ハンドラーを登録します。
6. スレッドをまたぐ更新。 メッセンジャーはスレッドに依存しません。ハンドラーが UI を更新する場合は、手動で UI スレッドに処理を振り分けます （DispatcherQueue.TryEnqueue / Dispatcher.BeginInvoke）。

---

複数のメッセンジャー（ウィンドウごとのスコープ）

services.AddSingleton<IMessenger>(WeakReferenceMessenger.Default); // app-wide
services.AddScoped<WindowScopedMessenger>();                       // per-window

適切な IMessenger を ViewModel のコンストラクターに注入します。

public sealed partial class WindowViewModel(IMessenger messenger)
    : ObservableRecipient(messenger) { }

これにより、ブロードキャストを単一のウィンドウに限定できます。複数ウィンドウの デスクトップアプリ（WinUI 3、WPF、MAUI desktop、Avalonia）で役立ちます。

---

参考資料

トピック	ファイル
詳細な解説（チャネルやライフサイクルの例、診断）	references/messenger-patterns.md

外部資料：

• メッセンジャーのドキュメント：https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/messenger
• WeakReferenceMessenger API：https://learn.microsoft.com/en-us/dotnet/api/communitytoolkit.mvvm.messaging.weakreferencemessenger
• ソース：https://github.com/CommunityToolkit/dotnet