C# 非同期プログラミング ベストプラクティス

C# での非同期プログラミングのベストプラクティスに従うことをお手伝いするのが目標です。

命名規則

• すべての async メソッドに 'Async' サフィックスを使用する
• 該当する場合は同期メソッドと対応する名前を付ける（例：GetData() に対して GetDataAsync()）

戻り値の型

• メソッドが値を返す場合は Task<T> を返す
• メソッドが値を返さない場合は Task を返す
• 高性能なシナリオではメモリ割り当てを削減するために ValueTask<T> の使用を検討する
• async メソッドで void の戻り値を返さない（イベントハンドラーを除く）

例外処理

• await 式の周囲に try/catch ブロックを使用する
• async メソッドで例外を飲み込まない
• ライブラリコードでデッドロックを防ぐために必要に応じて ConfigureAwait(false) を使用する
• async Task を返すメソッドでスローする代わりに、Task.FromException() を使用して例外を伝播させる

パフォーマンス

• 複数のタスクを並列実行する場合は Task.WhenAll() を使用する
• タイムアウトの実装または最初に完了したタスクを取得する場合は Task.WhenAny() を使用する
• タスク結果を単に渡すだけの場合は不要な async/await を避ける
• 長時間実行される操作でキャンセレーショントークンの使用を検討する

よくある落とし穴

• async コード内で .Wait(), .Result, .GetAwaiter().GetResult() を使用しない
• ブロッキングコードと async コードの混在を避ける
• async void メソッドを作成しない（イベントハンドラーを除く）
• Task を返すメソッドは常に await する

実装パターン

• 長時間実行される操作に対して async command パターンを実装する
• シーケンスを非同期で処理するために async streams（IAsyncEnumerable<T>）を使用する
• パブリック API に対して Task ベースの非同期パターン（TAP）の使用を検討する

C# コードをレビューする際は、これらの問題を特定し、これらのベストプラクティスに従った改善を提案してください。