Het asynchrone patroon op basis van taken implementeren

Artikel
03/05/2024

U kunt het op taken gebaseerde Asynchrone patroon (TAP) op drie manieren implementeren: met behulp van de C#- en Visual Basic-compilers in Visual Studio, handmatig of via een combinatie van de compiler en handmatige methoden. In de volgende secties wordt elke methode in detail besproken. U kunt het TAP-patroon gebruiken om asynchrone bewerkingen te implementeren die afhankelijk zijn van rekenkracht en I/O-afhankelijke bewerkingen. In de sectie Workloads wordt elk type bewerking besproken.

TAP-methoden genereren

De compilers gebruiken

Vanaf .NET Framework 4.5 wordt elke methode die is toegeschreven aan het async trefwoord (Async in Visual Basic) beschouwd als een asynchrone methode en voeren de C# en Visual Basic-compilers de benodigde transformaties uit om de methode asynchroon te implementeren met behulp van TAP. Een asynchrone methode moet een System.Threading.Tasks.Task of een System.Threading.Tasks.Task<TResult> object retourneren. Voor deze laatste moet de hoofdtekst van de functie een TResult, en de compiler zorgt ervoor dat dit resultaat beschikbaar wordt gesteld via het resulterende taakobject. Eventuele uitzonderingen die niet worden verwerkt in de hoofdtekst van de methode, worden ook aan de uitvoertaak toegewezen en zorgen ervoor dat de resulterende taak eindigt in de TaskStatus.Faulted status. De uitzondering op deze regel is wanneer een OperationCanceledException (of afgeleid type) niet wordt verwerkt. In dat geval eindigt de resulterende taak in de TaskStatus.Canceled status.

TAP-methoden handmatig genereren

U kunt het TAP-patroon handmatig implementeren voor betere controle over de implementatie. De compiler is afhankelijk van het openbare oppervlak dat wordt weergegeven vanuit de System.Threading.Tasks naamruimte en ondersteunende typen in de System.Runtime.CompilerServices naamruimte. Als u de TAP zelf wilt implementeren, maakt u een TaskCompletionSource<TResult> object, voert u de asynchrone bewerking uit en wanneer deze is voltooid, roept u de SetResultmethode SetExceptionof SetCanceled de Try versie van een van deze methoden aan. Wanneer u handmatig een TAP-methode implementeert, moet u de resulterende taak voltooien wanneer de vertegenwoordigde asynchrone bewerking is voltooid. Voorbeeld:

public static Task<int> ReadTask(this Stream stream, byte[] buffer, int offset, int count, object state)
{
    var tcs = new TaskCompletionSource<int>();
    stream.BeginRead(buffer, offset, count, ar =>
    {
        try { tcs.SetResult(stream.EndRead(ar)); }
        catch (Exception exc) { tcs.SetException(exc); }
    }, state);
    return tcs.Task;
}

<Extension()>
Public Function ReadTask(stream As Stream, buffer() As Byte,
                         offset As Integer, count As Integer,
                         state As Object) As Task(Of Integer)
    Dim tcs As New TaskCompletionSource(Of Integer)()
    stream.BeginRead(buffer, offset, count, Sub(ar)
                                                Try
                                                    tcs.SetResult(stream.EndRead(ar))
                                                Catch exc As Exception
                                                    tcs.SetException(exc)
                                                End Try
                                            End Sub, state)
    Return tcs.Task
End Function

Hybride benadering

Het kan handig zijn om het TAP-patroon handmatig te implementeren, maar om de kernlogica voor de implementatie naar de compiler te delegeren. U kunt bijvoorbeeld de hybride benadering gebruiken als u argumenten buiten een door een compiler gegenereerde asynchrone methode wilt controleren, zodat uitzonderingen kunnen ontsnappen aan de directe aanroeper van de methode in plaats van beschikbaar te worden gemaakt via het System.Threading.Tasks.Task object:

public Task<int> MethodAsync(string input)
{
    if (input == null) throw new ArgumentNullException("input");
    return MethodAsyncInternal(input);
}

private async Task<int> MethodAsyncInternal(string input)
{

   // code that uses await goes here

   return value;
}

Public Function MethodAsync(input As String) As Task(Of Integer)
    If input Is Nothing Then Throw New ArgumentNullException("input")

    Return MethodAsyncInternal(input)
End Function

Private Async Function MethodAsyncInternal(input As String) As Task(Of Integer)

    ' code that uses await goes here

    return value
End Function

Een ander geval waarin dergelijke delegatie nuttig is, is wanneer u snelle padoptimalisatie implementeert en een taak in de cache wilt retourneren.

Workloads

U kunt zowel reken- als I/O-gebonden asynchrone bewerkingen implementeren als TAP-methoden. Wanneer TAP-methoden echter openbaar worden weergegeven vanuit een bibliotheek, moeten ze alleen worden opgegeven voor werkbelastingen die I/O-gebonden bewerkingen omvatten (ze kunnen ook berekeningen omvatten, maar mogen niet uitsluitend rekenkundige bewerkingen zijn). Als een methode puur rekengebonden is, moet deze alleen worden weergegeven als een synchrone implementatie. De code die deze gebruikt, kan vervolgens kiezen of u een aanroep van die synchrone methode in een taak wilt verpakken om het werk naar een andere thread te offloaden of om parallellisme te bereiken. En als een methode I/O-gebonden is, moet deze alleen worden weergegeven als een asynchrone implementatie.

Berekeningsgebonden taken

De System.Threading.Tasks.Task klasse is ideaal voor rekenintensieve bewerkingen. Standaard wordt gebruikgemaakt van speciale ondersteuning binnen de ThreadPool klasse om efficiënte uitvoering te bieden en biedt het ook aanzienlijke controle over wanneer, waar en hoe asynchrone berekeningen worden uitgevoerd.

U kunt op de volgende manieren rekentaken genereren:

Gebruik in .NET Framework 4.5 en hoger (inclusief .NET Core en .NET 5+) de statische Task.Run methode als snelkoppeling naar TaskFactory.StartNew. U kunt dit gebruiken Run om eenvoudig een rekengebonden taak te starten die is gericht op de threadpool. Dit is het aanbevolen mechanisme voor het starten van een rekengebonden taak. Gebruik StartNew deze functie alleen rechtstreeks als u meer gedetailleerde controle over de taak wilt.
Gebruik in .NET Framework 4 de TaskFactory.StartNew methode, die een gemachtigde (meestal een Action<T> of a Func<TResult>) accepteert die asynchroon moet worden uitgevoerd. Als u een Action<T> gemachtigde opgeeft, retourneert de methode een System.Threading.Tasks.Task object dat de asynchrone uitvoering van die gemachtigde vertegenwoordigt. Als u een Func<TResult> gemachtigde opgeeft, retourneert de methode een System.Threading.Tasks.Task<TResult> object. Overbelastingen van de StartNew methode accepteren een annuleringstoken (CancellationToken), opties voor het maken van taken (TaskCreationOptions) en een taakplanner (TaskScheduler), die allemaal nauwkeurige controle bieden over de planning en uitvoering van de taak. Een factory-exemplaar dat is gericht op de huidige taakplanner, is beschikbaar als een statische eigenschap (Factory) van de Task klasse, bijvoorbeeld: Task.Factory.StartNew(…).
Gebruik de constructors van het Task type en de Start methode als u de taak afzonderlijk wilt genereren en plannen. Openbare methoden mogen alleen taken retourneren die al zijn gestart.
Gebruik de overbelasting van de Task.ContinueWith methode. Met deze methode maakt u een nieuwe taak die wordt gepland wanneer een andere taak is voltooid. Sommige overbelastingen ContinueWith accepteren een annuleringstoken, vervolgopties en een taakplanner voor betere controle over de planning en uitvoering van de vervolgtaak.
Gebruik de TaskFactory.ContinueWhenAll en TaskFactory.ContinueWhenAny methoden. Met deze methoden maakt u een nieuwe taak die wordt gepland wanneer alle of een van een opgegeven set taken is voltooid. Deze methoden bieden ook overbelastingen om de planning en uitvoering van deze taken te beheren.

Bij rekentaken kan het systeem de uitvoering van een geplande taak voorkomen als er een annuleringsaanvraag wordt ontvangen voordat de taak wordt uitgevoerd. Als u een annuleringstoken (CancellationToken object) opgeeft, kunt u dat token doorgeven aan de asynchrone code die het token bewaakt. U kunt het token ook opgeven op een van de eerder genoemde methoden, zoals StartNew of Run zodat de Task runtime ook het token kan bewaken.

Denk bijvoorbeeld aan een asynchrone methode waarmee een afbeelding wordt weergegeven. De hoofdtekst van de taak kan het annuleringstoken peilen, zodat de code vroeg kan worden afgesloten als er een annuleringsaanvraag binnenkomt tijdens het weergeven. Als de annuleringsaanvraag binnenkomt voordat de rendering begint, wilt u bovendien voorkomen dat de renderingbewerking wordt uitgevoerd:

internal Task<Bitmap> RenderAsync(
              ImageData data, CancellationToken cancellationToken)
{
    return Task.Run(() =>
    {
        var bmp = new Bitmap(data.Width, data.Height);
        for(int y=0; y<data.Height; y++)
        {
            cancellationToken.ThrowIfCancellationRequested();
            for(int x=0; x<data.Width; x++)
            {
                // render pixel [x,y] into bmp
            }
        }
        return bmp;
    }, cancellationToken);
}

Friend Function RenderAsync(data As ImageData, cancellationToken As _
                            CancellationToken) As Task(Of Bitmap)
    Return Task.Run(Function()
                        Dim bmp As New Bitmap(data.Width, data.Height)
                        For y As Integer = 0 to data.Height - 1
                            cancellationToken.ThrowIfCancellationRequested()
                            For x As Integer = 0 To data.Width - 1
                                ' render pixel [x,y] into bmp
                            Next
                        Next
                        Return bmp
                    End Function, cancellationToken)
End Function

Berekeningsgebonden taken eindigen in een Canceled status als ten minste een van de volgende voorwaarden waar is:

Er wordt een annuleringsaanvraag ingediend via het CancellationToken object, dat wordt opgegeven als argument voor de aanmaakmethode (bijvoorbeeld StartNew of Run) voordat de taak overgaat naar de Running status.
Een OperationCanceledException uitzondering wordt niet verwerkt binnen de hoofdtekst van een dergelijke taak, die uitzondering bevat hetzelfde CancellationToken dat aan de taak wordt doorgegeven en dat token laat zien dat annulering is aangevraagd.

Als een andere uitzondering niet wordt verwerkt binnen de hoofdtekst van de taak, eindigt de taak in de Faulted status en eventuele pogingen om te wachten op de taak of toegang tot het resultaat, wordt er een uitzondering gegenereerd.

I/O-gebonden taken

Als u een taak wilt maken die niet rechtstreeks door een thread moet worden ondersteund voor de volledige uitvoering, gebruikt u het TaskCompletionSource<TResult> type. Met dit type wordt een Task eigenschap weergegeven die een gekoppeld Task<TResult> exemplaar retourneert. De levenscyclus van deze taak wordt bepaald door TaskCompletionSource<TResult> methoden zoals SetResult, SetExceptionen SetCanceledhun TrySet varianten.

Stel dat u een taak wilt maken die na een opgegeven periode wordt voltooid. U kunt bijvoorbeeld een activiteit in de gebruikersinterface vertragen. De System.Threading.Timer klasse biedt al de mogelijkheid om een gemachtigde asynchroon aan te roepen na een opgegeven periode, en door gebruik te maken van TaskCompletionSource<TResult> een Task<TResult> front op de timer, bijvoorbeeld:

public static Task<DateTimeOffset> Delay(int millisecondsTimeout)
{
    TaskCompletionSource<DateTimeOffset> tcs = null;
    Timer timer = null;

    timer = new Timer(delegate
    {
        timer.Dispose();
        tcs.TrySetResult(DateTimeOffset.UtcNow);
    }, null, Timeout.Infinite, Timeout.Infinite);

    tcs = new TaskCompletionSource<DateTimeOffset>(timer);
    timer.Change(millisecondsTimeout, Timeout.Infinite);
    return tcs.Task;
}

Public Function Delay(millisecondsTimeout As Integer) As Task(Of DateTimeOffset)
    Dim tcs As TaskCompletionSource(Of DateTimeOffset) = Nothing
    Dim timer As Timer = Nothing

    timer = New Timer(Sub(obj)
                          timer.Dispose()
                          tcs.TrySetResult(DateTimeOffset.UtcNow)
                      End Sub, Nothing, Timeout.Infinite, Timeout.Infinite)

    tcs = New TaskCompletionSource(Of DateTimeOffset)(timer)
    timer.Change(millisecondsTimeout, Timeout.Infinite)
    Return tcs.Task
End Function

De Task.Delay methode wordt voor dit doel verstrekt en u kunt deze in een andere asynchrone methode gebruiken, bijvoorbeeld om een asynchrone polling-lus te implementeren:

public static async Task Poll(Uri url, CancellationToken cancellationToken,
                              IProgress<bool> progress)
{
    while(true)
    {
        await Task.Delay(TimeSpan.FromSeconds(10), cancellationToken);
        bool success = false;
        try
        {
            await DownloadStringAsync(url);
            success = true;
        }
        catch { /* ignore errors */ }
        progress.Report(success);
    }
}

Public Async Function Poll(url As Uri, cancellationToken As CancellationToken,
                           progress As IProgress(Of Boolean)) As Task
    Do While True
        Await Task.Delay(TimeSpan.FromSeconds(10), cancellationToken)
        Dim success As Boolean = False
        Try
            await DownloadStringAsync(url)
            success = true
        Catch
            ' ignore errors
        End Try
        progress.Report(success)
    Loop
End Function

De TaskCompletionSource<TResult> klasse heeft geen niet-generieke tegenhanger. Task<TResult> Is echter afgeleid vanTask, zodat u het algemene TaskCompletionSource<TResult> object kunt gebruiken voor I/O-gebonden methoden die gewoon een taak retourneren. Hiervoor kunt u een bron met een dummy TResult gebruiken (Boolean is een goede standaardkeuze, maar als u zich zorgen maakt over de gebruiker van de Task downcasting naar een Task<TResult>, kunt u in plaats daarvan een privétype TResult gebruiken). De methode in het vorige voorbeeld retourneert bijvoorbeeld Delay de huidige tijd, samen met de resulterende offset (Task<DateTimeOffset>). Als een dergelijke resultaatwaarde niet nodig is, kan de methode in plaats daarvan als volgt worden gecodeerd (let op de wijziging van het retourtype en de wijziging van het argument in TrySetResult):

public static Task<bool> Delay(int millisecondsTimeout)
{
     TaskCompletionSource<bool> tcs = null;
     Timer timer = null;

     timer = new Timer(delegate
     {
         timer.Dispose();
         tcs.TrySetResult(true);
     }, null, Timeout.Infinite, Timeout.Infinite);

     tcs = new TaskCompletionSource<bool>(timer);
     timer.Change(millisecondsTimeout, Timeout.Infinite);
     return tcs.Task;
}

Public Function Delay(millisecondsTimeout As Integer) As Task(Of Boolean)
    Dim tcs As TaskCompletionSource(Of Boolean) = Nothing
    Dim timer As Timer = Nothing

    Timer = new Timer(Sub(obj)
                          timer.Dispose()
                          tcs.TrySetResult(True)
                      End Sub, Nothing, Timeout.Infinite, Timeout.Infinite)

    tcs = New TaskCompletionSource(Of Boolean)(timer)
    timer.Change(millisecondsTimeout, Timeout.Infinite)
    Return tcs.Task
End Function

Gemengde reken- en I/O-afhankelijke taken

Asynchrone methoden zijn niet beperkt tot alleen reken- of I/O-gebonden bewerkingen, maar kunnen een combinatie van de twee vormen. In feite worden meerdere asynchrone bewerkingen vaak gecombineerd tot grotere gemengde bewerkingen. De methode in een vorig voorbeeld heeft bijvoorbeeld RenderAsync een rekenintensieve bewerking uitgevoerd om een afbeelding weer te geven op basis van invoer imageData. Dit imageData kan afkomstig zijn van een webservice waartoe u asynchroon toegang hebt:

public async Task<Bitmap> DownloadDataAndRenderImageAsync(
    CancellationToken cancellationToken)
{
    var imageData = await DownloadImageDataAsync(cancellationToken);
    return await RenderAsync(imageData, cancellationToken);
}

Public Async Function DownloadDataAndRenderImageAsync(
             cancellationToken As CancellationToken) As Task(Of Bitmap)
    Dim imageData As ImageData = Await DownloadImageDataAsync(cancellationToken)
    Return Await RenderAsync(imageData, cancellationToken)
End Function

In dit voorbeeld ziet u ook hoe één annuleringstoken kan worden threaded via meerdere asynchrone bewerkingen. Zie de sectie annuleringsgebruik in Het gebruik van het Asynchrone patroon op basis van taken voor meer informatie.

Share via