top of page

C#開発でのCommunityToolkit.Mvvmの便利機能について

執筆者の写真: あどりら
あどりら
11月10日
読了時間: 4分

こんにちは、あどりらです。


はじめに

最近WPF開発で使用しているCommunityToolkit.Mvvmのバージョンを8.0から8.4へ更新しました。追加された機能を確認すると便利機能が追加されていましたのでメモ代わりに紹介をしていこうと思います。



開発環境

開発言語:C# .net10

開発エディタ:Visual Studio

使用ライブラリ:CommunityToolkit.Mvvm 8.4.2



public partial プロパティ宣言

これまでは以下のように、プライベートフィールドに属性を付けたりして裏でジェネレータにパブリックプロパティを作らせる仕様でした。

記述先から定義移動しようとすると生成された中間ファイルに飛んでしまい元の宣言へ戻るのが不便でした。

また、宣言からも参照先が分かりませんでした。



新機能はpublicにpartialプロパティとして直接記述できるため、従来のフィールド定義では扱いにくかった C# の構文機能がそのまま使えます。

また、定義移動はプロパティ宣言行に直接移動でき、コードナビゲーション、リファクタリングが劇的にやりやすくなりました。




ObservablePropertyの変更フック強化

以前は変更後の値しか取得できませんでした。



最新のバージョンでは変更前の値(oldValue)を受け取れるようになりました。




RelayCommand のオプション強化

1.キャンセル用コマンドの自動生成と状態同期

非同期メソッドに CancellationToken を引数として持たせ、IncludeCancelCommand = true を指定すると、メインのコマンドに加えてキャンセル実行用の専用コマンド(Cancel<MethodName>Command)が自動生成されます。

また、XAML 側で「実行ボタン」と「キャンセルボタン」の有効・無効を、バインディングだけで完全連動させることが可能になります。


・コード


・XAML



2.同時実行制御の排他安定化

非同期コマンドの連打による多重実行を防ぐオプションになります。(デフォルトは false)

ボタンを高速連打した場合でも、内部状態の不整合や二重送信のリスクを確実に防ぐ内部同期ロジックに強化されています。




3.バックグラウンド例外伝播

非同期コマンド内でキャッチされなかった例外を、UI スレッドをクラッシュさせずに

TaskScheduler.UnobservedTaskException へ安全に流すためのオプションです。

通常の async void 相当のクラッシュ挙動を回避し、アプリケーション全体のバックグラウンドエラー監視パイプラインとシームレスに結合できるよう例外再スローのパスが整備されました。




4.CanExecute と NotifyCanExecuteChangedFor の診断強化

コマンドの実行可否をプロパティと連動させる仕組みにおいて、ミスを防止するアナライザーが拡充されました。

CanExecute に指定したメソッドのシグネチャ(引数や戻り値)が一致しているかを静的解析し、コンパイル時に専用アナライザーが検知してエラーを報告するようになりました。



・RelayCommand 主要オプション一覧


オプション

型

概要

CanExecute

string? (null)

実行可否を判定するメソッド名またはプロパティ名をバインド

AllowConcurrentExecutions

bool (false)

非同期処理の同時並行実行を許可するかどうか(連打防止)

IncludeCancelCommand

bool (false)

キャンセル用コマンド

(Cancel<Name>Command)を

自動生成

FlowExceptionsToTaskScheduler

bool (false)

未処理例外を

TaskScheduler.UnobservedTaskException に流す



MVVMのアナライザーが大量に追加

MVVMTK0041~0055などが追加され、間違ったMVVMコードがコンパイル時に検出されるようになりました。

開発時にエラーの修正がしやすくなります。



まとめ

一番の改善点は、public な partial プロパティとして直接記述できるようになったことです。

これにより、Visual Studio 上での「定義へ移動」や参照の確認、リファクタリングが格段にスムーズになり、開発体験が非常に快適になりました。


また、MVVM 関連の記述ミスをコンパイル時に検知できるようになった点も大きな進化だと感じています。従来はデバッグ実行して初めてエラーに気づき、「こんなところに原因があったのか」と驚く場面が何度もありました。


これらの新機能をうまく活用し、より堅牢で保守しやすいコードを構築していきたいです。



参照リンク




コメント


この投稿へのコメントは利用できなくなりました。詳細はサイト所有者にお問い合わせください。
bottom of page