その他

[C#] Invokeの正しい使い方と実装例

今回は、C#におけるInvokeの正しい使い方と実装例をご紹介します。

Invokeとは

Invokeは、UIスレッド以外のスレッドからUI要素を安全に操作するために使用されるメソッドです。

クロススレッドでUI要素にアクセスすると例外が発生する場合があるため、Invokeを使ってUIスレッド上で処理を実行する必要があります。

Invokeは同期処理を行うため、呼び出し元のスレッドは処理が完了するまで待機します。

同様のメソッドとして、非同期で処理を依頼するBeginInvokeも存在します。

Windows FormsにおけるInvokeの実装例

Windows Formsでは、コントロール(フォームやラベル、ボタンなど)を別スレッドから更新しようとすると、クロススレッド操作を警告する例外が発生する可能性があります。

この問題を回避するには、InvokeRequiredプロパティを確認し、必要に応じてInvokeを使ってUIスレッド側で処理を実行する手順を踏みます。

InvokeRequiredとInvokeを組み合わせた基本的な使い方

以下の例では、非UIスレッドからラベルのテキストを更新するメソッドを示しています。

実行結果

myLabel.Text → Hello from background thread

このコードを呼び出す際に、UpdateLabel(“Hello from background thread”);のように呼び出すと、クロススレッド例外を回避しながらラベルテキストを変更できます。

ラムダ式を使った実装例

ラムダ式を使うことで、匿名メソッドとしてコンパクトに記述できます。

実行結果

myLabel.Text → Lambda Updated

この例でも、クロススレッドによるUI操作エラーを回避できます。

WPFにおけるDispatcher.Invokeの実装例

WPFでは、Windows FormsのInvokeとは仕組みが異なるため、Dispatcherを使用します。

UIスレッドかどうかを確認する場合は、CheckAccessメソッドで確認し、必要に応じてDispatcher.Invokeを使います。

実行結果

textBlock.Text → Hello from background thread WPF

WPFの場合は、Dispatcher.InvokeやDispatcher.BeginInvokeを使い分ける点を押さえておくと、UIの更新を安全に扱うことができます。

Invokeを利用する際の注意点

Invokeを使うときには、以下の点に注意する必要があります。

  • InvokeRequired/CheckAccessのチェック:UI操作を行う前にスレッドを確認し、必要に応じてInvokeを呼び出します。
  • 同期呼び出しによるデッドロック:Invokeは同期的に処理を実行するため、処理が長引くとUIがフリーズする恐れがあります。必要に応じてBeginInvokeなども検討してください。
  • コントロールの破棄チェック:対象のコントロールが既に破棄されているとInvoke呼び出しで例外が発生する場合があります。
  • 例外処理:Invoke内部での例外は呼び出し元に伝播するため、try-catchを適切に使うことが望ましいです。
  • 更新頻度が高い場合の設計:更新が頻繁に行われる場合、専用のキューや非同期処理の最適化なども検討しましょう。

まとめ

Invokeはクロススレッド操作の回避に欠かせないメソッドです。

Windows FormsではInvokeRequiredと併用し、WPFではDispatcherを使ってUIスレッドに処理を渡します。

使い方を理解し、必要に応じてBeginInvokeなども活用することで、快適なUI更新を行うことができます。