CodeGym /課程 /C# SELF /安全地讀取與寫入檔案

安全地讀取與寫入檔案

C# SELF
等級 38, 課堂 4
開放

1. 介紹

在程式設計中,對檔案操作的「安全性」不只是防毒或防駭,而是要妥善處理錯誤、鎖定、存取權限、錯誤路徑等各種陷阱。不小心會導致資料遺失、程式當機、奇怪的 bug 或著名的例外 IOException。

下面是我們想要能處理的典型情況:

  • 檔案不存在,但我們嘗試去讀取(或相反:檔案已存在,而我們想用「只有不存在時才建立」的模式寫入)。
  • 檔案被其他程式開啟並鎖住。
  • 使用者沒有該檔案或資料夾的讀寫權限。
  • 檔案路徑錯誤或包含禁止的字元。
  • 操作在中途被中斷(例如磁碟空間耗盡)。
  • 不良做法:留下未關閉的檔案或不關閉 stream。

幸好,.NET 提供了解決這些問題的所有工具。它們很簡單——但就像安全帶一樣,重點是別忘了繫上。

2. 安全處理檔案的基本原則

事先檢查檔案是否存在與存取權限

在讀取檔案前,先確認它存在(例如用 File.Exists),尤其當路徑是從使用者那邊拿來的時候:

string path = "test.txt";
if (!File.Exists(path))
{
    Console.WriteLine("錯誤:檔案未找到。");
    return;
}

在寫入前,確認目錄存在且你有寫入權限(或者把錯誤拋到上層處理)。

千萬別把 stream 留開著

使用關鍵字 using 來自動關閉 stream——這是最佳實務:

using var writer = new StreamWriter("output.txt");
writer.WriteLine("Hello, files!");
// 這裡即使發生錯誤,檔案也已經被關閉!

這可以防止「鎖住」或資源洩漏的問題。

一定要捕捉例外

任何檔案操作都可能拋出例外。即使檔案剛剛還在——也可能在存取時被刪掉或移動。使用 try-catch 結構:

try
{
    using var reader = new StreamReader("data.txt");
    string line = reader.ReadLine();
    Console.WriteLine(line);
}
catch (FileNotFoundException)
{
    Console.WriteLine("檔案未找到。");
}
catch (UnauthorizedAccessException)
{
    Console.WriteLine("沒有對檔案的存取權。");
}
catch (IOException ex)
{
    Console.WriteLine($"I/O 錯誤:{ex.Message}");
}

不要相信使用者輸入

如果檔案路徑是使用者輸入的,可能會有錯誤(或有人想搞你的程式)。建議驗證路徑(參見 Path.GetInvalidPathChars()):

try
{
    string userPath = Console.ReadLine()!;
    if (string.IsNullOrWhiteSpace(userPath))
    {
        Console.WriteLine("路徑不能是空的!");
        return;
    }
    // 額外:檢查禁止字元
    foreach (char c in Path.GetInvalidPathChars())
        if (userPath.Contains(c))
        {
            Console.WriteLine("路徑包含不允許的字元。");
            return;
        }
    // 接下來就可以安全地操作檔案
}
catch (Exception ex)
{
    Console.WriteLine("路徑驗證錯誤: " + ex.Message);
}

3. 實作範例:用成熟的方式讀檔

我們來稍微強化一下教學專案。假設我們要讀取使用者輸入名稱的檔案,並把內容輸出到螢幕。全部都要有錯誤處理並考慮編碼。

Console.Write("請輸入檔案路徑: ");
string? path = Console.ReadLine();

// 路徑驗證
if (string.IsNullOrWhiteSpace(path))
{
    Console.WriteLine("路徑不能是空的!");
    return;
}
foreach (char c in Path.GetInvalidPathChars())
    if (path.Contains(c))
    {
        Console.WriteLine("路徑包含不允許的字元。");
        return;
    }

// 嘗試讀取檔案
try
{
    if (!File.Exists(path))
    {
        Console.WriteLine("檔案未找到。");
        return;
    }

    // 明確指定編碼(例如 UTF-8)
    using var reader = new StreamReader(path, Encoding.UTF8);
    string content = reader.ReadToEnd();
    Console.WriteLine("檔案內容:");
    Console.WriteLine(content);
}
catch (UnauthorizedAccessException)
{
    Console.WriteLine("沒有讀取該檔案的權限。");
}
catch (IOException ex)
{
    Console.WriteLine("I/O 錯誤: " + ex.Message);
}
catch (Exception ex)
{
    Console.WriteLine("未預期的錯誤: " + ex.Message);
}

注意:如果檔案在輸入名稱和讀取之間被刪除,這段程式也不會崩潰:例外會被捕捉。離開 using 區塊時 stream 會自動關閉——即便發生錯誤。

4. 寫入檔案:避免資料遺失

當我們以寫入模式開啟檔案,特別是在覆寫模式下(在 StreamWriter 建構子的第二個參數設為 false),有風險會不小心覆蓋重要資料。這裡有幾個建議:

檢查你是否會覆寫已存在的檔案

有時問使用者一次會比較好:

if (File.Exists(path))
{
    Console.WriteLine("注意:檔案已存在。要覆寫嗎? (y/n)");
    string answer = Console.ReadLine()!;
    if (!answer.Equals("y", StringComparison.OrdinalIgnoreCase))
        return;
}

需要的地方用 append 模式(追加)

using var writer = new StreamWriter("log.txt", append: true);
writer.WriteLine(DateTime.Now + ": 新的日誌條目。");

舊資料就不會消失。

5. 避免競爭與衝突

有時候多個程式會同時開啟同一個檔案(例如你的 C# 用戶端和 Notepad++)。這會導致錯誤。預設情況下 StreamReader 和 StreamWriter 使用基於 FileShare 的共用模式——也就是說要麼允許他人讀取,要麼不允許。

你也可以明確控制它:

using var stream = new FileStream("data.txt", FileMode.Open, FileAccess.Read, FileShare.Read);
using var reader = new StreamReader(stream, Encoding.UTF8);
// 讀取...
  • FileShare.Read:其他人只能讀取。
  • FileShare.None:不允許任何共用 —— 檔案完全「屬於你」。

如果需要讓檔案同時被多個程式讀寫,請選擇合適的模式,但要小心:通常只有在很確定後果時才這麼做。

6. 預期外的例外以及處理方式

即便你嚴格遵守所有建議,還是可能遇到一些像是磁碟空間不足、壞掉的隨身碟或病毒造成的故障。以下幾種「特殊」例外與如何捕捉它們:

  • PathTooLongException — 檔案路徑太長(在舊版 Windows 中超過 260 個字元)。
  • DirectoryNotFoundException — 指定的目錄未找到。
  • DriveNotFoundException — 例如路徑是 "Z:\\file.txt"、但 Z 磁碟不存在。
  • NotSupportedException — 例如路徑含有不支援的組合。

建議對這類例外做單獨處理——至少把它們分別記錄下來。

7. 用暫存檔實現原子寫入

經典問題:在寫入檔案時程式當機了,結果得到一個毀損的檔案。專業程式通常採用「原子」寫入策略:

  1. 先把內容寫到暫存檔(例如 "file.txt.tmp")。
  2. 把暫存檔移動(在檔案系統層面通常是原子操作)去覆蓋目標檔(使用 File.Replace)。
  3. 要么舊檔被完全替換,要么保持不變 —— 不會出現半壞的資料。

範例:

string tempPath = path + ".tmp";
try
{
    using var writer = new StreamWriter(tempPath, false, Encoding.UTF8);
    // 把所有東西寫進暫存檔
    writer.Write(contentForSave);
    // 成功寫入後替換主檔案
    File.Replace(tempPath, path, null); // 移動暫存檔並替換目標(原子操作)
}
catch (Exception ex)
{
    Console.WriteLine("儲存檔案錯誤: " + ex.Message);
    // 如果不需要,建議刪除 tempPath
}

很多編輯器和辦公套件在真實環境中都這麼做,以保證資料的一致性。

8. 使用包裝類別以安全存取

.NET 有一些協助進行「安全」檔案操作的便利方法。例如 File.ReadAllText 和 File.WriteAllText 會自動打開、讀/寫並關閉檔案。但即便使用它們,也要用 try-catch 包起來:

try
{
    string text = File.ReadAllText("settings.json", Encoding.UTF8);
    // 處理資料...
}
catch (Exception ex)
{
    Console.WriteLine("檔案操作錯誤: " + ex.Message);
}

對於大型檔案,使用 streams 並分段讀取,以免吃光記憶體。

2
任務
C# SELF, 等級 38, 課堂 4
上鎖
安全寫入檔案
安全寫入檔案
1
問卷/小測驗
常見例外狀況,等級 38,課堂 4
未開放
常見例外狀況
處理檔案時的錯誤處理
留言
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION