Procédure pas à pas : utilisation du débogueur avec les méthodes Async

Article
06/10/2015

La fonctionnalité Async vous permet d'appeler des méthodes asynchrones sans utiliser de rappels ni fractionner votre code entre plusieurs méthodes ou expressions lambda. Pour rendre le code synchrone asynchrone, appelez une méthode asynchrone au lieu d'une méthode synchrone et ajoutez quelques mots clés au code. Pour plus d'informations, consultez Programmation asynchrone avec Async et Await (C# et Visual Basic).

Dans le débogueur Visual Studio, vous pouvez utiliser les commandes Pas à pas détaillé, Pas à pas principal et Pas à pas sortant avec la fonctionnalité Async. Vous pouvez également continuer à utiliser des points d'arrêt, en particulier pour visualiser le flux de contrôle à une instruction contenant un opérateur await. Dans cette procédure, vous effectuerez les tâches suivantes, que vous pouvez exécuter dans n'importe quel ordre.

Montrer le flux de contrôle à une instruction await en utilisant des points d'arrêt.
Comprendre le comportement des commandes Pas à pas détaillé et Pas à pas principal aux instructions qui contiennent un opérateur await.
Comprendre le comportement de la commande Pas à pas sortant utilisé d'une méthode async.

Points d'arrêt permettant d'afficher le flux de contrôle

Si vous marquez une méthode avec le modificateur Async (Visual Basic) ou async (C#), vous pouvez utiliser l'opérateur Await (Visual Basic) ou await (C#) dans la méthode. Pour créer une expression await, associez l'opérateur await à une tâche. Lorsqu'une expression await est appelée pour la tâche, la méthode actuelle est immédiatement abandonnée et une autre tâche est retournée. Lorsque la tâche associée à l'opérateur await est terminée, l'exécution se poursuit dans la même méthode. Pour plus d'informations, consultez Flux de contrôle dans les programmes Async (C# et Visual Basic).

Notes

Une méthode async retourne à l'appelant en cas de rencontre du premier objet await qui n'est pas encore terminé ou en cas d'atteinte de la fin de la méthode async, selon la première éventualité.

Notes

Les applications console dans ces exemples utilisent la méthode Wait pour empêcher l'application de se terminer dans Main.Vous ne devez pas utiliser la méthode Wait en dehors des applications console car un interblocage peut se produire.

La procédure suivante définit des points d'arrêt pour illustrer ce qui se produit lorsque l'application atteint une instruction await. Vous pouvez également montrer le flux de contrôle en ajoutant des instructions Debug.WriteLine.

Créez une application console et collez-y le code suivant :

' 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;
    }
}

Définissez des points d'arrêt de débogage sur les trois lignes qui se terminent par un commentaire « set breakpoint » (définir un point d'arrêt).
Sélectionnez la touche F5 ou Déboguer, Démarrer le débogage dans la barre de menus pour exécuter l'application.

L'application passe à la méthode ProcessAsync et s'arrête sur la ligne qui contient l'opérateur await.
Sélectionnez à nouveau la touche F5.

Parce que l'application s'est arrêtée sur une instruction qui contient un opérateur await, l'application quitte immédiatement la méthode async et retourne une tâche. Par conséquent, l'application quitte la méthode ProcessAsync et s'arrête au point d'arrêt dans la méthode d'appel (Main).
Sélectionnez à nouveau la touche F5.

Lorsque la méthode DoSomethingAsync est terminée, le code reprend après l'instruction await dans la méthode d'appel. Par conséquent, l'application s'arrête au point d'arrêt dans la méthode ProcessAsync.

Lorsque DoSomethingAsync a initialement fait l'objet d'une instruction await, la méthode ProcessAsync s'est arrêtée et a retourné une tâche. Lorsque la méthode DoSomethingAsync ayant fait l'objet d'une instruction await est terminée, l'évaluation de l'instruction await a généré la valeur de retour DoSomethingAsync. La méthode DoSomethingAsync est définie pour retourner Task (Of Integer) en Visual Basic ou Task<int> en C#, donc la valeur dans son instruction Return est un entier. Pour plus d'informations, consultez Types de retour Async (C# et Visual Basic).

Obtention puis attente d'une tâche

Dans la méthode ProcessAsync, l'instruction Dim result = Await DoSomethingAsync() (Visual Basic) ou var result = await DoSomethingAsync(); (C#) est une contraction des deux instructions suivantes :

Dim theTask = DoSomethingAsync()
Dim result = Await theTask

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

La première ligne de code appelle la méthode async et retourne une tâche. Cette tâche est associée à l'opérateur await dans la ligne de code suivante. L'instruction await quitte la méthode (ProcessAsync) et retourne une autre tâche. Lorsque la tâche associée à l'opérateur await est terminée, le code reprend dans la méthode (ProcessAsync) après l'instruction await.

Lorsque l'instruction await retourne immédiatement une autre tâche, cette tâche est l'argument retourné par la méthode async qui contient l'opérateur await (ProcessAsync). La tâche retournée par l'instruction await inclut l'exécution de code qui se produit après l'instruction await dans la même méthode, c'est pourquoi cette tâche est différente de la tâche associée à await.

Pas à pas détaillé et Pas à pas principal

La commande Pas à pas détaillé détaille une méthode, mais la commande Pas à pas principal exécute l'appel de méthode, puis s'arrête sur la ligne suivante de la méthode d'appel. Pour plus d'informations, consultez Effectuer un pas à pas détaillé, principal ou sortant.

La procédure suivante montre ce qui se passe lorsque vous sélectionnez les commandes Pas à pas détaillé ou Pas à pas principal sur une instruction await.

Remplacez le code dans l'application console par le code suivant.

' 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;
    }
}

Sélectionnez la touche F11 ou choisissez Déboguer, Pas à pas détaillé dans la barre de menus pour démarrer une démonstration de la commande Step Into sur une instruction contenant un opérateur await.

L'application démarre et s'arrête sur la première ligne, qui est Sub Main() en Visual Basic ou l'accolade ouvrante de la méthode Main en C#.
Choisissez la touche F11 encore trois fois.

L'application doit maintenant avoir atteint l'instruction await dans la méthode ProcessAsync.
Appuyez sur la touche F11.

L'application passe à la méthode DoSomethingAsync et s'arrête sur la première ligne. Ce comportement se produit même si, à l'instruction await, l'application retourne immédiatement à la méthode appelante (Main).
Continuez à appuyer sur la touche F11 jusqu'à ce l'application revienne à l'instruction await dans la méthode ProcessAsync.
Appuyez sur la touche F11.

L'application s'arrête sur la ligne qui suit l'instruction await.
Dans la barre de menus, sélectionnez Déboguer, Arrêter le débogage pour arrêter l'exécution de l'application.

Les étapes suivantes montrent la commande Pas à pas principal à une instruction await.
Sélectionnez la touche F11 quatre fois, ou choisissez Déboguer, Pas à pas détaillé quatre fois dans la barre de menus.

L'application doit maintenant avoir atteint l'instruction await dans la méthode ProcessAsync.
Choisissez la touche F10 ou Déboguer, Pas à pas principal dans la barre de menus.

L'exécution s'arrête à la ligne qui suit l'instruction await. Ce comportement se produit même si l'application retourne immédiatement à la méthode appelante (Main) à l'instruction await. La commande Step Over effectue également un pas à pas principal dans l'exécution de la méthode DoSomethingAsync, comme prévu.
Dans la barre de menus, sélectionnez Déboguer, Arrêter le débogage pour arrêter l'exécution de l'application.

Au fil de la procédure, le comportement des commandes Pas à pas détaillé et Pas à pas principal diffère légèrement lorsque l'opérateur await se trouve sur une autre ligne entre l'appel et la méthode async.
Dans la méthode ProcessAsync, remplacez l'instruction await par le code suivant : L'instruction await d'origine est une contraction des deux instructions suivantes.
```
Dim theTask = DoSomethingAsync()
Dim result = Await theTask
```
```
var theTask = DoSomethingAsync();
var result = await theTask;
```
Sélectionnez la touche F11 ou choisissez Déboguer, Pas à pas détaillé dans la barre de menus plusieurs fois pour commencer l'exécution et pour parcourir le code.

À l'appel de DoSomethingAsync, la commande Pas à pas détaillé s'arrête à la méthode DoSomethingAsync, alors que la commande Pas à pas principal accède à l'instruction suivante, comme prévu. À l'instruction await, les deux commandes s'arrêtent à l'instruction qui suit await.

Pas à pas sortant

Dans les méthodes qui ne sont pas async, la commande Pas à pas sortant s'arrête dans la méthode d'appel sur le code qui suit l'appel de méthode. Pour les méthodes async, la logique d'arrêt de l'exécution dans la méthode appelante est plus complexe, et cette logique varie selon que la commande Pas à pas sortant se trouve sur la première ligne de la méthode async ou non.

Remplacez le code dans l'application console par le code suivant.

' 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;
    }
}

Définissez un point d'arrêt sur la ligne Debug.WriteLine("before") de la méthode DoSomethingAsync.

Ceci afin d'illustrer le comportement de la commande Pas à pas sortant d'une ligne dans une méthode async qui n'est pas la première ligne.
Sélectionnez la touche F5 ou Déboguer, Démarrer le débogage dans la barre de menus pour démarrer l'application.

Le code s'arrête sur Debug.WriteLine("before") dans la méthode DoSomethingAsync.
Choisissez les touches Maj+F11, ou Déboguer, Pas à pas sortant dans la barre de menus.

L'application s'arrête dans la méthode appelante à l'instruction await de la tâche qui est associée à la méthode actuelle. Par conséquent, l'application s'arrête sur l'instruction await dans la méthode ProcessAsync. L'application ne s'arrête pas sur Dim z = 0 (Visual Basic) ou int z = 0; (C#), qui est le code qui suit l'appel à la méthode DoSomethingAsync.
Choisissez Déboguer, Arrêter le débogage dans la barre de menus pour arrêter l'exécution de l'application.

Les étapes suivantes illustrent ce qui se produit lorsque vous effectuez un pas à pas sortant dès la première ligne d'une méthode async.
Supprimez le point d'arrêt existant et ajoutez un point d'arrêt sur la première ligne de la méthode DoSomethingAsync.

En C#, ajoutez le point d'arrêt sur l'accolade ouvrante de la méthode DoSomethingAsync. En Visual Basic, ajoutez un point d'arrêt sur la ligne qui contient Async Function DoSomethingAsync() As Task(Of Integer).
Appuyez sur la touche F5 pour démarrer l'application.

Le code s'arrête sur la première ligne de la méthode DoSomethingAsync.
Dans la barre de menus, sélectionnez Déboguer, Fenêtres, Sortie.

La fenêtre Sortie s'ouvre.
Choisissez les touches Maj+F11, ou Déboguer, Pas à pas sortant dans la barre de menus.

L'application reprend jusqu'à ce que la méthode async atteigne sa première instruction await, puis l'application s'arrête à l'instruction appelante. Par conséquent, l'application s'arrête sur Dim the Task = DoSomethingAsync() (Visual Basic) ou var theTask = DoSomethingAsync(); (C#). Le message « before » (avant) s'affiche dans la fenêtre Sortie, mais le message « after » (après) ne s'est pas encore affiché.
Sélectionnez la touche F5 pour continuer à exécuter l'application.

L'application continue avec l'instruction qui suit l'instruction await dans la fonction async appelée (DoSomethingAsync). Le message « after » (après) apparaît dans la fenêtre Sortie.

Voir aussi

Concepts

Démarrer, Pas à pas principal, Exécuter du code et Arrêter le débogage dans Visual Studio

Partager via