CodeGym /課程 /C# SELF /非同步讀寫檔案 ( ReadAsync/ WriteAsync)

非同步讀寫檔案 ( ReadAsync/ WriteAsync)

C# SELF
等級 42, 課堂 1
開放

1. 介紹

想像你是樂團的指揮(你的應用程式)。如果每次小提琴手在調琴(很久的 I/O)你都要等他調好才繼續,整個樂團會卡住。但如果小提琴手說: 「我在調,大家先繼續,等我準備好會跟你們打個訊號」,——這就是非同步!

在 C# 與 .NET 9 的世界裡,為了這種「不卡主線程的多工」有專門的工具。今天的主角是 Read 和 Write 的非同步版本:ReadAsync 與 WriteAsync。

它們讓你啟動讀或寫的操作,然後立刻「放開」當前執行緒,去處理其他事。當 I/O 完成(例如,資料從磁碟讀入或寫入完成),你的程式碼會「醒來」並從停下的地方繼續。

要用這些方法,我們需要兩個魔法字,這兩個字在 2012 年隨 C# 5.0 加入(現在在 C# 14 已經很熟悉了):

  • async:一個修飾詞,附在方法上,告訴編譯器:「這個方法裡可能有非同步操作,我會用 await。」
  • await:在非同步操作(像 ReadAsync 或 WriteAsync)前使用的運算子。它的意思是:「啟動這個操作,但這裡不要阻塞。把控制權交還給呼叫端,等結果好了再回來。」

別擔心,如果現在這些概念還有點模糊。我們會有整個章節專門講 async 與 await(層級 58),會把細節拆開講。現在重要的是:它們幫你避免「鎖住」主線程。

2. ReadAsync:慢慢讀,別急

ReadAsync 允許你非同步地從 stream 讀取資料。不是等到位元組從磁碟讀完,你才繼續;而是啟動讀取後立刻切去做別的事。

下面是它把資料讀到 buffer 時的主要簽名:

public virtual ValueTask<int> ReadAsync(
    byte[] buffer,
    int offset,
    int count,
    CancellationToken cancellationToken = default
)

或者在現代 C#(與 .NET 9)更常用、使用 Memory<byte> 的版本:

public virtual ValueTask<int> ReadAsync(
    Memory<byte> buffer,
    CancellationToken cancellationToken = default
)

解析參數:

  • buffer:這是個 byte 陣列(或 Memory<byte>),用來放讀進來的資料。記得我們說過為了優化會用 buffer?這裡一樣,但用在非同步操作。
  • offset:在 buffer 裡開始寫入讀到的位元組的偏移量。
  • count:要讀的最大位元組數。
  • CancellationToken cancellationToken:很實用的參數,允許你取消操作(例如使用者關掉應用或按下「取消」按鈕)。
  • ValueTask<int>:這是個「承諾」,表示操作完成時會回傳一個整數(int),代表實際讀取的位元組數。ValueTask 是為那些結果可能同步或非同步可得的情況所優化的 Task 替代品。

範例 1:非同步讀檔

假設我們有一個很大的文字檔,要讀它而不阻塞主線程。這是基本範例:

using System;
using System.IO;
using System.Text;
using System.Threading.Tasks;

class Program
{
    // 非同步函式:讀檔並計算行數
    public static async Task<int> CountLinesAsync(string filePath)
    {
        int lineCount = 0;
        // 非同步開啟檔案
        using FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, useAsync: true);
        using StreamReader reader = new StreamReader(fileStream, Encoding.UTF8);

        string? line;
        while ((line = await reader.ReadLineAsync()) != null)
        {
            lineCount++;
        }
        return lineCount;
    }

    static async Task Main()
    {
        string filename = "bigtext.txt";
        int count = await CountLinesAsync(filename);
        Console.WriteLine($"在檔案 {filename} 中的行數:{count}");
    }
}

程式碼備註:

  • 注意 useAsync: true 給 FileStream 的參數。這對真正的非同步很重要。
  • 我們對 ReadLineAsync 使用 await,這樣在讀取一行時不會阻塞執行緒。
  • 方法 Main 現在是非同步的(C# 7+ 支援這樣做)。

如果這是一個實際的 GUI 應用程式,當讀檔(當 ReadAsync 在等待磁碟資料時)使用者仍然可以按按鈕、滾動或做其他操作,因為主 UI 執行緒不會被鎖住。在主控台應用中這點比較不明顯,但原理是一樣的。

3. WriteAsync:寫入不用等

跟 ReadAsync 類似,WriteAsync 讓你非同步地向 stream 寫入資料。當你需要寫入大量資料且不想讓應用卡住時,這非常有用。

主要簽名:

public virtual ValueTask WriteAsync(
    byte[] buffer,
    int offset,
    int count,
    CancellationToken cancellationToken = default
)

以及使用 ReadOnlyMemory<byte>(寫入時我們不會修改 buffer):

public virtual ValueTask WriteAsync(
    ReadOnlyMemory<byte> buffer,
    CancellationToken cancellationToken = default
)

參數跟 ReadAsync 類似:

  • buffer:包含要寫入資料的 byte 陣列(或 ReadOnlyMemory<byte>)。
  • offset:在 buffer 的偏移,從哪裡開始讀取要寫出的資料。
  • count:要寫入的位元組數。
  • CancellationToken cancellationToken:用來取消操作。
  • ValueTask:沒有回傳值,因為寫入的位元組數由 count 決定。

範例 2:非同步寫檔

現在我們來非同步地寫個檔案。

using System;
using System.IO;
using System.Text;
using System.Threading.Tasks;

class Program
{
    public static async Task WriteTestAsync(string filePath)
    {
        using FileStream fs = new FileStream(filePath, FileMode.Create, FileAccess.Write, FileShare.None, 4096, useAsync: true);
        using StreamWriter writer = new StreamWriter(fs, Encoding.UTF8);

        for (int i = 0; i < 10000; i++)
        {
            await writer.WriteLineAsync($"第 {i} 行");
        }
    }

    static async Task Main()
    {
        string filename = "testout.txt";
        await WriteTestAsync(filename);
        Console.WriteLine($"寫入 {filename} 已完成。");
    }
}

這裡的迴圈寫入 10000 行,而主線程沒有被阻塞:如果這是 GUI 應用,介面就不會「當掉」。

靠著 async 與 await,我們的主控台程式可以在做檔案複製時仍然對使用者輸入(像按下 Enter 取消)有反應。這是寫現代、高效且回應迅速的 C# 應用的基礎原則。

4. 有用的小技巧

視覺化:非同步讀/寫怎麼運作


┌───────────────────┐     Start Async Read    ┌────────────────────────────────┐
│你的程式(UI/邏輯)│ ─────────────────────→  │  OS/E/S:非同步操作           │ 
└─────┬─────────────┘                         └───────┬────────────────────────┘
      │(做其他事)                                │(讀檔、等磁碟)
      │<────────────────────────────────────────→│
      └─ 等待 Task,得到結果  ←──────────┘

大概的流程:當磁碟慢慢回應時,你的程式還能做其他事。只有當真的需要資料時,才會等待 Task 完成。

實務應用:哪些時候真的需要?

  • 桌面應用:如果你的程式要讀寫大型檔案(log、資料庫、影片),非同步是必備。就算電腦很快,使用者可能會從網路開檔,那速度可能慢到像烏龜吃午餐。
  • 後端或 Web 應用:同時會有成百上千用戶連到伺服器。如果每個執行緒都被讀檔鎖住,那就會出現延遲和 502 Bad Gateway。非同步能提高可擴展性。
  • 行動應用:開檔或寫資料要花時間,使用者會看到卡頓。用非同步!
  • 任何大量檔案處理:處理一堆檔案(壓縮、解析、分析)的應用,都能從非同步 I/O 中獲益。

同步 vs 非同步 讀/寫

方法 會鎖住執行緒嗎? 實作簡單嗎? 效能最好嗎? 對 UI/伺服器友好嗎?
同步 (Read/Write) 會 是 否 否
非同步 (ReadAsync) 否 幾乎是 是 是

5. 細節與最佳實務

緩衝仍然重要:即使用了 ReadAsync 和 WriteAsync,每次只讀或寫一個位元組仍然非常低效。非同步會避免阻塞,但不會神奇地加速每個位元組的讀寫。常見的起始緩衝大小是 4096–8192 位元組;處理大型檔案時可試試 65536 或 131072。

「非同步一路到底」(Async All The Way Down):如果你在某個地方開始用 async/await,通常應該把這個風格傳到整個呼叫鏈:C 做非同步操作,C 就是 async Task,B 也 async Task,A 也是 async Task。否則可能出現鎖住或 UI 死結。

例外處理:在非同步程式碼裡用正常的 try-catch。常見的有 OperationCanceledException 與 IOException — 要針對它們做明確處理。

釋放資源(await using):正確釋放 stream 與其他 IDisposable 物件。如果型別實作了 IAsyncDisposable,用 await using 會呼叫 DisposeAsync();只有 IDisposable 則會呼叫 Dispose()。

底層發生了什麼(簡要):當你對一個操作使用 await,編譯器會把方法轉成一個狀態機:啟動操作,方法「暫停」,控制權回到呼叫端。當結果就緒時,SynchronizationContext(在 UI)或 ThreadPool(在主控台/伺服器)會從暫停處恢復執行。這讓一個執行緒能處理很多個「暫停」的任務,而不需要阻塞它自己。

總結來說,用 async 和 await 的非同步程式設計,是建立回應迅速且可擴展應用的強大工具。它讓你的程式更有效率地使用系統資源,不會鎖住使用者介面或伺服器的執行緒。剛開始可能會覺得有點不習慣,但相信我,這很值得學會!下一堂我們會繼續深入非同步與平行處理的世界。下次見!

2
任務
C# SELF, 等級 42, 課堂 1
上鎖
非同步寫入大型檔案
非同步寫入大型檔案
留言
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION