チュートリアル: 非同期メソッドと共にデバッガーを使用する

[アーティクル]
06/10/2015

非同期機能を使用すると、コールバックの使用や複数のメソッドまたはラムダ式へのコードの分割を行わずに、非同期メソッドを呼び出すことができます。同期コードを非同期コードにするには、同期メソッドの代わりに非同期メソッドを呼び出して、コードにいくつかのキーワードを追加します。詳細については、「Async および Await を使用した非同期プログラミング (C# および Visual Basic)」を参照してください。

Visual Studio デバッガーでは、[ステップイン]、[ステップオーバー]、[ステップアウト] のコマンドを Async 機能に使用できます。ブレークポイントも引き続き使用できます。特に、await 演算子を含むステートメントでの制御フローを表示するためにです。このチュートリアルでは次のタスクを完了します。実行する順序は任意でかまいません。

ブレークポイントを使用して await ステートメントでの制御フローを示す。
await 演算子を含むステートメントでの [ステップイン] および [ステップオーバー] コマンドの動作を理解する。
async メソッド内から使用するときの [ステップアウト] コマンドを動作を理解する。

制御フローを表示するためのブレークポイント

メソッドを Async (Visual Basic) または async (C#) 修飾子でマークした場合は、そのメソッド内で Await (Visual Basic) または await (C#) 演算子を使用できます。 await 式を作成するには、await 演算子をタスクに関連付けます。 await 式はタスクに対して呼び出され、現在のメソッドはすぐに終了して、別のタスクを返します。 await 演算子に関連付けられているタスクが終了すると、実行は同じメソッド内で再開されます。詳細については、「非同期プログラムにおける制御フロー (C# および Visual Basic)」を参照してください。

注意

async メソッドは、まだ完了していない処理待ちの最初のオブジェクトに達するか、async メソッドの最後に達すると、いずれか先に到した方の呼び出し元に戻ります。

注意

これらの例のコンソールアプリケーションでは、Wait を使用して、アプリケーションが Main で終了しないようにしています。コンソールアプリケーションの外部で Wait メソッドを使用しないでください。デッドロック状態になる可能性があるためです。

次の手順では、ブレークポイントを設定して、アプリケーションが await ステートメントに達したときの動作を示します。 Debug.WriteLine ステートメントを追加しても制御フローを示すことができます。

コンソールアプリケーションを作成し、そのアプリケーションに次のコードを貼り付けます。

' Breakpoints to show control flow. 
Imports System.Threading.Tasks

Module Module1
    Sub Main()
        Dim theTask = ProcessAsync()
        Dim x = 0 ' set breakpoint
        theTask.Wait()
    End Sub

    Async Function ProcessAsync() As Task
        Dim result = Await DoSomethingAsync()  ' set breakpoint

        Dim y = 0 ' set breakpoint
    End Function

    Async Function DoSomethingAsync() As Task(Of Integer)
        Await Task.Delay(1000)
        Return 5
    End Function 
End Module

// Breakpoints to show control flow. 
using System.Threading.Tasks;

class Program
{
    static void Main(string[] args)
    {
        Task theTask = ProcessAsync();
        int x = 0;  // set breakpoint
        theTask.Wait();
    }

    static async Task ProcessAsync()
    {
        var result = await DoSomethingAsync();  // set breakpoint 

        int y = 0;  // set breakpoint
    }

    static async Task<int> DoSomethingAsync()
    {
        await Task.Delay(1000);
        return 5;
    }
}

「set breakpoint」のコメントで終わる 3 行にデバッグブレークポイントを設定します。
F5 キーを押すかメニューバーで [デバッグ]、[デバッグ開始] の順にクリックして、アプリケーションを実行します。

アプリケーションが ProcessAsync メソッドに達すると、await 演算子が含まれる行で中断されます。
F5 キーを再び押します。

アプリケーションが await 演算子が含まれるステートメントで停止したため、アプリケーションはすぐに async メソッドを終了し、タスクを返します。したがって、アプリケーションが ProcessAsync メソッドを終了し、呼び出し先のメソッド (Main) 内のブレークポイントで中断されます。
F5 キーを再び押します。

DoSomethingAsync メソッドが完了すると、呼び出し元のメソッド内 await ステートメントの後からコードが再開されます。したがって、アプリケーションは ProcessAsync メソッド内のブレークポイントで中断されます。

DoSomethingAsync が最初に待機状態になったとき、ProcessAsync メソッドが終了し、タスクを返しました。待機状態の DoSomethingAsync メソッドが完了すると、await ステートメントの評価により DoSomethingAsync の戻り値が生成されました。 DoSomethingAsync メソッドは、Task (Of Integer) (Visual Basic) または Task<int> (C#) を返すように定義されているため、その return ステートメントの値は整数です。詳細については、「非同期の戻り値の型 (C# および Visual Basic)」を参照してください。

タスクの取得と待機

ProcessAsync メソッドでは、Dim result = Await DoSomethingAsync() (Visual Basic) または var result = await DoSomethingAsync(); (C#) ステートメントは、次の 2 つのステートメントの省略形です。

Dim theTask = DoSomethingAsync()
Dim result = Await theTask

var theTask = DoSomethingAsync();
var result = await theTask;

コードの最初の行は async メソッドを呼び出し、タスクを返します。そのタスクは次のコード行の await 演算子に関連付けられています。 await ステートメントがメソッド (ProcessAsync) を終了し、別のタスクを返します。 await 演算子に関連付けられているタスクが完了すると、コードは await メソッドの後のメソッド (ProcessAsync) から再開されます。

await ステートメントはすぐに別のタスクを返すとき、そのタスクは await 演算子 (ProcessAsync) が含まれる async メソッドの戻り引数です。 await よって返されるタスクには、同じメソッド内の await の後ろで発生するコードの実行が含まれます。それが理由で、そのタスクは、await に関連付けられているタスクとは異なります。

ステップインとステップオーバー

[ステップイン] コマンドはメソッドにステップインしますが、[ステップオーバー] コマンドはメソッド呼び出しを実行してから、呼び出し元のメソッドの次の行で中断します。詳細については、「コードをステップイン、ステップオーバー、ステップアウトする」を参照してください。

次の手順では、await ステートメントで [ステップイン] または [ステップオーバー] コマンドを選択したときの動作を示しています。

コンソールアプリケーションのコードを次のコードに置き換えます。

' Step Into and Step Over Example 
Imports System.Threading.Tasks

Module Module1
    Sub Main()
        ProcessAsync.Wait()
    End Sub

    Async Function ProcessAsync() As Task
        Dim result = Await DoSomethingAsync()  ' Step Into or Step Over from here

        Dim y = 0
    End Function

    Async Function DoSomethingAsync() As Task(Of Integer)
        Await Task.Delay(1000)
        Return 5
    End Function 
End Module

// Step Into and Step Over Example. 
using System.Threading.Tasks;

class Program
{
    static void Main(string[] args)
    {
        ProcessAsync().Wait();
    }

    static async Task ProcessAsync()
    {
        var result = await DoSomethingAsync();  // Step Into or Step Over from here 

        int y = 0;
    }

    static async Task<int> DoSomethingAsync()
    {
        await Task.Delay(1000);
        return 5;
    }
}

F11 キーを押すかメニューバーで [デバッグ]、[ステップイン] の順にクリックして、await 演算子を含むステートメントでの [Step Into] コマンドの動作を見てみます。

アプリケーションが起動され、最初の行で中断されます。その行は Visual Basic では Sub Main()、C# では Main メソッドの始め中かっこです。
F11 キーを 3 回以上押します。

アプリケーションは ProcessAsync メソッド内の await ステートメントに達します。
F11 キーを押します。

アプリケーションは DoSomethingAsync メソッドに達して、その最初の行で中断されます。 await ステートメントで、アプリケーションがすぐに呼び出し元のメソッド (Main) に戻っても、この動作は同じです。
アプリケーションが ProcessAsync メソッド内の await ステートメントに戻るまで、F11 キーを押し続けます。
F11 キーを押します。

アプリケーションが await ステートメントの次の行で中断されます。
メニューバーで [デバッグ]、[デバッグの停止] の順にクリックして、アプリケーションの実行を停止します。

次の手順では、await ステートメントでの [ステップオーバー] コマンドの動作示します。
F11 キーを 4 回押すか、メニューバーで [デバッグ] をクリックして [ステップイン] を 4 回クリックします。

アプリケーションは ProcessAsync メソッド内の await ステートメントに達します。
F10 キーを押すか、メニューバーで [デバッグ]、[ステップオーバー] の順にクリックします。

実行が await ステートメントの次の行で中断されます。 await ステートメントで、アプリケーションがすぐに呼び出し元のメソッド (Main) に戻っても、この動作は同じです。 [Step Over] コマンドは、次に実行される DoSomethingAsync メソッドをステップオーバーします。
メニューバーで [デバッグ]、[デバッグの停止] の順にクリックして、アプリケーションの実行を停止します。

次の手順に示すように、[ステップイン] コマンドと [ステップオーバー] コマンドの動作は、await 演算子が async メソッドの呼び出しと違う行にあると、若干異なります。
ProcessAsync メソッドは await ステートメントを次のコードに置き換えます。元の await ステートメントは次の 2 つのステートメントの省略形です。
```
Dim theTask = DoSomethingAsync()
Dim result = Await theTask
```
```
var theTask = DoSomethingAsync();
var result = await theTask;
```
F11 キーを押すか、メニューバーで [デバッグ] をクリックして [ステップイン] を複数回クリックすることで、実行を開始し、コードをステップ実行します。

DoSomethingAsync の呼び出しに達すると、[ステップイン] コマンドは DoSomethingAsync メソッドで中断されますが、[ステップオーバー] コマンドは次に実行されるステートメントに進みます。 await ステートメントに達すると、いずれのコマンドも await の次のステートメントで中断されます。

[ステップアウト]

async でないメソッドの場合、[ステップアウト] コマンドはメソッド呼び出しに続くコード内の呼び出し元のメソッドで中断されます。 async メソッドの場合、呼び出し元のメソッド内のどこで中断されるかのロジックはより複雑です。そのロジックは、[ステップアウト] コマンドを async メソッドの最初の行で実行するかどうかによって異なります。

コンソールアプリケーションのコードを次のコードに置き換えます。

' Step Out Example 
Imports System.Threading.Tasks

Module Module1
    Sub Main()
        ProcessAsync.Wait()
    End Sub

    Async Function ProcessAsync() As Task
        Dim theTask = DoSomethingAsync()
        Dim z = 0
        Dim result = Await theTask
    End Function

    Async Function DoSomethingAsync() As Task(Of Integer)
        Debug.WriteLine("before")  ' Step Out from here
        Await Task.Delay(1000)
        Debug.WriteLine("after")
        Return 5
    End Function 
End Module

// Step Out Example. 
using System.Diagnostics;
using System.Threading.Tasks;

class Program
{
    static void Main(string[] args)
    {
        ProcessAsync().Wait();
    }

    static async Task ProcessAsync()
    {
        var theTask = DoSomethingAsync();
        int z = 0;
        var result = await theTask;
    }

    static async Task<int> DoSomethingAsync()
    {
        Debug.WriteLine("before");  // Step Out from here
        await Task.Delay(1000);
        Debug.WriteLine("after");
        return 5;
    }
}

DoSomethingAsync メソッド内の Debug.WriteLine("before") 行にブレークポイントを設定します。

その目的は、async メソッド内の最初の行でない行からの [ステップアウト] コマンドの動作を示すことです。
F5 キーを押すかメニューバーで [デバッグ]、[デバッグ開始] の順にクリックして、アプリケーションを起動します。

コードは DoSomethingAsync メソッド内の Debug.WriteLine("before") で中断されます。
Shift + F11 キーを押すか、メニューバーで [デバッグ]、[ステップアウト] の順にクリックします。

アプリケーションは呼び出し元のメソッド内で、現在のメソッドに関連付けられているタスクの await ステートメントで中断されます。その結果、アプリケーションは ProcessAsync メソッド内の await ステートメントで中断されます。アプリケーションは、DoSomethingAsync メソッドに続く Dim z = 0 (Visual Basic) または int z = 0; (C#) では中断されません。
メニューバーで [デバッグ]、[デバッグの停止] の順にクリックして、アプリケーションの実行を停止します。

次の手順では、async メソッドの最初の行からの [ステップアウト] の動作を示します。
既存のブレークポイントを削除し、DoSomethingAsync メソッドの最初の行にブレークポイントを追加します。

C# では、DoSomethingAsync メソッドの始め中かっこにブレークポイントを追加します。 Visual Basic では、Async Function DoSomethingAsync() As Task(Of Integer) が含まれる行にブレークポイントを追加します。
F5 キーを押してアプリケーションを実行します。

コードは DoSomethingAsync メソッドの最初の行で中断されます。
メニューバーで [デバッグ]、[Windows]、[出力] の順にクリックします。

[出力] ウィンドウが開きます。
Shift + F11 キーを押すか、メニューバーで [デバッグ]、[ステップアウト] の順にクリックします。

アプリケーションは、async メソッドが最初の await に達するまで実行されて、呼び出し元のステートメントで中断されます。その結果、アプリケーションは Dim the Task = DoSomethingAsync() (Visual Basic) または var theTask = DoSomethingAsync(); (C#) で中断されます。 "変更前" のメッセージは [出力] ウィンドウに表示されていますが、"変更後" のメッセージはまだ表示されていません。
F5 キーを押して、アプリケーションを続行します。

アプリケーションは、呼び出し先の async 関数 (DoSomethingAsync) 内の await ステートメントの次のステートメントから続行されます。 "変更後" のメッセージが [出力] ウィンドウに表示されます。

参照

概念

Visual Studio Debugger の開始、中断、ナビゲート、および停止

チュートリアル: 非同期メソッドと共にデバッガーを使用する

制御フローを表示するためのブレークポイント

タスクの取得と待機

ステップ インとステップ オーバー

[ステップ アウト]

参照

概念

その他のリソース

ステップインとステップオーバー

[ステップアウト]