【.Net实用方法总结】 整理并总结System.IO中StreamReader类及其方法介绍
CSDN话题挑战赛第2期
参赛话题：学习笔记
作者简介：博主是一位.Net开发者，同时也是RPA和低代码平台的践行者。
个人主页：会敲键盘的肘子
系列专栏：.Net实用方法总结
专栏简介：博主针对.Net开发和C站问答过程中遇到的问题进行总结，形成本专栏，希望可以帮助到您解决问题。
座右铭：总有一天你所坚持的会反过来拥抱你。
写在前面：
本文主要介绍System.IO命名空间的StreamReader 类，介绍其常用的方法和示例说明。
本文关键字：System.IO、StreamReader类、方法示例、C#
文章目录
-
-
- 1️⃣ System.IO命名空间
- 2️⃣ StreamReader类
-
- ♈ 定义
- ♉ 构造函数
-
- StreamReader(Stream) 为指定的流初始化 StreamReader类的新实例
- StreamReader(String) 为指定的流初始化 StreamReader类的新实例
- StreamReader(Stream, Boolean) 为指定的流初始化 StreamReader类的新实例
- StreamReader(Stream, Encoding) 为指定的流初始化 StreamReader类的新实例
- ♌ 常用方法
-
- Close() 关闭 StreamReader
- Dispose() 释放由 TextReader 对象使用的所有资源
- Read(Char[], Int32, Int32) 读取输入字符串中的字符块，并将字符位置提升 count
- ReadAsync(Char[], Int32, Int32) 异步从当前字符串中读取指定数目的字符并从指定索引开始将该数据写入缓冲区
- ReadLine() 从当前字符串中读取一行字符并将数据作为字符串返回
- ReadLineAsync() 从当前字符串中异步读取一行字符并将数据作为字符串返回
- ReadToEnd() 读取从当前位置到字符串的结尾的所有字符并将它们作为单个字符串返回
- ReadToEndAsync() 异步读取从当前位置到字符串的结尾的所有字符并将它们作为单个字符串返回
- ♎ 更多方法
-
1️⃣ System.IO命名空间
.NET中的IO操作命名空间，包含允许读写文件和数据流的类型以及提供基本文件和目录支持的类型。
我们在.NET中的IO操作，经常需要调用一下几个类。
- FileStream类
文件流类，负责大文件的拷贝，读写。
- Path类
Path类中方法，基本都是对字符串（文件名）的操作，与实际文件没多大关系。
-
File类
File类可以进行一些对小文件拷贝、剪切操作，还能读一些文档文件。
-
Dirctory类
目录操作，创建文件、删除目录，获取目录下文件名等等。
2️⃣ StreamReader类
♈ 定义
实现一个 TextReader，使其以一种特定的编码从字节流中读取字符。
public class StreamReader : System.IO.TextReader
示例
下面的示例使用 的实例从 StreamReader 文件中读取文本。 不支持在应用商店应用中使用Windows构造函数。
using System;
using System.IO;
class Test
{
public static void Main()
{
try
{
// Create an instance of StreamReader to read from a file.
// The using statement also closes the StreamReader.
using (StreamReader sr = new StreamReader("TestFile.txt"))
{
string line;
// Read and display lines from the file until the end of
// the file is reached.
while ((line = sr.ReadLine()) != null)
{
Console.WriteLine(line);
}
}
}
catch (Exception e)
{
// Let the user know what went wrong.
Console.WriteLine("The file could not be read:");
Console.WriteLine(e.Message);
}
}
}
以下示例实例化 对象并 StreamReader 调用其 ReadAsync 方法以异步读取文件。
using System;
using System.IO;
using System.Threading.Tasks;
class Example
{
static async Task Main()
{
await ReadAndDisplayFilesAsync();
}
static async Task ReadAndDisplayFilesAsync()
{
String filename = "TestFile1.txt";
Char[] buffer;
using (var sr = new StreamReader(filename)) {
buffer = new Char[(int)sr.BaseStream.Length];
await sr.ReadAsync(buffer, 0, (int)sr.BaseStream.Length);
}
Console.WriteLine(new String(buffer));
}
}
// The example displays the following output:
// This is the first line of text in a relatively short file.
// This is the second line.
// This is the third line.
// This is the fourth and final line.
♉ 构造函数
StreamReader(Stream) 为指定的流初始化 StreamReader类的新实例
public StreamReader (System.IO.Stream stream);
参数
streamStream
要读取的流。
示例
下面的代码示例演示了此 StreamReader 构造函数。
using System;
using System.IO;
class Test
{
public static void Main()
{
string path = @"c:\temp\MyTest.txt";
try
{
if (File.Exists(path))
{
File.Delete(path);
}
using (StreamWriter sw = new StreamWriter(new FileStream(path, FileMode.CreateNew)))
{
sw.WriteLine("This");
sw.WriteLine("is some text");
sw.WriteLine("to test");
sw.WriteLine("reading");
}
using (StreamReader sr = new StreamReader(new FileStream(path, FileMode.Open)))
{
while (sr.Peek() >= 0)
{
Console.WriteLine(sr.ReadLine());
}
}
}
catch (Exception e)
{
Console.WriteLine("The process failed: {0}", e.ToString());
}
}
}
StreamReader(String) 为指定的流初始化 StreamReader类的新实例
public StreamReader (string path);
参数
pathString
要读取的完整文件路径。
示例
下面的代码示例演示了此 StreamReader 构造函数。
using System;
using System.IO;
class Test
{
public static void Main()
{
string path = @"c:\temp\MyTest.txt";
try
{
if (File.Exists(path))
{
File.Delete(path);
}
using (StreamWriter sw = new StreamWriter(path))
{
sw.WriteLine("This");
sw.WriteLine("is some text");
sw.WriteLine("to test");
sw.WriteLine("Reading");
}
using (StreamReader sr = new StreamReader(path))
{
while (sr.Peek() >= 0)
{
Console.WriteLine(sr.ReadLine());
}
}
}
catch (Exception e)
{
Console.WriteLine("The process failed: {0}", e.ToString());
}
}
}
StreamReader(Stream, Boolean) 为指定的流初始化 StreamReader类的新实例
public StreamReader (System.IO.Stream stream, bool detectEncodingFromByteOrderMarks);
参数
streamStream
要读取的流。
detectEncodingFromByteOrderMarksBoolean
指示是否在文件头查找字节顺序标记。
示例
下面的代码示例演示了此 StreamReader 构造函数。
private void getNewStreamReader()
{
//Get a new StreamReader in ASCII format from a
//file using a buffer and byte order mark detection
StreamReader srAsciiFromFileFalse512 =
new StreamReader("C:\\Temp\\Test.txt",
System.Text.Encoding.ASCII, false, 512);
//Get a new StreamReader in ASCII format from a
//file with byte order mark detection = false
StreamReader srAsciiFromFileFalse =
new StreamReader("C:\\Temp\\Test.txt",
System.Text.Encoding.ASCII, false);
//Get a new StreamReader in ASCII format from a file
StreamReader srAsciiFromFile =
new StreamReader("C:\\Temp\\Test.txt",
System.Text.Encoding.ASCII);
//Get a new StreamReader from a
//file with byte order mark detection = false
StreamReader srFromFileFalse =
new StreamReader("C:\\Temp\\Test.txt", false);
//Get a new StreamReader from a file
StreamReader srFromFile =
new StreamReader("C:\\Temp\\Test.txt");
//Get a new StreamReader in ASCII format from a
//FileStream with byte order mark detection = false and a buffer
StreamReader srAsciiFromStreamFalse512 = new StreamReader(
(System.IO.Stream)File.OpenRead("C:\\Temp\\Test.txt"),
System.Text.Encoding.ASCII, false, 512);
//Get a new StreamReader in ASCII format from a
//FileStream with byte order mark detection = false
StreamReader srAsciiFromStreamFalse = new StreamReader(
(System.IO.Stream)File.OpenRead("C:\\Temp\\Test.txt"),
System.Text.Encoding.ASCII, false);
//Get a new StreamReader in ASCII format from a FileStream
StreamReader srAsciiFromStream = new StreamReader(
(System.IO.Stream)File.OpenRead("C:\\Temp\\Test.txt"),
System.Text.Encoding.ASCII);
//Get a new StreamReader from a
//FileStream with byte order mark detection = false
StreamReader srFromStreamFalse = new StreamReader(
(System.IO.Stream)File.OpenRead("C:\\Temp\\Test.txt"),
false);
//Get a new StreamReader from a FileStream
StreamReader srFromStream = new StreamReader(
(System.IO.Stream)File.OpenRead("C:\\Temp\\Test.txt"));
}
StreamReader(Stream, Encoding) 为指定的流初始化 StreamReader类的新实例
public StreamReader (System.IO.Stream stream, System.Text.Encoding encoding);
参数
streamStream
要读取的流。
encodingEncoding
要使用的字符编码。
♌ 常用方法
Close() 关闭 StreamReader
public override void Close ();
Dispose() 释放由 TextReader 对象使用的所有资源
public void Dispose ();
Read(Char[], Int32, Int32) 读取输入字符串中的字符块，并将字符位置提升 count
public override int Read (char[] buffer, int index, int count);
参数
bufferChar[]
当此方法返回时，包含指定的字符数组，此数组中
index和 (index+count- 1) 之间的值被从当前源中读取的字符所替换。
indexInt32
在
buffer中开始写入的位置。
countInt32
最多读取的字符数。 如果在将指定数量的字符读入缓冲区之前就已达读取器的末尾，则返回该方法。
返回
Int32
已读取的字符数。 该数会小于或等于
count，具体取决于读取器中是否有可用的数据。 如果调用此方法时没有留下更多的字符供读取，则此方法返回 0（零）。
示例
下面的代码示例一次读取五个字符，直到到达文件末尾。
using System;
using System.IO;
class Test
{
public static void Main()
{
string path = @"c:\temp\MyTest.txt";
try
{
if (File.Exists(path))
{
File.Delete(path);
}
using (StreamWriter sw = new StreamWriter(path))
{
sw.WriteLine("This");
sw.WriteLine("is some text");
sw.WriteLine("to test");
sw.WriteLine("Reading");
}
using (StreamReader sr = new StreamReader(path))
{
//This is an arbitrary size for this example.
char[] c = null;
while (sr.Peek() >= 0)
{
c = new char[5];
sr.Read(c, 0, c.Length);
//The output will look odd, because
//only five characters are read at a time.
Console.WriteLine(c);
}
}
}
catch (Exception e)
{
Console.WriteLine("The process failed: {0}", e.ToString());
}
}
}
ReadAsync(Char[], Int32, Int32) 异步从当前字符串中读取指定数目的字符并从指定索引开始将该数据写入缓冲区
public override System.Threading.Tasks.Task ReadAsync (char[] buffer, int index, int count);
参数
bufferChar[]
当此方法返回时，包含指定的字符数组，此数组中
index和 (index+count- 1) 之间的值被从当前源中读取的字符所替换。
indexInt32
在
buffer中开始写入的位置。
countInt32
最多读取的字符数。 如果在将指定数量的字符读入缓冲区之前就已达读取器的末尾，则返回该方法。
返回
Task
表示异步读取操作的任务。
TResult参数的值包含读入缓冲区的总字节数。 如果当前可用字节数少于所请求的字节数，则该结果值可小于所请求的字节数；如果已到达流结尾时，则为 0（零）。
示例
下面的示例演示如何使用 方法读取文件的所有 [ReadAsync(Char], Int32, Int32) 字符。 在将字符添加到 类的实例之前，它会检查每个字符是字母、数字还是 StringBuilder 空格。
using System;
using System.Windows;
using System.IO;
using System.Text;
namespace WpfApplication
{
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
}
private async void Button_Click_1(object sender, RoutedEventArgs e)
{
string filename = @"C:\Example\existingfile.txt";
char[] result;
StringBuilder builder = new StringBuilder();
using (StreamReader reader = File.OpenText(filename))
{
result = new char[reader.BaseStream.Length];
await reader.ReadAsync(result, 0, (int)reader.BaseStream.Length);
}
foreach (char c in result)
{
if (char.IsLetterOrDigit(c) || char.IsWhiteSpace(c))
{
builder.Append(c);
}
}
FileOutput.Text = builder.ToString();
}
}
}
ReadLine() 从当前字符串中读取一行字符并将数据作为字符串返回
public override string? ReadLine ();
返回
String
读取器中的下一行，或
null（如果已读取所有字符）。
示例
下面的代码示例读取文件中的行，直到到达文件末尾。
using System;
using System.IO;
class Test
{
public static void Main()
{
string path = @"c:\temp\MyTest.txt";
try
{
if (File.Exists(path))
{
File.Delete(path);
}
using (StreamWriter sw = new StreamWriter(path))
{
sw.WriteLine("This");
sw.WriteLine("is some text");
sw.WriteLine("to test");
sw.WriteLine("Reading");
}
using (StreamReader sr = new StreamReader(path))
{
while (sr.Peek() >= 0)
{
Console.WriteLine(sr.ReadLine());
}
}
}
catch (Exception e)
{
Console.WriteLine("The process failed: {0}", e.ToString());
}
}
}
ReadLineAsync() 从当前字符串中异步读取一行字符并将数据作为字符串返回
public override System.Threading.Tasks.Task ReadLineAsync ();
返回
Task
表示异步读取操作的任务。
TResult参数的值包含来自字符串读取器的下一行或为null如果读取所有字符。
示例
下面的示例演示如何使用方法读取文件的第一行 ReadLineAsync() 。
using System;
using System.IO;
namespace ConsoleApplication
{
class Program
{
static async Task Main()
{
await ReadCharacters();
}
static async Task ReadCharacters()
{
String result;
using (StreamReader reader = File.OpenText("existingfile.txt"))
{
Console.WriteLine("Opened file.");
result = await reader.ReadLineAsync();
Console.WriteLine("First line contains: " + result);
}
}
}
}
ReadToEnd() 读取从当前位置到字符串的结尾的所有字符并将它们作为单个字符串返回
public override string ReadToEnd ();
返回
String
从当前位置到基础字符串的结尾之间的内容。
示例
下面的代码示例在一次操作中全部读取到文件末尾。
using System;
using System.IO;
class Test
{
public static void Main()
{
string path = @"c:\temp\MyTest.txt";
try
{
if (File.Exists(path))
{
File.Delete(path);
}
using (StreamWriter sw = new StreamWriter(path))
{
sw.WriteLine("This");
sw.WriteLine("is some text");
sw.WriteLine("to test");
sw.WriteLine("Reading");
}
using (StreamReader sr = new StreamReader(path))
{
//This allows you to do one Read operation.
Console.WriteLine(sr.ReadToEnd());
}
}
catch (Exception e)
{
Console.WriteLine("The process failed: {0}", e.ToString());
}
}
}
ReadToEndAsync() 异步读取从当前位置到字符串的结尾的所有字符并将它们作为单个字符串返回
public override System.Threading.Tasks.Task ReadToEndAsync ();
返回
Task
表示异步读取操作的任务。
TResult参数值包括字符串来自当前位置到结束字符串字符。
示例
下面的示例演示如何使用方法读取文件的内容 ReadToEndAsync() 。
using System;
using System.IO;
namespace ConsoleApplication
{
class Program
{
static async Task Main()
{
await ReadCharacters();
}
static async Task ReadCharacters()
{
String result;
using (StreamReader reader = File.OpenText("existingfile.txt"))
{
Console.WriteLine("Opened file.");
result = await reader.ReadToEndAsync();
Console.WriteLine("Contains: " + result);
}
}
}
}
♎ 更多方法
更多方法请查阅官方文档StreamReader类。
⭐写在结尾：
文章中出现的任何错误请大家批评指出，一定及时修改。
希望写在这里的小伙伴能给个三连支持！