async (odwołanie w C#)async (C# Reference)

Użyj async modyfikator, aby określić, że metoda, wyrażenia lambda, lub metody anonimowej jest asynchroniczna.Use the async modifier to specify that a method, lambda expression, or anonymous method is asynchronous. Jeśli metoda lub wyrażenie jest używany ten modyfikator, nazywa się metody asynchronicznej.If you use this modifier on a method or expression, it's referred to as an async method. W poniższym przykładzie zdefiniowano metodę async o nazwie ExampleMethodAsync:The following example defines an async method named ExampleMethodAsync:

public async Task<int> ExampleMethodAsync()  
{  
    // . . . .  
}  

Jeśli jesteś nowym użytkownikiem programowaniu asynchronicznym lub nie rozumieją, jak korzysta z metody asynchronicznej await — słowo kluczowe do potencjalnie długotrwałej pracy bez blokowania wątku obiektu wywołującego, przeczytaj wprowadzenie w Asynchronous Programming with Async i await.If you're new to asynchronous programming or do not understand how an async method uses the await keyword to do potentially long-running work without blocking the caller’s thread, read the introduction in Asynchronous Programming with async and await. Poniższy kod znajduje się wewnątrz metody asynchronicznej i wywołania HttpClient.GetStringAsync metody:The following code is found inside an async method and calls the HttpClient.GetStringAsync method:

string contents = await httpClient.GetStringAsync(requestUrl);  

Metoda asynchroniczna jest uruchamiana synchronicznie aż do napotkania pierwszego await wyrażenia, w tym momencie metoda jest zawieszona do czasu ukończenia oczekiwane zadanie.An async method runs synchronously until it reaches its first await expression, at which point the method is suspended until the awaited task is complete. W międzyczasie sterowanie jest przekazywane do obiektu wywołującego metody, tak jak pokazano w przykładzie w następnej sekcji.In the meantime, control returns to the caller of the method, as the example in the next section shows.

Jeśli metoda, async modyfikuje słowo kluczowe nie zawiera await wyrażenia lub instrukcji, metoda jest wykonywana synchronicznie.If the method that the async keyword modifies doesn't contain an await expression or statement, the method executes synchronously. Ostrzeżenia kompilatora ostrzega przed wszystkimi metodami asynchronicznymi, które nie zawierają await instrukcji, ponieważ taka sytuacja może wskazywać na błąd.A compiler warning alerts you to any async methods that don't contain await statements, because that situation might indicate an error. Zobacz ostrzeżenie kompilatora (poziom 1) CS4014.See Compiler Warning (level 1) CS4014.

async — Słowo kluczowe jest kontekstowe w tym jest słowem kluczowym tylko wtedy, gdy modyfikuje metodę, wyrażenie lambda lub metodę anonimową.The async keyword is contextual in that it's a keyword only when it modifies a method, a lambda expression, or an anonymous method. W innych kontekstach jest interpretowane jako identyfikator.In all other contexts, it's interpreted as an identifier.

PrzykładExample

Poniższy przykład pokazuje strukturę i przepływ sterowania między programem obsługi zdarzeń asynchronicznych StartButton_Click, a metodą asynchroniczną ExampleMethodAsync.The following example shows the structure and flow of control between an async event handler, StartButton_Click, and an async method, ExampleMethodAsync. Wynikiem metody asynchronicznej jest liczbą znaków strony sieci web.The result from the async method is the number of characters of a web page. Kod jest odpowiedni dla aplikacji Windows Presentation Foundation (WPF) lub aplikacji Windows Store, który zostanie utworzony w programie Visual Studio; Zobacz komentarze w kodzie dotyczące konfiguracji aplikacji.The code is suitable for a Windows Presentation Foundation (WPF) app or Windows Store app that you create in Visual Studio; see the code comments for setting up the app.

Ten kod może działać w programie Visual Studio, jako aplikację Windows Presentation Foundation (WPF) lub aplikację Windows Store.You can run this code in Visual Studio as a Windows Presentation Foundation (WPF) app or a Windows Store app. Potrzebujesz formant przycisku o nazwie StartButton i formant pola tekstowego o nazwie ResultsTextBox.You need a Button control named StartButton and a Textbox control named ResultsTextBox. Pamiętaj, aby ustawić nazwy i obsługi, aby mieć podobny do poniższego:Remember to set the names and handler so that you have something like this:

<Button Content="Button" HorizontalAlignment="Left" Margin="88,77,0,0" VerticalAlignment="Top" Width="75"  
        Click="StartButton_Click" Name="StartButton"/>  
<TextBox HorizontalAlignment="Left" Height="137" Margin="88,140,0,0" TextWrapping="Wrap"   
         Text="&lt;Enter a URL&gt;" VerticalAlignment="Top" Width="310" Name="ResultsTextBox"/>  

Aby uruchomić kod jako aplikację WPF:To run the code as a WPF app:

  • Wklej ten kod do MainWindow klasy w MainWindow.xaml.cs.Paste this code into the MainWindow class in MainWindow.xaml.cs.
  • Dodaj odwołanie do System.Net.Http.Add a reference to System.Net.Http.
  • Dodaj using dyrektywy dla System.Net.Http.Add a using directive for System.Net.Http.

Aby uruchomić kod jako aplikację Windows Store:To run the code as a Windows Store app:

  • Wklej ten kod do MainPage klasy w MainPage.xaml.cs.Paste this code into the MainPage class in MainPage.xaml.cs.
  • Dodaj dyrektywy using dla System.Net.Http i System.Threading.Tasks.Add using directives for System.Net.Http and System.Threading.Tasks.
private async void StartButton_Click(object sender, RoutedEventArgs e)
{
    // ExampleMethodAsync returns a Task<int>, which means that the method  
    // eventually produces an int result. However, ExampleMethodAsync returns  
    // the Task<int> value as soon as it reaches an await.  
    ResultsTextBox.Text += "\n";

    try
    {
        int length = await ExampleMethodAsync();
        // Note that you could put "await ExampleMethodAsync()" in the next line where  
        // "length" is, but due to when '+=' fetches the value of ResultsTextBox, you  
        // would not see the global side effect of ExampleMethodAsync setting the text.  
        ResultsTextBox.Text += String.Format("Length: {0:N0}\n", length);
    }
    catch (Exception)
    {
        // Process the exception if one occurs.  
    }
}

public async Task<int> ExampleMethodAsync()
{
    var httpClient = new HttpClient();
    int exampleInt = (await httpClient.GetStringAsync("http://msdn.microsoft.com")).Length;
    ResultsTextBox.Text += "Preparing to finish ExampleMethodAsync.\n";
    // After the following return statement, any method that's awaiting  
    // ExampleMethodAsync (in this case, StartButton_Click) can get the   
    // integer result.  
    return exampleInt;
}
// The example displays the following output:  
// Preparing to finish ExampleMethodAsync.  
// Length: 53292  

Ważne

Aby uzyskać więcej informacji o zadaniach i kodzie, który jest wykonywany podczas oczekiwania na zadanie, zobacz Asynchronous Programming with async i await.For more information about tasks and the code that executes while waiting for a task, see Asynchronous Programming with async and await. Aby uzyskać pełny przykład WPF wykorzystującego podobne, zobacz instruktażu: Uzyskiwanie dostępu do sieci Web za pomocą Async i Await.For a full WPF example that uses similar elements, see Walkthrough: Accessing the Web by Using Async and Await.

Typy zwracaneReturn Types

Metoda asynchroniczna może mieć następujące typy zwracane:An async method can have the following return types:

  • Task
  • Task<TResult>
  • void, która powinna służyć wyłącznie do obsługi zdarzeń.void, which should only be used for event handlers.
  • Począwszy od C# 7.0, dowolny typ, który jest dostępny GetAwaiter metody.Starting with C# 7.0, any type that has an accessible GetAwaiter method. System.Threading.Tasks.ValueTask<TResult> Typ jest takie wdrożenie.The System.Threading.Tasks.ValueTask<TResult> type is one such implementation. Jest on dostępny, dodając pakiet NuGet System.Threading.Tasks.Extensions.It is available by adding the NuGet package System.Threading.Tasks.Extensions.

Metoda async nie może deklarować w, ref lub się parametrów ani nie może on mieć odwoływać się do wartości zwracanej, ale może wywołać metody które mają takie parametry.The async method can't declare any in, ref or out parameters, nor can it have a reference return value, but it can call methods that have such parameters.

Należy określić Task<TResult> jako zwracany typ metody asynchronicznej Jeśli zwracają instrukcja metody określa operandę typu TResult.You specify Task<TResult> as the return type of an async method if the return statement of the method specifies an operand of type TResult. Możesz użyć Task Jeśli żadna mająca znaczenie wartość jest zwracana, gdy metoda zostanie zakończona.You use Task if no meaningful value is returned when the method is completed. Oznacza to, że wywołanie metody zwraca Task, ale gdy Task zostanie zakończona, wszelkie await wyrażenie, które oczekuje na Task daje w wyniku void.That is, a call to the method returns a Task, but when the Task is completed, any await expression that's awaiting the Task evaluates to void.

Możesz użyć void zwracany typ głównie do definiowania uchwytów zdarzeń, które wymagają typów zwracanych.You use the void return type primarily to define event handlers, which require that return type. Obiekt wywołujący void— metodę asynchroniczną zwracającą nie może oczekiwać i nie może przechwytywać wyjątków, które metoda wygeneruje.The caller of a void-returning async method can't await it and can't catch exceptions that the method throws.

Począwszy od C# 7.0, zwróć inny typ, zwykle typu wartości, która ma GetAwaiter metodę, aby zminimalizować, alokacje pamięci w newralgicznym dla wydajności sekcje kodu.Starting with C# 7.0, you return another type, typically a value type, that has a GetAwaiter method to minimize memory allocations in performance-critical sections of code.

Aby uzyskać więcej informacji i przykładów, zobacz Async Return Types.For more information and examples, see Async Return Types.

Zobacz takżeSee also