C# StreamReader/StreamWriter 使用详解

总目录

前言

在 C# 开发中，StreamReader 和 StreamWriter 是处理文本文件的核心类，属于 System.IO 命名空间。它们基于流（Stream）操作文本数据，支持读写、编码设置、异步操作等，适用于日志记录、配置文件处理、数据导出等场景。本文将从基础到高级用法，结合代码示例，全面解析其核心功能、性能优化及常见问题解决方案。

一、什么是 StreamReader 和 StreamWriter？

1. 定义

StreamReader：用于从流（如文件、网络流）中读取文本数据，支持逐行读取、读取指定长度数据或一次性读取全部内容。
StreamWriter：用于向流中写入文本数据，支持追加模式、格式化输出及自定义编码。

StreamReader 和 StreamWriter 是 System.IO 命名空间中的两个类，它们分别用于读取和写入文本数据。两者均继承自 TextReader 和 TextWriter 抽象类，通常与 FileStream、MemoryStream 等流结合使用。

2. 特点

提供了方便的方法来读取和写入文本数据，支持多种编码格式。
可以处理大文件，通过流的方式逐步读取或写入数据，节省内存。
支持异步操作，提高程序的响应性和性能。

3. 用途

文本文件读写：
- 替代 FileStream 直接操作字节的复杂性，自动处理编码和换行符。如日志文件、配置文件等。
网络流解析：
- 与 NetworkStream 结合，实现 HTTP 响应内容的高效解码。
内存流操作：
- 配合 MemoryStream 处理内存中的文本缓存，如 JSON/XML 序列化。
日志与数据记录：
- 支持追加模式写入，避免频繁覆盖文件内容。

适用于以下场景：

日志记录：将日志追加到文件。
配置文件操作：读取 .ini、.json 等文本配置。
数据导出：将数据写入 CSV、TXT 文件。

4. 为什么需要 StreamReader/StreamWriter？

在C#中处理文本文件时，直接使用 FileStream 操作字节数组不仅繁琐，还需手动处理编码、换行符等问题。StreamReader 和 StreamWriter 提供了更高级的文本流操作接口，支持自动编码检测、换行符处理及便捷的读写方法，大幅简化开发流程。

二、基础用法

1. 创建 StreamReader 和 StreamWriter 对象

在 C# 中，有多种方式可以创建 StreamReader 和 StreamWriter 对象：

1）从文件路径创建

使用文件路径创建 StreamReader 和 StreamWriter 对象是最常见的方法。
自动处理编码（默认UTF-8）

using System.IO;

// 创建 StreamReader
using (StreamReader reader = new StreamReader("example.txt"))
{
    // 读取操作
}

// 创建 StreamWriter
using (StreamWriter writer = new StreamWriter("example.txt"))
{
    // 写入操作
}

2）从流创建

也可以从现有的流 Stream对象创建 StreamReader 和 StreamWriter，例如从 MemoryStream 或网络流、 FileStream，适合复杂场景。

using System.IO;

// 从 MemoryStream 创建
MemoryStream memoryStream = new MemoryStream();
StreamReader reader = new StreamReader(memoryStream);
StreamWriter writer = new StreamWriter(memoryStream);

// 从 FileStream 创建
FileStream fs = new FileStream("data.bin", FileMode.Open);
using (StreamReader sr = new StreamReader(fs)) { /*...*/ }

3）编码与格式设置

▶ 指定编码

默认编码为 UTF-8，但可通过构造函数指定其他编码（如 UTF-16、ASCII）：

// 使用 UTF-16 编码
using (StreamWriter writer = new StreamWriter("data.txt", false, Encoding.Unicode))
{
    writer.WriteLine("Hello, Unicode!");
}

▶ 追加写入模式

通过指定StreamWriter 的 append参数为true 设置为追加写入（append: true）。

StreamWriter sw = new StreamWriter("log.txt", true, Encoding.UTF8); // 追加模式

▶ 控制底层流是否关闭

leaveOpen：控制底层流是否随读写器关闭（默认 false）。

MemoryStream  ms= new MemoryStream();
StreamReader streamReader = new StreamReader(ms, Encoding.Unicode, leaveOpen: true);

▶ 自动检测编码

通过 StreamReader 的 DetectEncodingFromByteOrderMarks 属性，自动识别 BOM 标记：

using (StreamReader reader = new StreamReader("data.txt", Encoding.UTF8, detectEncodingFromByteOrderMarks:true))
{
    // 如果文件开头有 BOM，会自动检测编码
    string content = reader.ReadToEnd();
}

2. 使用 StreamWriter 写入数据

StreamWriter 提供了多种方法来写入文本数据，最常用的是 Write 和 WriteLine 方法。

1）写入数据

使用 Write 方法可以写入数据到文件中。支持字符串、数值等类型。

using (StreamWriter writer = new StreamWriter("example.txt"))
{
	// 写入不同类型的数据
	writer.Write(1.1f);
	writer.Write(42);
	writer.Write(new byte[] { 1, 2, 3 });
    writer.Write("Hello, World!");
}

2）写入带换行符的数据

使用 WriteLine 方法可以写入一个带换行符的数据。支持字符串、数值等类型。

using (StreamWriter writer = new StreamWriter("example.txt"))
{
	// 写入不同类型的数据
	writer.WriteLine(1.1f);
	writer.WriteLine(42);
	writer.WriteLine(new byte[] { 1, 2, 3 });
    writer.WriteLine("Hello, World!");
}

3. 使用 StreamReader 读取数据

StreamReader 提供了多种方法来读取文本数据，最常用的是 Read、ReadLine 和 ReadToEnd 方法。

1）读取字符

使用 Read 方法可以读取一个字符。

using (StreamReader reader = new StreamReader("example.txt"))
{
    int character;
    while ((character = reader.Read()) != -1)
    {
        Console.Write((char)character);
    }
}

2）读取一行

使用 ReadLine 方法可以读取一行文本。

using (StreamReader reader = new StreamReader("example.txt"))
{
    string line;
    while ((line = reader.ReadLine()) != null)
    {
        Console.WriteLine(line);
    }
}

3）读取所有文本

使用 ReadToEnd 方法可以读取整个文件的内容。

using (StreamReader reader = new StreamReader("example.txt"))
{
    string content = reader.ReadToEnd();
    Console.WriteLine(content);
}

批量操作：ReadToEnd() 一次性读取全文，Write() 支持字符数组写入。

4. StreamReader 和 StreamWriter 的常用属性和方法

1）StreamReader的常用属性和方法

BaseStream：获取StreamReader所使用的基础流。
CurrentEncoding：获取当前使用的字符编码。
EndOfStream：指示是否已到达流的末尾。
Peek：查看下一个字符而不读取它。
Read：读取单个字符或字符数组。
ReadBlock：读取指定数量的字符。
ReadLine：读取一行文本。
ReadToEnd：读取流中的所有文本。

2）StreamWriter的常用属性和方法

BaseStream：获取StreamWriter所使用的基础流。
AutoFlush：获取或设置一个值，该值指示是否在写入数据后自动刷新流。
Encoding：获取当前使用的字符编码。
Write：写入指定的数据。
WriteLine：写入指定的数据，并添加换行符。
Flush：将所有缓冲的字符写入基础流。
Close：关闭流并释放所有相关资源。

3）使用示例

▶ 获取当前编码

可以使用 CurrentEncoding 属性获取当前使用的编码。

using (StreamReader reader = new StreamReader("example.txt"))
{
    Encoding encoding = reader.CurrentEncoding;
    Console.WriteLine("Encoding: " + encoding.EncodingName);
}

▶ 获取基础流对象

使用 BaseStream 属性可以获取基础流对象。

using (StreamReader reader = new StreamReader("example.txt"))
{
    Stream stream = reader.BaseStream;
    // 操作流
}

▶ 指示是否已到达流的末尾

  while (!sr.EndOfStream) 
  {
      string line = sr.ReadLine();
      Console.WriteLine(line);
  }

5. 示例代码

下面是一个完整的示例，演示了如何使用 StreamReader 和 StreamWriter：

class Program
{
    static void Main()
    {
        string filePath = "example.txt";

        // 使用 StreamWriter 写入数据
        using (StreamWriter writer = new StreamWriter(filePath))
        {
            writer.WriteLine("Hello, World!");
            writer.WriteLine("This is a new line.");
            writer.WriteLine("The answer is: 42");
        }

        // 使用 StreamReader 读取数据
        using (StreamReader reader = new StreamReader(filePath))
        {
            string line;
            while ((line = reader.ReadLine()) != null)
            {
                Console.WriteLine(line);
            }
        }

        // 使用 StreamReader 读取数据 + EndOfStream 属性判断
        using (StreamReader reader = new StreamReader(filePath))
        {
            while (!reader.EndOfStream)
            {
                Console.WriteLine(reader.ReadLine());
            }
        }

        // 读取整个文件内容
        using (StreamReader reader = new StreamReader(filePath))
        {
            Console.WriteLine(reader.ReadToEnd());
        }

        string content = File.ReadAllText(filePath);
        Console.WriteLine("File content:");
        Console.WriteLine(content);

        // 读取字符
        using (StreamReader reader = new StreamReader(filePath))
        {
            int character;
            while ((character = reader.Read()) != -1)
            {
                Console.Write((char)character);
            }
        }
    }
}

通过这个示例，我们可以看到 StreamReader 和 StreamWriter 在处理文本文件时是多么方便和高效。它们提供了丰富的功能，满足了多种文本处理需求。

三、高级用法

1. 高级技巧

1）异步操作

使用 ReadAsync、WriteAsync 实现异步读写，避免阻塞主线程，提升I/O性能

public async Task WriteAsync()
{
    using (StreamWriter writer = new StreamWriter("data.txt"))
    {
        await writer.WriteLineAsync("异步写入");
    }
}

public async Task ReadAsync()
{
    using (StreamReader reader = new StreamReader("data.txt"))
    {
        string content = await reader.ReadToEndAsync();
    }
}

2）缓冲区优化

预分配容量：若已知文件大小，初始化时指定 bufferSize 减少扩容开销。平衡性能与内存占用

// 创建带自定义缓冲区的流
using (StreamReader reader = new StreamReader("data.txt", Encoding.UTF8, true, 8192))
{
    // 缓冲区大小为 8KB
}

3）大文件处理

逐行读取大文件以避免内存溢出：

using (StreamReader reader = new StreamReader("large_file.txt"))
{
    string line;
    while ((line = await reader.ReadLineAsync()) != null)
    {
        // 处理每一行
    }
}

4）显式刷新缓冲区

显式刷新缓冲区：高频写入时调用 Flush() 避免内存堆积。

延迟写入与批量提交：

sw.AutoFlush = false;  // 关闭自动刷新
for (int i = 0; i < 1000; i++) {
    sw.Write($"Data {i}");
}
sw.Flush();  // 手动批量提交

2. 高级应用示例

1）案例1：CSV文件解析

假设需读取包含逗号分隔的CSV文件并提取数据：

using (StreamReader sr = new StreamReader("data.csv")) 
{
    while (!sr.EndOfStream) 
    {
        string line = sr.ReadLine();
        string[] fields = line.Split(',').Select(f => f.Trim()).ToArray();
        // 处理字段数据...
    }
}

优势：自动处理编码与换行符，简化字符串分割逻辑。

2）案例2：大文件逐行处理与内存优化

当处理 GB 级日志文件时，需避免一次性加载全部数据导致内存溢出：

using (var sr = new StreamReader("large.log", Encoding.UTF8, bufferSize: 8192)) 
{
    while (!sr.EndOfStream) 
    {
        string line = sr.ReadLine();
        if (line.Contains("ERROR")) 
        {
            // 实时处理错误行
        }
    }
}

优化点：

设置 bufferSize 为 8KB（默认 1KB），减少磁盘读取次数。
逐行释放内存，避免 ReadToEnd() 的全量加载风险。

3）案例3：日志记录系统

public static void Log(string message)
{
    using var writer = new StreamWriter("app.log", true);
    writer.WriteLine($"[{DateTime.Now:yyyy-MM-dd HH:mm:ss}] {message}");
}

4）案例4：配置文件读写

var config = new Dictionary<string, string>();
using var reader = new StreamReader("config.ini");
while ((line = reader.ReadLine()) != null)
{
    var parts = line.Split('=');
    if (parts.Length == 2)
    {
        config[parts[0]] = parts[1];
    }
}

四、常见问题与最佳实践

1. 常见问题

1）文件不存在时的异常

try
{
    using (StreamReader reader = new StreamReader("non_existent.txt"))
    {
        // 处理文件
    }
}
catch (FileNotFoundException ex)
{
    Console.WriteLine("文件不存在：" + ex.Message);
}

2）编码不匹配导致乱码

确保读写时编码一致：

// 写入时使用 UTF-8
using (StreamWriter writer = new StreamWriter("data.txt", false, Encoding.UTF8)) { ... }

// 读取时指定相同编码
using (StreamReader reader = new StreamReader("data.txt", Encoding.UTF8)) { ... }

3）资源未释放

始终使用 using 语句确保流正确关闭：

// 错误示例：未使用 using
StreamReader reader = new StreamReader("data.txt");
// ... 处理后未关闭，可能导致文件被锁定
reader.Close(); // 需手动调用

// 正确做法：使用 using 自动释放资源
using (StreamReader reader = new StreamReader("data.txt")) { ... }

// C# 8+简化写法
using var writer = new StreamWriter("output.txt");

4）编码问题

若文件包含BOM（字节顺序标记），可通过 detectEncodingFromByteOrderMarks: true 自动识别。
处理含 BOM 头的多编码文件时，自动适配编码：

using (FileStream fs = File.OpenRead("mixed_encoding.txt")) 
{
    using (StreamReader sr = new StreamReader(fs, Encoding.Default, detectEncodingFromByteOrderMarks: true)) 
    {
        Console.WriteLine($"检测到编码：{sr.CurrentEncoding}");
        // 按正确编码解析内容
    }
}