当前位置：首页 > article >正文

windows C#-异步返回类型(上)

article 2024/11/22 15:51:37

异步方法可以具有以下返回类型：

Task(对于执行操作但不返回任何值的异步方法)。
Task<TResult>(对于返回值的异步方法)。
void(对于事件处理程序)。
任何具有可访问的 GetAwaiter 方法的类型。 GetAwaiter 方法返回的对象必须实现 System.Runtime.CompilerServices.ICriticalNotifyCompletion 接口。
IAsyncEnumerable<T>(对于返回异步流的异步方法)。

还存在特定于 Windows 工作负载的其他几种类型：

DispatcherOperation，适用于仅限于 Windows 的异步操作。
IAsyncAction，适用于 UWP 中不返回值的异步操作。
IAsyncActionWithProgress<TProgress>，适用于 UWP 中只报告进程但不返回值的异步操作。
IAsyncOperation<TResult>，适用于 UWP 中返回值的异步操作。
IAsyncOperationWithProgress<TResult,TProgress>，适用于 UWP 中既报告进程又返回值的异步操作。

Task 返回类型

不包含 return 语句的异步方法或包含不返回操作数的 return 语句的异步方法通常具有返回类型 Task。如果此类方法同步运行，它们将返回 void。如果在异步方法中使用 Task 返回类型，调用方法可以使用 await 运算符暂停调用方的完成，直至被调用的异步方法结束。

下例中的 WaitAndApologizeAsync 方法不包含 return 语句，因此该方法会返回 Task 对象。返回 Task 可等待 WaitAndApologizeAsync。 Task 类型不包含 Result 属性，因为它不具有任何返回值。

public static async Task DisplayCurrentInfoAsync()
{
    await WaitAndApologizeAsync();

    Console.WriteLine($"Today is {DateTime.Now:D}");
    Console.WriteLine($"The current time is {DateTime.Now.TimeOfDay:t}");
    Console.WriteLine("The current temperature is 76 degrees.");
}

static async Task WaitAndApologizeAsync()
{
    await Task.Delay(2000);

    Console.WriteLine("Sorry for the delay...\n");
}
// Example output:
//    Sorry for the delay...
//
// Today is Monday, August 17, 2020
// The current time is 12:59:24.2183304
// The current temperature is 76 degrees.

通过使用 await 语句而不是 await 表达式等待 WaitAndApologizeAsync，类似于返回 void 的同步方法的调用语句。 Await 运算符的应用程序在这种情况下不生成值。当 await 的右操作数是 Task<TResult> 时，await 表达式生成的结果为 T。当 await 的右操作数是 Task 时，await 及其操作数是一个语句。

可从 await 运算符的应用程序中分离对 WaitAndApologizeAsync 的调用，如以下代码所示。但是，请记住，Task 没有 Result 属性，并且当 await 运算符应用于 Task 时不产生值。

以下代码将调用 WaitAndApologizeAsync 方法和等待此方法返回的任务分离。

Task waitAndApologizeTask = WaitAndApologizeAsync();

string output =
    $"Today is {DateTime.Now:D}\n" +
    $"The current time is {DateTime.Now.TimeOfDay:t}\n" +
    "The current temperature is 76 degrees.\n";

await waitAndApologizeTask;
Console.WriteLine(output);

Task<TResult> 返回类型

Task<TResult> 返回类型用于某种异步方法，此异步方法包含 return 语句，其中操作数是 TResult。

在下面的示例中，GetLeisureHoursAsync 方法包含返回整数的 return 语句。该方法声明必须指定 Task<int> 的返回类型。 FromResult 异步方法是返回 DayOfWeek 的操作的占位符。

public static async Task ShowTodaysInfoAsync()
{
    string message =
        $"Today is {DateTime.Today:D}\n" +
        "Today's hours of leisure: " +
        $"{await GetLeisureHoursAsync()}";

    Console.WriteLine(message);
}

static async Task<int> GetLeisureHoursAsync()
{
    DayOfWeek today = await Task.FromResult(DateTime.Now.DayOfWeek);

    int leisureHours =
        today is DayOfWeek.Saturday || today is DayOfWeek.Sunday
        ? 16 : 5;

    return leisureHours;
}
// Example output:
//    Today is Wednesday, May 24, 2017
//    Today's hours of leisure: 5

在 ShowTodaysInfo 方法中从 await 表达式内调用 GetLeisureHoursAsync 时，await 表达式检索存储在由 GetLeisureHours 方法返回的任务中的整数值(leisureHours 的值)。

通过从应用程序 await 中分离对 GetLeisureHoursAsync 的调用，可以更好地理解 await 如何从 Task<T> 检索结果，如以下代码所示。对非立即等待的方法 GetLeisureHoursAsync 的调用返回 Task<int>，正如你从方法声明预料的一样。该任务指派给示例中的 getLeisureHoursTask 变量。因为 getLeisureHoursTask 是 Task<TResult>，所以它包含类型 TResult 的 Result 属性。在这种情况下，TResult 表示整数类型。 await 应用于 getLeisureHoursTask，await 表达式的计算结果为 getLeisureHoursTask 的 Result 属性内容。此值分配给 ret 变量。

Result 属性为阻止属性。如果你在其任务完成之前尝试访问它，当前处于活动状态的线程将被阻止，直到任务完成且值为可用。在大多数情况下，应通过使用 await 访问此值，而不是直接访问属性。

上一示例通过检索 Result 属性的值来阻止主线程，从而使 Main 方法可在应用程序结束之前将 message 输出到控制台。

var getLeisureHoursTask = GetLeisureHoursAsync();

string message =
    $"Today is {DateTime.Today:D}\n" +
    "Today's hours of leisure: " +
    $"{await getLeisureHoursTask}";

Console.WriteLine(message);

查看全文

http://www.kler.cn/a/404508.html