非同期プログラミングモデル

[アーティクル]
03/28/2023

パフォーマンスのボトルネックを回避しアプリケーション全体の応答性を向上させるために、非同期プログラミングを使用できます。ただ、非同期アプリケーションを作成する従来の方法は複雑で、プログラムの作成、デバッグ、保守が困難な場合があります。

C# では、.NET ランタイムでの非同期サポートを活用する、簡略化されたアプローチである非同期プログラミングがサポートされています。コンパイラがこれまで開発者が行っていた難しい作業を実行し、アプリケーションは同期コードに類似した論理構造を保持します。その結果、わずかな作業量で非同期プログラミングのすべての利点を得られます。

このトピックでは、非同期プログラミングをいつ、どのように使用するかの概要を紹介します。詳細と例を含むをサポートトピックへのリンクもあります。

非同期による応答性の改善

Web アクセスなど、ブロックされる可能性がある操作には、非同期が必要となります。 Web リソースへのアクセスには、遅延が発生することがあります。このような操作が同期処理内でブロックされた場合、アプリケーション全体が待機する必要があります。非同期処理では、ブロックする可能性のあるタスク終了するまで、アプリケーションは Web リソースに依存しない他の操作を続行できます。

非同期プログラミングによって応答性を向上する一般的な領域を、次の表に示します。 .NET および Windows ランタイムの API の一覧には、非同期のプログラミングをサポートするメソッドが含まれます。

アプリケーション領域	非同期メソッドがある .NET 型	非同期メソッドがある Windows ランタイム型
Web アクセス	HttpClient	Windows.Web.Http.HttpClient SyndicationClient
ファイルの処理	JsonSerializer StreamReader StreamWriter XmlReader XmlWriter	StorageFile
イメージの処理		MediaCapture BitmapEncoder BitmapDecoder
WCF プログラミング	同期操作と非同期操作

非同期性は、UI スレッドにアクセスするアプリケーションに対して特に有効です。これは、すべての UI 関連のアクティビティが一般的に 1 つのスレッドを共有するためです。同期アプリケーションでは、1 つのプロセスがブロックされるとすべてがブロックされます。アプリケーションが応答を停止するため、待機状態であるとは考えずに失敗したと結論付けることもあります。

非同期メソッドを使用すると、アプリケーションは UI に応答し続けます。たとえば、ウィンドウのサイズ変更や最小化を実行したり、アプリケーション処理の完了待たずに、アプリケーションを閉じたりできます。

非同期ベースの方法は、非同期操作を設計する場合に選択できるオプションの一覧に、自動送信に相当するものを追加します。つまり、開発者の少しの作業量で、従来の非同期プログラミングのすべての利点を取得できます。

非同期メソッドの作成が簡単

C# の async キーワードと await キーワードは、非同期プログラミングの中核です。これら 2 つのキーワードを使用すると、同期メソッドの作成とほぼ同様の容易さで、.NET Framework、.NET Core または Windows ランタイムのリソースを使用して非同期メソッドを作成できます。 async キーワードを使用して定義する非同期メソッドは、"async メソッド" として参照されます。

async メソッドの例を次に示します。コードのほとんどは、見たことのあるものと思います。

ダウンロードできる Windows Presentation Foundation (WPF) の完全な例については、「C# の async および await を使用した非同期プログラミング」を参照してください。

public async Task<int> GetUrlContentLengthAsync()
{
    using var client = new HttpClient();

    Task<string> getStringTask =
        client.GetStringAsync("https://learn.microsoft.com/dotnet");

    DoIndependentWork();

    string contents = await getStringTask;

    return contents.Length;
}

void DoIndependentWork()
{
    Console.WriteLine("Working...");
}

上のサンプルからいくつかの方法を習得できます。メソッドシグネチャから始めます。これには async 修飾子が含まれています。戻り値の型は Task<int> です (他のオプションについては "戻り値の型" セクションを参照してください)。メソッド名の末尾は Async です。メソッドの本体で、GetStringAsync により Task<string> が返されます。つまり、タスクに await を指定すると、string が与えられます (contents)。タスクを待つ前に、GetStringAsync の string に依存しない作業を実行できます。

await 演算子に特に注意してください。これは GetUrlContentLengthAsync を中断させます。

GetUrlContentLengthAsync は getStringTask が完了するまで続行できません。
その間、コントロールは GetUrlContentLengthAsync の呼び出し元に戻されます。
getStringTask が完了すると、コントロールがここに戻ります。
次に、await 演算子は getStringTask から string の結果を取得します。

return ステートメントによって整数の結果が指定されます。 GetUrlContentLengthAsync を待つメソッドは長さ値を取得します。

GetUrlContentLengthAsync に GetStringAsync を呼び出してその完了を待機する間で実行できる作業がない場合、次の 1 つのステートメントで呼び出しと待機をするようにコードを簡略化できます。

string contents = await client.GetStringAsync("https://learn.microsoft.com/dotnet");

次の特徴は、前の例を非同期のメソッドにするための概略です。

メソッドシグネチャは async 修飾子を含みます。
非同期メソッドの名前は、慣例により「Async」というサフィックスで終わります。
戻り値の型は次のいずれかになります:
- メソッドが、オペランドに TResult 型を持つステートメントを戻す場合、Task<TResult>。
- メソッドがステートメントを戻さない、またはオペランドを持たないステートメントを戻す場合、Task。
- 非同期のイベントハンドラーを作成する場合、void。
- GetAwaiter メソッドがあるその他の型。
詳細については、「戻り値の型およびパラメーター」セクションを参照してください。
メソッドには、通常は 1 つ以上の await 式があり、待機中の非同期操作が完了するまでメソッドを続行できないポイントをマークします。この間メソッドは中断し、メソッドの呼び出し元にコントロールを戻します。このトピックの次のセクションでは、中断ポイントで何が発生するかを説明します。

非同期のメソッドでは、指定のキーワードと型を使用して何を実行するかを示すと、コンパイラがその作業を引き継ぎます。作業には、中断されたメソッドの待機ポイントにコントロールが戻された場合に実行される作業を、継続的に追跡することも含まれます。ループおよび例外処理など一部のルーチンのプロセスは、従来の非同期コードによる操作が困難な場合があります。非同期のメソッドでは、同期ソリューションの場合と同様にこれらの要素を記述すると、問題が解決します。

以前のバージョンの .NET Framework での非同期性の詳細については、「TPL と従来の .NET Framework 非同期プログラミング」を参照してください。

非同期メソッドでの動作

非同期プログラミングでは理解が必要な最も重要なことは、コントロールフローがどのようにメソッドからのメソッドに移動するかということです。次の図では、このプロセスについて説明します。

図の番号は次の手順に対応しています。呼び出し元メソッドで非同期メソッドを呼び出すときに始まります。

呼び出し元メソッドで、GetUrlContentLengthAsync 非同期メソッドを呼び出して待機します。
GetUrlContentLengthAsync は HttpClient インスタンスを作成し、文字列として Web サイトのコンテンツをダウンロードする GetStringAsync 非同期メソッドを呼び出します。
GetStringAsync に何かが発生するとプロセスが中断します。 Web サイトからのダウンロード処理、または他のブロックしているアクティビティを待機する必要が考えられます。リソースのブロックを回避するために、GetStringAsync は呼び出し元の GetUrlContentLengthAsync にコントロールを戻します。

GetStringAsync は TResult が文字列である Task<TResult> を返し、GetUrlContentLengthAsync は getStringTask 変数にタスクを割り当てます。タスクには GetStringAsync への呼び出しの進行中のプロセスを表し、作業が完了すると実際の文字列値を生成するコミットメントがあります。
getStringTask が待機しないため、GetUrlContentLengthAsync は GetStringAsync からの最終結果に依存しない他の作業を続行できます。この作業は同期メソッド DoIndependentWork への呼び出しによって表されます。
DoIndependentWork は、作業を実行し、呼び出し元に戻る同期メソッドです。
GetUrlContentLengthAsync は getStringTask からの結果なしで実行できる作業を使い果たしました。 GetUrlContentLengthAsync は次に、ダウンロードする文字列の長さを計算しますが、メソッドに文字列が戻されるまで、メソッドはその値を計算できません。

そのため、GetUrlContentLengthAsync は await 演算子を使用してその進行を中断し、GetUrlContentLengthAsync を呼び出したメソッドにコントロールを戻します。 GetUrlContentLengthAsync は呼び出し元に Task<int> を返します。タスクは、ダウンロードされた文字列の長さの整数値を生成することの保証を表します。

Note

GetStringAsync (結果として getStringTask) が GetUrlContentLengthAsync がそれを待機する前に完了した場合、コントロールは GetUrlContentLengthAsync に残ります。 GetUrlContentLengthAsync を中断してから戻ることは、呼び出された非同期プロセスの getStringTask が既に完了していて、GetUrlContentLengthAsync で最終結果を待つ必要がない場合に、無駄になることがあります。

呼び出し元メソッドの内部で、処理パターンが続行されます。呼び出し元は GetUrlContentLengthAsync からの結果に依存しない他の作業をすることもあり、または直ちに待機状態になることもあります。呼び出元メソッドで GetUrlContentLengthAsync を待機し、GetUrlContentLengthAsync で GetStringAsync を待機します。
GetStringAsync が完了し、文字列の結果を生成します。文字列の結果は、GetStringAsync への呼び出しによって、意図した形式では戻されません。 (メソッドは既に手順 3 のタスクで戻されていることに注意してください)。代わりに、文字列の結果は、getStringTask メソッドの完了を表すタスク内に格納されます。 await 演算子は、getStringTask から結果を取得します。代入ステートメントは contents に取得された結果を割り当てます。
GetUrlContentLengthAsync に文字列の結果がある場合、メソッドは文字列の長さを計算できます。次に GetUrlContentLengthAsync の作業も完了し、待機しているイベントハンドラーが再開できます。トピックの最後にある完全なサンプルでは、イベントハンドラーが長さの結果の値を取得して印刷することを確認できます。非同期プログラミングの経験がない場合、同期および非同期の動作の違いを、少し時間を割いて考慮してください。同期メソッドは作業が完了すると戻されます (手順 5.) が、非同期のメソッドは、作業が中断されるとタスクの値を戻します。(手順 3. および 6.) 非同期のメソッドが最終的に作業を完了すると、タスクは完了とマークされ、結果が存在する場合はタスクに格納されます。

API の非同期メソッド

非同期のプログラミングをサポートする GetStringAsync などのメソッドがどこにあるのかということです。 .NET Framework 4.5 以降および .NET Core には、async および await で使用する多くのメンバーが含まれています。メンバー名に付記されている "Async" というサフィックスと、その戻り値の型である Task または Task<TResult> から識別できます。たとえば、System.IO.Stream のクラスには、同期メソッドの CopyTo、Read、および Write と共に、CopyToAsync、ReadAsync および WriteAsync という同期メソッドが含まれています。

Windows ランタイムにも、Windows アプリの async と await で使用できる多くのメソッドが含まれています。詳しくは、UWP 開発について「Threading and async programming」(スレッドと非同期プログラミング) を、以前のバージョンの Windows ランタイムを使用している場合は「非同期プログラミング (Windows ストアアプリ)」と「クイックスタート: C# または Visual Basic での非同期 API の呼び出し」をご覧ください。

Threads

非同期のメソッドは非ブロッキング操作を意図しています。非同期のメソッドの await 式では、待機中のタスクの実行時に現在のスレッドはブロックされません。代わりに、式はメソッドの残りの部分の継続を登録し、非同期のメソッドの呼び出し元にコントロールを戻します。

async および await キーワードは、追加のスレッドを作成する要因にはなりません。非同期のメソッドは自分自身のスレッドで実行しないため、マルチスレッドは必要ありません。メソッドは、現在の同期コンテキストで実行し、メソッドがアクティブな場合に限りスレッドの時間を使用します。 Task.Run を使用して、CPU バインディングの作業をバックグラウンドスレッドに移動できますが、バックグラウンドスレッドは、結果を待つだけのプロセスを援助しません。

非同期プログラミングへの非同期ベースのアプローチは、ほぼすべてのケースの既存のアプローチに推奨されます。特に、このアプローチはコードがシンプルで競合状態からの保護の必要がないため、I/O バウンドの操作では、BackgroundWorker クラスよりも優れています。 Task.Run メソッドと組み合わせると、非同期のプログラミングは CPU バインディングの操作に関して BackgroundWorker よりも優れています。これは、非同期のプログラミングの場合、Task.Run でスレッドプールに転送する作業から、コードの実行の調整の詳細が分離されるためです。

async と await

async 修飾子を使用して、メソッドが非同期メソッドであることを指定すると、次の 2 つの機能が有効になります。

マークされた非同期のメソッドは中断ポイントを示すために await を使用できます。 await 演算子は、非同期のメソッドが、待機中の非同期のプロセスが完了するまでこのポイント以降を続行できないことを、コンパイラに指示します。その間、コントロールは非同期のメソッドの呼び出し元に戻されます。

非同期のメソッドの await 式での中断は、メソッドからの終了を意図するものではなく、finally ブロックは実行されません。
マークされた非同期のメソッド自体は、呼び出し元のメソッドによって待機できます。

非同期のメソッドには、通常の await 演算子が 1 つ以上ありますが、await 式がない場合もコンパイラエラーの原因にはなりません。中断ポイントをマークするために非同期のメソッドが await 演算子を使用しない場合、async 修飾子が存在しても、メソッドは同期メソッドと同様に実行されます。このようなメソッドには、コンパイラが警告を発行します。

async と await は、コンテキストキーワードです。詳細およびサンプルについては、次のトピックを参照してください:

async
await

戻り値の型およびパラメーター

非同期メソッドは、通常 Task または Task<TResult> を返します。非同期のメソッド内で、await 演算子は、他の非同期のメソッドへの呼び出しから戻されたタスクに適用されます。

メソッドが、TResult 型のオペランドを指定する return ステートメントを含む場合、Task<TResult> を戻り値の型として指定します。

メソッドに Return ステートメントがない場合、または Return ステートメントがオペランドを戻さない場合、Task を戻り値の型として使用します。

型に GetAwaiter メソッドが含まれている場合は、その他の戻り値の型を指定することもできます。このような型の例として、ValueTask<TResult> が挙げられます。これは、System.Threading.Tasks.Extension NuGet パッケージにあります。

次のサンプルは、Task<TResult> または Task を戻すメソッドを宣言して呼び出す方法を示します。

async Task<int> GetTaskOfTResultAsync()
{
    int hours = 0;
    await Task.Delay(0);

    return hours;
}


Task<int> returnedTaskTResult = GetTaskOfTResultAsync();
int intResult = await returnedTaskTResult;
// Single line
// int intResult = await GetTaskOfTResultAsync();

async Task GetTaskAsync()
{
    await Task.Delay(0);
    // No return statement needed
}

Task returnedTask = GetTaskAsync();
await returnedTask;
// Single line
await GetTaskAsync();

それぞれ、進行中の作業を示すタスクを戻します。タスクに非同期処理の状態に関する情報、および最終的にはプロセスからの最終結果、またはプロセスが成功しなかった場合に発生する例外をカプセル化します。

非同期のメソッドの戻り値の型としては、void を指定できます。この戻り値の型は主として、void の戻り値の型が必要なイベントハンドラーの定義に使用されます。非同期のイベントハンドラーは通常、非同期のプログラムの開始点として機能します。

void の戻り値の型を持つ非同期のメソッドは、待機できません。void を戻すメソッドの呼び出し元では、このメソッドがスローする例外をキャッチできません。

非同期のメソッドで in、ref、または out パラメーターを宣言することはできませんが、これらのパラメーターを持つメソッドを呼び出すことはできます。同様に、非同期メソッドは ref 戻り値を使用してメソッドを呼び出すことはできますが、参照を使用して値を返すことはできません。

詳細および例については、「非同期の戻り値の型 (C#)」を参照してください。

Windows ランタイムプログラミングの非同期 API には、タスクに類似した次のような戻り値の型の 1 つがあります。

IAsyncOperation<TResult> は Task<TResult> に対応します
IAsyncAction は Task に対応します
IAsyncActionWithProgress<TProgress>
IAsyncOperationWithProgress<TResult,TProgress>

命名規則

慣例により、一般的に待機可能な型 (たとえば Task、Task<T>、ValueTask、ValueTask<T>) を返すメソッドについては、その名前の末尾に "Async" を付けます。非同期操作を開始するメソッドであっても、そのメソッドが待機可能な型を返さない場合は、メソッド名の末尾に "Async" を付けてはなりませんが、このメソッドが操作の結果を返したりスローしたりしないことを示す "Begin" や "Start" などの動詞を先頭に付けることはかまいません。

イベント、基底クラス、またはインターフェイスのコントラクトが別の名前を表示している場合は、この慣例を無視できます。たとえば、OnButtonClick などの共通のイベントハンドラーの名前は、変更しないことをお勧めします。

タイトル	説明
async と await を使用して複数の Web 要求を並列実行する方法 (C#)	複数のタスクを同時に開始する方法を示します。
非同期の戻り値の型 (C#)	非同期のメソッドが戻す型、および各型の適切な使用方法を説明します。
シグナル化メカニズムとしてキャンセルトークンを使用して、タスクをキャンセルします。	非同期のソリューションに次の機能を追加する方法を示します: - タスクの一覧をキャンセルする (C#) - 一定時間後にタスクをキャンセルする (C#) - 完了時に非同期タスクを処理する (C#)
ファイルアクセスに非同期を使用する (C#)	async および await を使用してファイルにアクセスすることの利点の一覧と紹介です。
タスクベースの非同期パターン (TAP)	非同期パターンについて説明されています。パターンは Task および Task<TResult> 型に基づいています。
Channel 9 の非同期に関するビデオ	非同期のプログラミングに関するさまざまなビデオへのリンクを示します。

次の方法で共有

非同期プログラミングモデル

非同期による応答性の改善

非同期メソッドの作成が簡単

非同期メソッドでの動作

API の非同期メソッド

Threads

async と await

戻り値の型およびパラメーター

命名規則

関連記事 (Visual Studio)

関連項目

その他のリソース

次の方法で共有

非同期プログラミング モデル

非同期による応答性の改善

非同期メソッドの作成が簡単

非同期メソッドでの動作

API の非同期メソッド

Threads

async と await

戻り値の型およびパラメーター

命名規則

関連記事 (Visual Studio)

関連項目

その他のリソース

非同期プログラミングモデル