1. 前言
我們之前已經認識過 stream(Stream),它就是一種抽象,讓你可以順序讀寫資料。我們用過 FileStream 來存取檔案的位元層級,也用過 StreamReader 跟 StreamWriter 來方便處理文字資料,其實它們底層也是靠 FileStream,還會幫你處理編碼問題。
但如果我們想在檔案裡存的不只是文字,而是強型別的資料:整數(int)、浮點數(double、float)、布林值(bool)、日期(DateTime)甚至自訂 struct?當然你可以把這些都轉成字串用 StreamWriter 寫進去,再讀出來時自己 parse 回來。但這種做法有幾個大問題:
- 儲存效率低: 數字 12345 如果用文字寫進去會佔 5 個位元組(字元),但用二進位 int 只要 4 個位元組。資料量大時差很多。
- 效能: 數字和字串之間一直轉換,CPU 會很忙。
- 資料精確度: 浮點數轉成字串再轉回來,可能會因為四捨五入而失真。
- 解析麻煩: 你要自己拆解文字字串來還原各種型別(像 "123,45 TRUE 2024-06-21"),程式碼會變得很難維護又容易壞。
為了解決這些問題,C# 有專門的 BinaryReader 跟 BinaryWriter。這兩個 class 是專門的 adapter,可以套在任何 Stream(最常見是 FileStream)上,然後提供一堆方便的方法,讓你直接用 C# 的基本型別來讀寫二進位格式。它們會自動幫你把位元組轉成對應型別,或反過來,讓你處理結構化二進位檔案超簡單。
重點: BinaryReader 跟 BinaryWriter 不是自己獨立的 stream。它們是加強現有 Stream 的功能,讓你可以直接用 C# 型別操作,不用自己處理 raw bytes。
2. 用 BinaryWriter 寫資料
BinaryWriter 有一堆 Write() 方法,針對每種 C# 基本型別都 overload 過。你呼叫這些方法時,BinaryWriter 會把值轉成對應的二進位(byte sequence),然後寫進底層 Stream。
範例:儲存遊戲設定
假設我們要存遊戲設定:音量(float)、玩家等級(int)、音樂有沒有開(bool)、難度(string)。
string filePath = "settings.bin";
// 1. 建立 FileStream 來寫檔
using FileStream fs = new FileStream(filePath, FileMode.Create, FileAccess.Write);
// 2. 在 FileStream 上面套 BinaryWriter,記得指定字串的編碼
using BinaryWriter writer = new BinaryWriter(fs, Encoding.UTF8);
// 3. 寫入各種型別的資料
writer.Write(0.75f); // float (4 bytes)
writer.Write(15); // int (4 bytes)
writer.Write(true); // bool (1 byte)
writer.Write("Easy"); // string (長度前綴 + bytes)
Console.WriteLine($"設定已儲存到 '{filePath}'。");
範例說明:
- 我們用 FileStream 搭配 FileMode.Create,這樣會新建檔案或覆蓋原本的。
- 然後建立 BinaryWriter,把 fs 傳進去。注意 BinaryWriter 預設在 Dispose()(會被 using 自動呼叫)時也會關掉底層 stream(fs)。
- writer.Write() 方法很直覺:Write(float)、Write(int)、Write(bool)、Write(string)。它們自己知道要寫幾個 bytes、怎麼轉換。
- 對字串來說,BinaryWriter 會自動在字串 bytes 前面加長度前綴。這樣 BinaryReader 讀的時候就知道要讀幾個 bytes 才能還原字串。
- 你如果用文字編輯器打開 settings.bin 只會看到亂碼,因為這是二進位檔。要看內容要用 HEX 編輯器。
3. 用 BinaryReader 讀資料
BinaryReader 有一堆 ReadXxx() 方法(像 ReadInt32()、ReadBoolean()、ReadString()),會從底層 Stream 讀出對應數量的 bytes,然後轉成你要的 C# 型別。
範例:載入遊戲設定
現在我們來讀剛剛寫進 settings.bin 的設定。
string filePath = "settings.bin";
// 1. 建立 FileStream 來讀檔
using FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read);
// 2. 在 FileStream 上面套 BinaryReader,記得用一樣的編碼
using BinaryReader reader = new BinaryReader(fs, Encoding.UTF8);
// 3. 讀資料時「順序一定要跟寫入時一樣」
float volume = reader.ReadSingle(); // float
int level = reader.ReadInt32(); // int
bool isMusicOn = reader.ReadBoolean(); // bool
string difficulty = reader.ReadString(); // string
Console.WriteLine($"設定已從 '{filePath}' 載入:");
Console.WriteLine($"- 音量: {volume:P0}"); // 格式化成百分比
Console.WriteLine($"- 玩家等級: {level}");
Console.WriteLine($"- 音樂開啟: {isMusicOn}");
Console.WriteLine($"- 難度: {difficulty}");
範例說明:
- 用 FileStream 搭配 FileMode.Open 開檔來讀。
- 在 fs 上面套 BinaryReader,記得編碼要跟寫入時一樣。
- 超重要: 呼叫 reader.ReadXxx() 的順序一定要跟寫入時一模一樣。如果你在寫入 int 的地方讀 string,會出現 EndOfStreamException(如果 string 比較長)或是讀到錯誤的資料。
- ReadXxx() 方法會自動讀對應 bytes 並轉型。ReadString() 會用 BinaryWriter 寫入時的長度前綴來決定要讀幾個 bytes。
4. 重要細節與最佳實踐
順序很重要:
這是最重要的規則。BinaryReader 跟 BinaryWriter 不會存型別的 metadata;它們只知道每個基本型別佔幾個 bytes。你一定要自己確保順序對得起來。
資源管理(using):
跟大多數 .NET 處理系統資源(像檔案、網路連線)的 class 一樣,BinaryReader 跟 BinaryWriter 都有實作 IDisposable。所以一定要用 using 包起來,這樣就算出錯也會自動呼叫 Dispose(),避免資源外洩、檔案沒關掉。
順帶一提,BinaryWriter 跟 BinaryReader 預設也會幫你呼叫底層 stream(像 FileStream)的 Dispose(),所以檔案也會自動關掉。
using FileStream fs = new FileStream("data.bin", FileMode.OpenOrCreate);
using BinaryWriter writer = new BinaryWriter(fs);
// ... 處理資料
字串編碼:
要正確處理 BinaryWriter.Write(string) 跟 BinaryReader.ReadString() 的字串,一定要在建構子裡指定一樣的編碼(像 Encoding.UTF8)。不然遇到非 ASCII 字元會出問題。
例外處理:
檔案 I/O 操作隨時可能被外部因素打斷(檔案不存在、沒權限、磁碟滿)。一定要用 try-catch 包住 FileStream 跟 BinaryReader/BinaryWriter 的程式碼,這樣才夠穩。
BaseStream 跟位置:
你可以用 BaseStream 屬性拿到底層 stream(像 reader.BaseStream 或 writer.BaseStream)。這很方便,像你想知道目前位置(BaseStream.Position)或移動檔案指標(BaseStream.Seek())。
// 用 BaseStream.Position 的範例
using FileStream fs = new FileStream("data.bin", FileMode.OpenOrCreate);
using BinaryWriter writer = new BinaryWriter(fs);
writer.Write(123);
Console.WriteLine($"目前 stream 位置: {writer.BaseStream.Position}"); // 會顯示 4(int 的大小)
writer.Write("Hello");
Console.WriteLine($"目前 stream 位置: {writer.BaseStream.Position}"); // 會顯示 4 + (1+5) = 10
⚠️ Write(string) 方法會先寫一個 7-bit 整數當字串長度,再寫字串 bytes。所以實際大小不一定是 1 + 字串長度。
GO TO FULL VERSION