はじめに
WPFでボタンを押したときに、非同期処理を実行する場面があります。
例えば、こんな処理です。
- サーバーからデータを取得する
- ファイルを読み込む
- 設定内容を保存する
時間がかかる処理なので、async / await を使って実装しました。
private async Task SaveAsync()
{
await SaveDataAsync();
}
これで、処理中も画面が固まらなくなりました。
ところが、実際に操作してみると……。
保存ボタンを連続して押したら、保存処理が2回実行されてしまった。
「await で待っているのに、なぜもう一度実行されるの?」
そんな疑問を持ったことはないでしょうか。
今回は、非同期処理中に同じ処理が再び呼び出される「再入」という問題について、WPF・MVVMを例に整理していきます。
1. awaitで待っているのに、なぜ二重実行される?
まずは、WPFのボタンクリックイベントを見てみましょう。
private async void SaveButton_Click(
object sender,
RoutedEventArgs e)
{
Console.WriteLine("保存開始");
await Task.Delay(3000);
Console.WriteLine("保存完了");
}
※ Task.Delay() は、時間のかかる非同期処理を再現するためのものです。
保存ボタンを押すと、3秒後に「保存完了」と表示されます。
では、このボタンを1秒間隔で2回押すとどうなるでしょうか。
実行結果は、次のようになります。
保存開始
保存開始
保存完了
保存完了
保存処理が、2回開始されています。
awaitは画面操作を止めない
await Task.Delay(3000) に到達すると、非同期処理の完了を待つ間、UIスレッドはほかの処理を実行できる状態になります。
そのため、画面は固まらず、ボタン操作も受け付けられます。
つまり、最初の保存処理が待機している間に、もう一度ボタンを押せるのです。
時間 →
1回目のクリック
保存開始 ───── await中 ───── 保存完了
↑
2回目のクリック │
保存開始 ───── await中 ───── 保存完了
ここで重要なのは、次の点です。
await は非同期処理の完了を待つ仕組みであって、同じ処理が再び呼ばれることを防ぐ仕組みではありません。
このように、前の処理が完了する前に同じ処理へ再び入ることを「再入」と呼びます。
非同期処理中の再操作を防ぎたい場合は、別途制御が必要になります。
2. IsExecutingで二重実行を防ぐ
最も分かりやすい方法の一つが、処理を実行中かどうかを表すフラグを用意することです。
ここでは、_isExecuting というフラグを使います。
private bool _isExecuting;
private async Task SaveAsync()
{
if (_isExecuting)
{
return;
}
_isExecuting = true;
try
{
Console.WriteLine("保存開始");
await Task.Delay(3000);
Console.WriteLine("保存完了");
}
finally
{
_isExecuting = false;
}
}
処理の流れは次のとおりです。
-
_isExecutingがtrueなら、すでに実行中なので何もしない - 実行していなければ
trueにする - 保存処理を実行する
- 処理終了時に
falseに戻す
これにより、保存処理中にもう一度 SaveAsync() が呼び出されても、2回目の処理は開始されません。
なぜfinallyを使うの?
次のように書くこともできます。
_isExecuting = true;
await SaveDataAsync();
_isExecuting = false;
しかし、SaveDataAsync() で例外が発生すると、最後の _isExecuting = false が実行されない可能性があります。
その結果、実行中の状態が残り、次回以降の保存処理を開始できなくなってしまいます。
そこで、try-finally を使います。
_isExecuting = true;
try
{
await SaveDataAsync();
}
finally
{
_isExecuting = false;
}
finally は、正常終了した場合だけでなく、例外が発生した場合にも実行されます。
実行状態のように、処理終了時に必ず戻す必要があるものは、finally で管理することが重要です。
なお、このフラグによる方法は、WPFのUIスレッド上で、チェックからフラグ設定までを同期的に実行することを前提としています。
複数スレッドから同時に呼ばれる可能性がある場合は、SemaphoreSlim などの排他制御も検討する必要があります。
3. 二重実行を防ぐだけでなく、ボタンも無効にしたい
第2章の方法では、二重実行そのものは防げます。
しかし、画面上の保存ボタンは押せるままです。
ユーザーから見ると、押したのに何も起こらない状態になります。
そこで、処理中はボタンを無効にすることを考えます。
保存前
実行中:false
保存ボタン:有効
保存中
実行中:true
保存ボタン:無効
保存完了
実行中:false
保存ボタン:有効
これなら、処理中に保存ボタンを押せないことが、画面上でも分かります。
WPF・MVVMでは、Commandの実行可否を利用して、ボタンの有効・無効を切り替えることができます。
CanExecuteとは?
WPFのCommandには、実行できるかどうかを判断する CanExecute という仕組みがあります。
CanExecute が false になると、そのCommandにバインドされたボタンは無効になります。
ただし、通常の ICommand は、非同期処理の実行状態を自動的に管理するわけではありません。
そこで、非同期処理に対応したCommandを利用すると、実装を簡潔にできます。
4. MVVMではAsyncRelayCommandを使う
今回は、CommunityToolkit.Mvvm の AsyncRelayCommand を使ってみます。
AsyncRelayCommand は、async Task を返す非同期メソッドをCommandとして実行するためのクラスです。
さらに、既定では同じCommandの同時実行を許可しないため、今回のような二重実行防止にも利用できます。
① CommunityToolkit.Mvvmを追加する
まず、WPFプロジェクトにNuGetパッケージを追加します。
CommunityToolkit.Mvvm
Visual Studioの「NuGetパッケージの管理」からインストールできます。
今回のサンプルでは、次の3つのファイルを使用します。
SampleApp
├─ MainWindow.xaml
├─ MainWindow.xaml.cs
└─ MainViewModel.cs
※ SampleApp はプロジェクト名の例です。実際のプロジェクト名に合わせて名前空間を変更してください。
② ViewModelを実装する
まず、MainViewModel.cs を作成します。
using CommunityToolkit.Mvvm.Input;
using System;
using System.Threading.Tasks;
namespace SampleApp;
public class MainViewModel
{
public IAsyncRelayCommand SaveCommand { get; }
public MainViewModel()
{
SaveCommand = new AsyncRelayCommand(SaveAsync);
}
private async Task SaveAsync()
{
try
{
Console.WriteLine("保存開始");
await Task.Delay(3000);
Console.WriteLine("保存完了");
}
catch (Exception ex)
{
Console.WriteLine($"保存失敗: {ex.Message}");
}
}
}
注目してほしいのは、この部分です。
SaveCommand = new AsyncRelayCommand(SaveAsync);
SaveAsync は、Task を返す非同期メソッドです。
AsyncRelayCommand に渡すことで、非同期処理をCommandとして実行できるようになります。
ここでは、_ = SaveAsync() のように完了を待たずに呼び出すコードを自分で書く必要はありません。
AsyncRelayCommand が、非同期処理の実行状態を管理します。
③ XAMLでボタンにバインドする
次に、MainWindow.xaml を設定します。
<Window x:Class="SampleApp.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
Title="非同期Commandのサンプル"
Height="200"
Width="350">
<Grid>
<Button Content="保存"
Width="120"
Height="40"
Command="{Binding SaveCommand}" />
</Grid>
</Window>
ボタンの Command プロパティに、ViewModelの SaveCommand をバインドしています。
続いて、MainWindow.xaml.cs で DataContext を設定します。
using System.Windows;
namespace SampleApp;
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
DataContext = new MainViewModel();
}
}
これで、保存ボタンを押すと SaveAsync() が実行されます。
④ 実際の動作
実行すると、次のように動作します。
保存前
保存ボタン:有効
ボタン押下
保存開始
保存ボタン:無効
3秒後
保存完了
保存ボタン:有効
AsyncRelayCommand は、既定では実行中の再実行を許可しません。
そのため、保存処理が実行中の間は CanExecute が false になり、ボタンも無効になります。
処理が完了すると、再びボタンが有効になります。
第2章では _isExecuting フラグを自分で管理しましたが、今回のサンプルでは必要ありません。
AsyncRelayCommandが実行状態を管理してくれるためです。
⑤ IsRunningで実行中かどうかも分かる
AsyncRelayCommand には、処理が実行中かどうかを表す IsRunning プロパティもあります。
例えば、画面に「保存中...」と表示したい場合にも利用できます。
<TextBlock Text="保存中..."
Visibility="{Binding SaveCommand.IsRunning,
Converter={StaticResource BoolToVisibilityConverter}}" />
※この例を使用する場合は、bool値を Visibility に変換するコンバーターを別途定義する必要があります。ボタンの二重実行防止だけなら不要です。
⑥ 処理側の再入防止も必要?
ここまでの例では、Command経由の二重実行を防げます。
ただし、SaveAsync() がCommand以外の経路からも呼び出される設計の場合は、Commandの実行制御だけでは十分とは限りません。
そのような場合は、第2章で紹介した _isExecuting のような状態管理を、処理側にも用意することを検討します。
つまり、次のように考えると分かりやすくなります。
- Commandの実行制御:ボタンなどからの再操作を防ぐ
- 処理側の再入防止:Command以外の呼び出し経路にも備える
どちらが必要かは、処理の呼び出し方によって変わります。
5. async voidとの違いにも注意する
WPFのイベントハンドラでは、次のように async void を使うことがあります。
private async void SaveButton_Click(
object sender,
RoutedEventArgs e)
{
await SaveAsync();
}
イベントハンドラは戻り値が void と決められているため、これは一般的な使い方です。
一方、通常の非同期メソッドでは、基本的に async Task を使用します。
private async Task SaveAsync()
{
await SaveDataAsync();
}
async Task なら、呼び出し元が完了を待ったり、例外を扱ったりできます。
今回の AsyncRelayCommand も、Task を返す非同期メソッドを受け取ります。
そのため、ViewModel側の非同期処理を async void にする必要はありません。
なお、AsyncRelayCommand を使えば例外処理が不要になるわけではありません。
今回のサンプルでは SaveAsync() 内で例外を捕まえていますが、実際のアプリケーションでは、エラー表示やログ出力など、適切な処理を行う必要があります。
async void の例外処理については、以前の記事でも詳しく解説しています。
6. 実務で気をつけたいポイント
① すべての処理を二重実行禁止にする必要はない
例えば、検索ボタンを押した場合です。
ユーザーが検索条件を変更して再度検索したとき、古い検索処理の完了を待つよりも、新しい検索を優先したい場合があります。
このような処理では、単純に二重実行を禁止するのではなく、前の処理をキャンセルするなど、別の設計が必要になることがあります。
つまり、再入を禁止するべきかどうかは、処理の目的によって変わります。
② 保存処理では二重実行の影響を考える
保存や登録、課金などの処理では、二重実行によって同じデータが重複登録されるなどの問題が起こる可能性があります。
そのため、UI側で再入を防ぐことは重要です。
ただし、UI側だけで完全に防げるとは限りません。
通信の再送や複数端末からの操作も考えられるため、必要に応じてサーバー側でも重複処理を防ぐ仕組みを用意します。
③ 処理終了時の状態復元を忘れない
保存処理が正常終了した場合だけでなく、失敗した場合やキャンセルされた場合も考える必要があります。
実行状態が戻らないと、ボタンが無効のままになることがあります。
手動で実行状態を管理する場合は、finally にまとめておくと安全です。
一方、今回の AsyncRelayCommand のように、実行状態を管理してくれる仕組みを使う方法もあります。
7. まとめ
今回のポイントを整理します。
| ポイント | 内容 |
|---|---|
await |
非同期処理の完了を待つが、再入は自動的に防がない |
| 再入 | 前の処理が完了する前に、同じ処理が再び呼び出されること |
_isExecuting |
手動で実行状態を管理するためのフラグ |
try-finally |
例外発生時にも実行状態を戻す |
CanExecute |
Commandの実行可否を制御する |
AsyncRelayCommand |
非同期処理の実行状態を管理し、既定では同じCommandの同時実行を防ぐ |
async / await を使えば、時間のかかる処理中でも画面操作を受け付けられます。
これは非同期処理の大きな利点です。
しかし、画面操作を受け付けられるということは、前の処理が終わる前に、同じ処理がもう一度呼び出される可能性があるということでもあります。
最後に、今回覚えておきたいことは3つです。
awaitは再入を防ぐ仕組みではない。- 二重実行を防ぐには、実行状態を管理する必要がある。
- WPF・MVVMでは、非同期対応Commandを利用することで、実行状態とボタンの操作可否を管理できる。
非同期処理を書くときは、「処理中にもう一度操作されたらどうなるか?」も考えてみてください。
関連記事
C#の非同期処理やWPFについて、こちらの記事でも解説しています。
-
awaitは待つのに、なぜ画面は止まらないの?
async/awaitの基本的な仕組みを理解したい方へ。 -
async voidはなぜ避けた方がいいの?
非同期処理の例外処理と、イベントハンドラの違いを整理したい方へ。 -
WPFで「なぜか2回動く…」を解決する|イベント多重実行の典型パターン3選
イベントの多重登録など、別の原因で処理が複数回実行されるケースを知りたい方へ。