async 的三大返回類型

序

　　博主簡單數了下自己發布過的異步文章，已經斷斷續續 8 篇了，這次我想以 async 的返回類型為例，單獨談談。

　　異步方法具有三個可讓開發人員選擇的返回類型：Task<TResult>、Task 和 void。

　　什么時候需要使用哪一種返回類型，具體情況需要具體分析。如果使用不當，程序的執行結果也許並不是你想要的，下面我們就來好好談談如何針對不同的情況選擇不同的返回類型。

一、返回類型 - Task<TResult>

　　【記住】當你添加 async 關鍵字后，需要返回一個將用於后續操作的對象，請使用 Task<TResult>。

　 Task<TResult> 返回類型可用於 async 方法，其中包含指定類型 TResult。

　　在下面的示例中，GetDateTimeAsync 異步方法包含一個返回當前時間的 return 語句。因此，方法聲明必須指定 Task<DateTime>。

        async Task<DateTime> GetDateTimeAsync()
        {
            //Task.FromResult 是一個占位符，類型為 DateTime
            return await Task.FromResult(DateTime.Now);
        }

　　調用 GetDateTimeAsync 方法：

        async Task CallAsync()
        {
            //在另一個異步方法的調用方式
            DateTime now = await GetDateTimeAsync();
        }

　　當 GetDateTimeAsync 從 await 表達式中調用時，await 表達式將檢索存儲在由 GetDateTimeAsync 返回的 task 中的 DateTime 類型值。

        async Task CallAsync()
        {
            //在另一個異步方法的調用方式
            //DateTime now = await GetDateTimeAsync();

            //換種方式調用
            Task<DateTime> t = GetDateTimeAsync();
            DateTime now = await t;
        }

　　通過 CallAsync 方法對 GetDateTimeAsync 方法的調用，對非立即等待的方法 GetDateTimeAsync 的調用返回 Task<DateTime>。該任務指派給示例中的 DateTime 的 Task 變量。因為 DateTime 的 Task 變量是 Task<DateTime>，也就是說這里的 TResult 就是 DateTime 類型。在這種情況下，TResult 表示日期類型。當 await 應用於 Task<DateTime>，await 表達式的計算結果為 Task<DateTime> 的 DateTime 類型的內容。同時，該值會分配給 now 變量。

　　這次我演示不同的變量，你可以自己對比下結果是否相同：

        async Task CallAsync()
        {
            //在另一個異步方法的調用方式
            DateTime now = await GetDateTimeAsync();

            //換種方式調用
            Task<DateTime> t = GetDateTimeAsync();
            DateTime now2 = await t;
 　　　　　　 
　　　　　　　//輸出的結果對比
            Console.WriteLine($"now: {now}");
            Console.WriteLine($"now2: {now2}");
            Console.WriteLine($"t.Result: {t.Result}");
        }

　　我這邊可以給出的答案就是：結果是一樣的。

　　【注意】主要有兩種方式獲取結果值，一個是使用 Result 屬性，一個是使用 await。他們的區別在於：如果你使用的是 Result，它帶有阻塞性。即在任務完成之前進行訪問讀取它，當前處於活動狀態的線程都會出現阻塞的情形，一直到結果值可用。所以，在絕大多數情況下，除非你有絕對的理由告訴自己，否則都應該使用 await，而不是屬性 Result 來讀取結果值。

二、返回類型 - Task

　　【記住】你如果只是想知道執行的狀態，而不需要一個具體的返回結果時，請使用 Task。

　　一個返回類型為 Task 類型的異步方法，它的具體實現不應該包含 return 語句，或者說是一個 return void 的語句。這個 Task 類型是不包含屬性 Result 的。跟 Task<TResult> 調用一樣，調用方法直接使用 await 掛起並等待異步方法的執行完畢。

　　請看示例：

        async Task DelayAsync()
        {
            //Task.Delay 是一個占位符，用於假設方法正處於工作狀態。
            await Task.Delay(100);

            Console.WriteLine("OK!");
        }

　　通過使用 await 語句而不是 await 表達式來調用和等待 DelayAsync 方法，類似於返回 void 的方法的調用語句。 await 運算符的應用程序在這種情況下不生成值。

　　請看調用 DelayAsync 的示例。

            //調用和等待方法在同一聲明中
            await DelayAsync();

　　現在，我用將調用和等待的方法進行分離：

            //分離
            Task delayTask = DelayAsync();

            await delayTask;

三、返回類型 - void

　　【記住】如果在觸發后，你懶得管，請使用 void。如事件處理程序（主要用途）。

　　void 返回類型主要用在事件處理程序中，一種稱為“fire and forget”（觸發並忘記）的活動的方法。除了它之外，我們都應該盡可能是用 Task，作為我們異步方法的返回值。

　　返回 void，意味着不能 await 該異步方法，即可能出現線程阻塞，並且也無法獲取 exception，拋出的異常，通常這些異常會導致我們的程序失敗，如果你使用的是 Task 和 Task<Result>，catch 到的異常會包裝在屬性里面，調用方法就可以從中獲取異常信息，並選擇正確的處理方式。

　　現在，異常也可以使用 await 了，請移步到這里《回眸 C# 的前世今生 - 見證 C# 6.0 的新語法特性》。

　　void 返回值示例：

        private async void button1_Click(object sender, EventArgs e)
        {
            //啟動進程並等待完成
            await Task.Delay(100);
        }

小結

當你添加 async 關鍵字后，需要返回一個將用於后續操作的對象，請使用 Task<TResult>；
你如果只是想知道執行的狀態，而不需要知道具體的返回結果時，請使用 Task；
如果在觸發后，你懶得管，請使用 void。
請盡量優先使用 Task<TResult> 和 Task 作為異步方法的返回類型。

異步編程的系列

【博主】反骨仔

【出處】http://www.cnblogs.com/liqingwen/p/6218994.html

【參考】https://docs.microsoft.com/en-us/dotnet/articles/csharp/programming-guide/concepts/async/async-return-types

【參考】微軟官方文檔

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 C# WebApi之接口返回類型詳解 c# WebApi之接口返回類型詳解 C# async關鍵字會把string返回值自動轉換為Task C# await async Task C#中的async/await C# async等待和不等待 C# 徹底搞懂async/await C#中await/async閑說 C# Async await和Task的關系 C# 徹底搞懂async/await

[C#] async 的三大返回類型