Markieren Sie das Kontrollkästchen Englisch, um die englische Version dieses Artikels anzuzeigen. Sie können den englischen Text auch in einem Popup-Fenster einblenden, indem Sie den Mauszeiger über den Text bewegen.
Übersetzung
Englisch

TPL and Traditional .NET Framework Asynchronous Programming

.NET Framework (current version)
 

.NET Framework stellt die folgenden zwei Standardmuster zum Ausführen von E/A-gebundenen und rechnergebundenen asynchronen Vorgängen bereit:

  • Das asynchrone Programmiermodell (APM), in dem asynchrone Vorgänge durch ein Paar von Begin/End-Methoden dargestellt werden, z. B. FileStream.BeginRead und Stream.EndRead.

  • Das ereignisbasierte asynchrone Muster (EAP), in dem asynchrone Vorgänge durch ein Methoden-/Ereignispaar mit den Namen "VorgangsnameAsync" und "VorgangsnameCompleted" dargestellt werden, z. B. WebClient.DownloadStringAsync und WebClient.DownloadStringCompleted. (EAP wurde in .NET Framework 2.0 eingeführt.)

Die Task Parallel Library (TPL) kann mit beiden asynchronen Mustern auf unterschiedlichste Weise verwendet werden. Sie können sowohl APM-, als auch EAP-Vorgänge als Aufgaben für Bibliotheksconsumer verfügbar machen, oder Sie machen die APM-Muster verfügbar, implementieren diese aber intern mithilfe von Task-Objekten. In beiden Fällen können Sie den Code mithilfe von Task-Objekten vereinfachen und profitieren von der folgenden nützlichen Funktionalität:

  • Sie können jederzeit nach dem Start der Aufgabe Rückrufe in der Form von Aufgabenfortsetzungen registrieren.

  • Sie können mehrere Vorgänge, die als Reaktion auf eine Begin_-Methode ausgeführt werden, mit den Methoden ContinueWhenAll und ContinueWhenAny, WaitAll oder WaitAny koordinieren.

  • Sie können asynchrone E/A-gebundenen und rechnergebundene Vorgänge im gleichen Task-Objekt kapseln.

  • Sie können den Status des Task-Objekts überwachen.

  • Sie können den Status eines Vorgangs mittels TaskCompletionSource<TResult> an ein Task-Objekt marshallen.

Sowohl die System.Threading.Tasks.TaskFactory-Klasse als auch die System.Threading.Tasks.TaskFactory<TResult>-Klasse stellen mehrere Überladungen der TaskFactory.FromAsync-Methode und der TaskFactory<TResult>.FromAsync-Methode bereit, mit denen Sie ein APM Begin/End-Methodenpaar in einer Task-oder Task<TResult>-Instanz kapseln können. Die verschiedenen Überladungen unterstützen beliebige Begin/End-Methodenpaare mit null bis drei Eingabeparametern.

Verwenden Sie für Paare mit End-Methoden, die einen Wert (Function in Visual Basic) zurückgeben, die Methoden in TaskFactory<TResult>, die ein Task<TResult> erstellen. Verwenden Sie für End-Methoden, die "void" (Sub in Visual Basic) zurückgeben, die Methoden in TaskFactory, die ein Task erstellen.

In den wenigen Fälle, in denen die Begin-Methode über mehr als drei Parameter verfügt oder ref-Parameter bzw. out-Parameter enthält, werden zusätzliche FromAsync-Überladungen bereitgestellt, die nur die End-Methode kapseln.

Im folgenden Beispiel wird die Signatur für die FromAsync-Überladung dargestellt, die den Methoden FileStream.BeginRead und FileStream.EndRead entspricht. Diese Überladung lässt drei Eingabeparameter zu.

public Task<TResult> FromAsync<TArg1, TArg2, TArg3>(
    Func<TArg1, TArg2, TArg3, AsyncCallback, object, IAsyncResult> beginMethod, //BeginRead
     Func<IAsyncResult, TResult> endMethod, //EndRead
     TArg1 arg1, // the byte[] buffer
     TArg2 arg2, // the offset in arg1 at which to start writing data
     TArg3 arg3, // the maximum number of bytes to read
     object state // optional state information
    ) 

Der erste Parameter ist ein Func<T1, T2, T3, T4, T5, TResult>-Delegat, der mit der Signatur der FileStream.BeginRead-Methode übereinstimmt. Der zweite Parameter ist ein Func<T, TResult>-Delegat, der IAsyncResult als Eingabe verwendet und TResult zurückgibt. Da EndRead eine ganze Zahl zurückgibt, leitet der Compiler den Typ von TResult als Int32 und den Typ der Aufgabe als Task ab. Die letzten vier Parameter sind mit denen in der FileStream.BeginRead-Methode identisch:

  • Der Puffer, in dem die Dateidaten gespeichert werden sollen.

  • Der Offset im Puffer, ab dem die Daten geschrieben werden sollen.

  • Die maximale Datenmenge, die aus der Datei gelesen werden soll.

  • Ein optionales Objekt, in dem benutzerdefinierte Zustandsdaten speichert werden, die an den Rückruf übergeben werden sollen.

Wenn Sie nicht nur die Anzahl der Byte in der Datei ermitteln möchten, sondern Zugriff auf die Daten in der Datei benötigen, reicht die FromAsync-Methode nicht aus. Verwenden Sie stattdessen Task, deren Result-Eigenschaft die Dateidaten enthält. Fügen Sie hierzu eine Fortsetzung zu der ursprünglichen Aufgabe hinzu. Die Fortsetzung führt die Aufgaben aus, die normalerweise vom AsyncCallback-Delegaten ausgeführt würde. Sie wird aufgerufen, wenn der Vorgänger abgeschlossen und der Datenpuffer gefüllt wurde. (Das FileStream-Objekt sollte vor der Rückkehr geschlossen werden.)

Im folgenden Beispiel wird gezeigt, wie Sie Task zurückgeben, die das BeginRead/EndRead-Paar der FileStream-Klasse kapselt.

const int MAX_FILE_SIZE = 14000000;
public static Task<string> GetFileStringAsync(string path)
{
    FileInfo fi = new FileInfo(path);
    byte[] data = null;
    data = new byte[fi.Length];

    FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, data.Length, true);

    //Task<int> returns the number of bytes read
    Task<int> task = Task<int>.Factory.FromAsync(
            fs.BeginRead, fs.EndRead, data, 0, data.Length, null);

    // It is possible to do other work here while waiting
    // for the antecedent task to complete.
    // ...

    // Add the continuation, which returns a Task<string>. 
    return task.ContinueWith((antecedent) =>
    {
        fs.Close();

        // Result = "number of bytes read" (if we need it.)
        if (antecedent.Result < 100)
        {
            return "Data is too small to bother with.";
        }
        else
        {
            // If we did not receive the entire file, the end of the
            // data buffer will contain garbage.
            if (antecedent.Result < data.Length)
                Array.Resize(ref data, antecedent.Result);

            // Will be returned in the Result property of the Task<string>
            // at some future point after the asynchronous file I/O operation completes.
            return new UTF8Encoding().GetString(data);
        }
    });
}

Die Methode kann anschließend wie folgt aufgerufen werden.


Task<string> t = GetFileStringAsync(path);          

// Do some other work:
// ...

try
{
     Console.WriteLine(t.Result.Substring(0, 500));
}
catch (AggregateException ae)
{
    Console.WriteLine(ae.InnerException.Message);
}            

Wenn in typischen IAsyncResult-Vorgängen der AsyncCallback-Delegat bestimmte benutzerdefinierte Zustandsdaten erfordert, müssen Sie diese mit dem letzten Parameter in der Begin-Methode übergeben, damit die Daten in das IAsyncResult-Objekt eingebunden werden können, das schließlich an die Rückrufmethode übergeben wird. Dies ist in der Regel nicht erforderlich, wenn die FromAsync-Methoden verwendet werden. Wenn die benutzerdefinierten Daten in der Fortsetzung bekannt sind, können diese direkt im Fortsetzungsdelegaten erfasst werden. Das folgende Beispiel ähnelt dem vorherigen Beispiel, anstatt die Result-Eigenschaft des Vorgängers zu analysieren, ermittelt die Fortsetzung jedoch die benutzerdefinierten Zustandsdaten, auf die der Benutzerdelegat der Fortsetzung direkt zugreifen kann.

public Task<string> GetFileStringAsync2(string path)
{             
    FileInfo fi = new FileInfo(path);
    byte[] data = new byte[fi.Length];                       
    MyCustomState state = GetCustomState();
    FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, data.Length, true);
    // We still pass null for the last parameter because
    // the state variable is visible to the continuation delegate.
    Task<int> task = Task<int>.Factory.FromAsync(
            fs.BeginRead, fs.EndRead, data, 0, data.Length, null);

    return task.ContinueWith((antecedent) =>
    {
        // It is safe to close the filestream now.
        fs.Close();

        // Capture custom state data directly in the user delegate.
        // No need to pass it through the FromAsync method.
        if (state.StateData.Contains("New York, New York"))
        {
            return "Start spreading the news!";
        }
        else
        {
            // If we did not receive the entire file, the end of the
            // data buffer will contain garbage.
            if (antecedent.Result < data.Length)
                Array.Resize(ref data, antecedent.Result);

            // Will be returned in the Result property of the Task<string>
            // at some future point after the asynchronous file I/O operation completes.
            return new UTF8Encoding().GetString(data);
        }
    });

}

Die statischen Methoden ContinueWhenAll und ContinueWhenAny bieten bei Verwendung mit den FromAsync-Methoden eine höhere Flexibilität. Im folgenden Beispiel wird gezeigt, wie Sie mehrere asynchrone E/A-Vorgänge initiieren und anschließend auf den Abschluss all dieser Vorgänge warten, bevor die Fortsetzung ausgeführt wird.

public Task<string> GetMultiFileData(string[] filesToRead)
{
    FileStream fs;
    Task<string>[] tasks = new Task<string>[filesToRead.Length];
    byte[] fileData = null;
    for (int i = 0; i < filesToRead.Length; i++)
    {
        fileData = new byte[0x1000];
        fs = new FileStream(filesToRead[i], FileMode.Open, FileAccess.Read, FileShare.Read, fileData.Length, true);

        // By adding the continuation here, the 
        // Result of each task will be a string.
        tasks[i] = Task<int>.Factory.FromAsync(
                 fs.BeginRead, fs.EndRead, fileData, 0, fileData.Length, null)
                 .ContinueWith((antecedent) =>
                     {
                         fs.Close();

                         // If we did not receive the entire file, the end of the
                         // data buffer will contain garbage.
                         if (antecedent.Result < fileData.Length)
                             Array.Resize(ref fileData, antecedent.Result);

                         // Will be returned in the Result property of the Task<string>
                         // at some future point after the asynchronous file I/O operation completes.
                         return new UTF8Encoding().GetString(fileData);
                     });
    }

    // Wait for all tasks to complete. 
    return Task<string>.Factory.ContinueWhenAll(tasks, (data) =>
    {
        // Propagate all exceptions and mark all faulted tasks as observed.
        Task.WaitAll(data);

        // Combine the results from all tasks.
        StringBuilder sb = new StringBuilder();
        foreach (var t in data)
        {
            sb.Append(t.Result);
        }
        // Final result to be returned eventually on the calling thread.
        return sb.ToString();
    });

}

In den wenigen Fällen, in denen die Begin-Methode mehr als drei Eingabeparameter erfordert oder über den ref-Parameter bzw. out-Parameter verfügt, können Sie die FromAsync-Überladungen verwenden, z. B. TaskFactory<TResult>.FromAsync(IAsyncResult, Func<IAsyncResult, TResult>), die nur die End-Methode darstellen. Diese Methoden können zudem in jedem Szenario verwendet werden, in dem ein IAsyncResult übergeben wurde, das in einer Aufgabe gekapselt werden soll.

static Task<String> ReturnTaskFromAsyncResult()
{
    IAsyncResult ar = DoSomethingAsynchronously();
    Task<String> t = Task<string>.Factory.FromAsync(ar, _ =>
        {
            return (string)ar.AsyncState;
        });

    return t;
}

Die von einer FromAsync-Methode zurückgegebene Aufgabe hat den Status "WaitingForActivation" und wird vom System gestartet, nachdem die Aufgabe erstellt wurde. Wenn Sie versuchen, eine solche Aufgabe zu starten, wird eine Ausnahme ausgelöst.

Sie können eine FromAsync-Aufgabe nicht abbrechen, da die zugrunde liegenden .NET Framework-APIs keinen Abbruch von laufenden Datei- oder Netzwerk-E/A unterstützen. Sie können Abbruchfunktionalität zu einer Methode hinzufügen, die einen FromAsync-Aufruf kapselt, Sie können jedoch nur vor dem Aufruf oder nach dem Abschluss von FromAsync (z. B. in einer Fortsetzungsaufgabe) auf den Abbruch reagieren.

Einige Klassen mit EAP-Unterstützung, z. B. WebClient, unterstützen einen Abbruch. Diese systemeigene Abbruchfunktionalität können Sie mithilfe von Abbruchtokens integrieren.

Der TPL stellt keine Methoden bereit, die speziell zum Kapseln ereignisbasierter asynchroner Vorgänge geeignet sind, wie dies bei der FromAsync-Methodenfamilie und dem IAsyncResult-Muster der Fall ist. Die TPL bietet jedoch die System.Threading.Tasks.TaskCompletionSource<TResult>-Klasse, mit der ein beliebiger Satz von Vorgängen als Task<TResult> dargestellt werden kann. Die Vorgänge können sowohl synchron als auch asynchron sein und sind entweder E/A-gebunden und/oder rechnergebunden.

Im folgenden Beispiel wird gezeigt, wie Sie TaskCompletionSource<TResult> verwenden, um einen Satz asynchroner WebClient-Vorgänge für Clientcode als grundlegende Task<TResult> verfügbar zu machen. Die Methode ermöglichen die Eingabe eines Arrays von Web-URLs und eines zu suchenden Begriffs oder Namens und geben dann an, wie oft der Suchbegriff in jeder Site vorkommt.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Threading;
using System.Threading.Tasks;

public class SimpleWebExample
{
  public Task<string[]> GetWordCountsSimplified(string[] urls, string name,
                                                CancellationToken token)
  {
      TaskCompletionSource<string[]> tcs = new TaskCompletionSource<string[]>();
      WebClient[] webClients = new WebClient[urls.Length];
      object m_lock = new object();
      int count = 0;
      List<string> results = new List<string>();

      // If the user cancels the CancellationToken, then we can use the
      // WebClient's ability to cancel its own async operations.
      token.Register(() =>
      {
          foreach (var wc in webClients)
          {
              if (wc != null)
                  wc.CancelAsync();
          }
      });


      for (int i = 0; i < urls.Length; i++)
      {
          webClients[i] = new WebClient();

          #region callback
          // Specify the callback for the DownloadStringCompleted
          // event that will be raised by this WebClient instance.
          webClients[i].DownloadStringCompleted += (obj, args) =>
          {

              // Argument validation and exception handling omitted for brevity.

              // Split the string into an array of words,
              // then count the number of elements that match
              // the search term.
              string[] words = args.Result.Split(' ');
              string NAME = name.ToUpper();
              int nameCount = (from word in words.AsParallel()
                               where word.ToUpper().Contains(NAME)
                               select word)
                              .Count();

              // Associate the results with the url, and add new string to the array that
              // the underlying Task object will return in its Result property.
              lock (m_lock)
              {
                 results.Add(String.Format("{0} has {1} instances of {2}", args.UserState, nameCount, name));

                 // If this is the last async operation to complete,
                 // then set the Result property on the underlying Task.
                 count++;
                 if (count == urls.Length)
                 {
                    tcs.TrySetResult(results.ToArray());
                 }
              }
          };
          #endregion

          // Call DownloadStringAsync for each URL.
          Uri address = null;
          address = new Uri(urls[i]);
          webClients[i].DownloadStringAsync(address, address);

      } // end for

      // Return the underlying Task. The client code
      // waits on the Result property, and handles exceptions
      // in the try-catch block there.
      return tcs.Task;
   }
}

Ein umfassenderes Beispiel, in dem auch die Ausnahmebehandlung und das Aufrufen der Methode im Clientcode beschrieben wird, finden Sie unter How to: Wrap EAP Patterns in a Task.

Beachten Sie, dass alle durch TaskCompletionSource<TResult> erstellten Aufgaben von dieser TaskCompletionSource gestartet werden. Der Benutzercode sollte daher für diese Aufgaben nicht die Start-Methode aufrufen.

In einigen Fallen ist es möglicherweise wünschenswert, das IAsyncResult-Muster durch Verwendung von Begin/End-Methodenpaaren in einer API direkt verfügbar zu machen. Dies kann beispielsweise erforderlich sein, wenn Sie die Konsistenz mit vorhandenen APIs aufrecht erhalten möchten oder wenn Sie über automatisierte Tools verfügen, die dieses Muster voraussetzen. In diesen Fällen können Sie mithilfe von Aufgaben die interne Implementierung des APM-Musters vereinfachen.

Im folgenden Beispiel wird gezeigt, wie Sie mithilfe von Aufgaben ein APM Begin/End-Methodenpaar für eine rechnergebundene Methode mit langer Laufzeit implementieren.

class Calculator
{
    public IAsyncResult BeginCalculate(int decimalPlaces, AsyncCallback ac, object state)
    {
        Console.WriteLine("Calling BeginCalculate on thread {0}", Thread.CurrentThread.ManagedThreadId);
        Task<string> f = Task<string>.Factory.StartNew(_ => Compute(decimalPlaces), state);
        if (ac != null) f.ContinueWith((res) => ac(f));
        return f;
    }

    public string Compute(int numPlaces)
    {
        Console.WriteLine("Calling compute on thread {0}", Thread.CurrentThread.ManagedThreadId);

        // Simulating some heavy work.
        Thread.SpinWait(500000000);

        // Actual implemenation left as exercise for the reader.
        // Several examples are available on the Web.
        return "3.14159265358979323846264338327950288";
    }

    public string EndCalculate(IAsyncResult ar)
    {
        Console.WriteLine("Calling EndCalculate on thread {0}", Thread.CurrentThread.ManagedThreadId);
        return ((Task<string>)ar).Result;
    }
}

public class CalculatorClient
{
    static int decimalPlaces = 12;
    public static void Main()
    {
        Calculator calc = new Calculator();
        int places = 35;

        AsyncCallback callBack = new AsyncCallback(PrintResult);
        IAsyncResult ar = calc.BeginCalculate(places, callBack, calc);

        // Do some work on this thread while the calulator is busy.
        Console.WriteLine("Working...");
        Thread.SpinWait(500000);
        Console.ReadLine();
    }

    public static void PrintResult(IAsyncResult result)
    {
        Calculator c = (Calculator)result.AsyncState;
        string piString = c.EndCalculate(result);
        Console.WriteLine("Calling PrintResult on thread {0}; result = {1}",
                    Thread.CurrentThread.ManagedThreadId, piString);
    }
}

Die Datei "Streamextensions.cs" unter Beispiele zur parallelen Programmierung mit .NET Framework 4 auf der MSDN-Website enthält mehrere Referenzimplementierungen, in denen Aufgabenobjekte für asynchrone Datei- und Netzwerk-E/A verwendet werden.

Anzeigen: