利用 async & await 進行非同步 IO 操作

【博主】反骨仔　　【出處】http://www.cnblogs.com/liqingwen/p/6082673.html 　　

序　　

　　上次，博主通過《利用 async & await 的非同步編程》這篇點睛之作初步介紹了 async & await 的基本用法及非同步的控制流和一些其它的東西；　　

　　接著，博主通過《怎樣使用 async & await 一步步將同步代碼轉換為非同步編程》這篇隨筆誘導大家如何一步步轉換自己的同步代碼；

　　今天，我們來一起看看如何用非同步進行 IO 操作。

使用非同步特性實現 IO 操作的意義

• 非同步特性有利於增強應用程式的響應能力。因為一個操作的 UI 線程可以執行其他工作。如果 UI 線程需要執行較長時間的代碼(如，> 50ms)，UI 會阻塞到 I/O 完成，這時用戶界麵線程才可以重新處理鍵盤、滑鼠輸入和其他操作。

• 文件訪問操作的延遲在本地也許非常低，但是，我們可以考慮一下文件在非本地時進行的操作。例如，文件可能會存放位於遠程的伺服器。

• 使用非同步額外增加的開銷很小。

• 非同步任務可以並行運行。

使用 FileStream 類

　　示例使用 FileStream 類，它具有一個 option 導致非同步 I/O 發生在操作系統級別。使用此 option，您可以避免在許多情況下阻塞線程池線程。若要啟用該 option，則指定 useAsync = true 或在構造函數中進行參數調用。

　　不能設置 StreamReader 和 StreamWriter 的 option，如果直接通過指定文件路徑打開這些文件。但是，您如果想使用該 option，則提供自己 FileStream 類打開的 Stream。 請註意，非同步調用是在 UI app，即使線程池線程阻塞，在 await 期間，用戶界麵線程也不會被阻塞。

編寫文本

　　下麵的示例是將文本寫入到文件。在每個 await 語句中，都會立即退出。當文件 I/O 完成時，方法會執行 await 語句後面的語句。請註意非同步修飾符在使用 await 語句方法的定義。

1         private async void btnWrite_Click(object sender, RoutedEventArgs e)
2         {
3             await WriteTextAsync();
4         }

 1         /// <summary>
 2         /// 非同步寫入文件
 3         /// </summary>
 4         /// <returns></returns>
 5         private async Task WriteTextAsync()
 6         {
 7             var path = $"temp.txt";
 8             var content = Guid.NewGuid().ToString();
 9 
10             using (var fs = new FileStream(path,
11                 FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.None, bufferSize: 4096, useAsync: true))
12             {
13                 var buffer = Encoding.UTF8.GetBytes(content);
14 
15                 //var writeTask = fs.WriteAsync(buffer, 0, buffer.Length);
16                 //await writeTask;
17                 await fs.WriteAsync(buffer, 0, buffer.Length);
18             }
19         }

　　行號 17 的語句可以修改為：

1   //await fs.WriteAsync(buffer, 0, buffer.Length);
2   //可以改為
3   var writeTask = fs.WriteAsync(buffer, 0, buffer.Length);
4   await writeTask;

　　第一個語句（行號 1）返回任務並導致進程的文件。使用等待的第二個語句（行號3、4）導致方法立即退出並返回其他任務。當隨後處理的文件完成時，執行回 await 的語句。 

讀取文本

　　下麵的示例是從文件中讀取文本。將文本緩衝區的內容放入 StringBuilder。不同於在前面的示例，會不斷 await 一個讀取的長度值。ReadAsync 方法返回 Task<Int32>，即 Task<int>，因此，等待的計算生成一個 Int32 值(numRead)，在操作完成之後。

 1         /// <summary>
 2         /// 非同步讀取文本
 3         /// </summary>
 4         /// <param name="fileName"></param>
 5         /// <returns></returns>
 6         private async Task<string> ReadTextAsync(string fileName)
 7         {
 8             using (var fs = new FileStream(fileName,
 9                 FileMode.OpenOrCreate, FileAccess.Read, FileShare.None, bufferSize: 4096, useAsync: true))
10             {
11                 var sb = new StringBuilder();
12                 var buffer = new byte[0x1000];  //十六進位 等於十進位的 4096
13                 var readLength = 0;
14 
15                 while ((readLength = await fs.ReadAsync(buffer, 0, buffer.Length)) != 0)
16                 {
17                     var text = Encoding.UTF8.GetString(buffer, 0, readLength);
18                     sb.Append(text);
19                 }
20 
21                 return sb.ToString();
22             }
23         }

 1         private async void btnRead_Click(object sender, RoutedEventArgs e)
 2         {
 3             var fileName = $"temp.txt";
 4             if (!File.Exists(fileName))
 5             {
 6                 Debug.WriteLine($"文件找不到：{fileName}");
 7                 return;
 8             }
 9 
10             try
11             {
12                 var content = await ReadTextAsync(fileName);
13                 Debug.WriteLine(content);
14             }
15             catch (Exception ex)
16             {
17                 Debug.WriteLine(ex.Message);
18             }
19         }

並行非同步 I/O

　　在任務完成後，進入 finally 塊的將所有 FileStream 實例進行清理回收。如果直接在 using 語句中創建 FileStream 實例，則 FileStream 實例可能在任務完成之前就被處理。

　　【註意】所有性能提高幾乎完全是非同步並行處理。非同步的優點是它不會占用多個線程，也就是說，它不會占用用戶界麵線程。

 1         /// <summary>
 2         /// 非同步寫入多個文件
 3         /// </summary>
 4         /// <param name="folder"></param>
 5         /// <returns></returns>
 6         private async Task WriteMultiTextAsync(string folder)
 7         {
 8             var tasks = new List<Task>();
 9             var fileStreams = new List<FileStream>();
10 
11             try
12             {
13                 for (int i = 1; i <= 10; i++)
14                 {
15                     var fileName = Path.Combine(folder, $"{i}.txt");
16                     var content = Guid.NewGuid().ToString();
17                     var buffer = Encoding.UTF8.GetBytes(content);
18 
19                     var fs = new FileStream(fileName,
20         FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.None, bufferSize: 4096, useAsync: true);
21                     fileStreams.Add(fs);
22 
23                     var writeTask = fs.WriteAsync(buffer, 0, buffer.Length);
24                     tasks.Add(writeTask);
25                 }
26 
27                 await Task.WhenAll(tasks);
28             }
29             finally
30             {
31                 foreach (var fs in fileStreams)
32                 {
33                     fs.Close();
34                     fs.Dispose();
35                 }
36             }
37         }

 1         private async void btnWriteMulti_Click(object sender, RoutedEventArgs e)
 2         {
 3             var folder = $"temp";
 4 
 5             if (!Directory.Exists(folder))
 6             {
 7                 Directory.CreateDirectory(folder);
 8             }
 9 
10             await WriteMultiTextAsync(folder);
11         }

　　在使用 WriteAsync 和 ReadAsync 方案時，你可以指定 CancellationToken，來在中途取消操作。 

　　點我 Demo 下載

同系列的隨筆

• 利用 async & await 的非同步編程

• 怎樣使用 async & await 一步步將同步代碼轉換為非同步編程

• 走進非同步編程的世界 - 開始接觸 async/await

• 走進非同步編程的世界 - 剖析非同步方法（上）

• 走進非同步編程的世界 - 剖析非同步方法（下）

• 走進非同步編程的世界 - 在 GUI 中執行非同步操作