0. 前言

继续之前的C# IO流,在前几篇小短片中我们大概看了下C# 的基础IO也对文件、目录和路径的操作有了一定的了解。这一篇开始,给大家演示一下流的各种操作。以文件流为例,一起来看看如何操作吧。

1. 简单的IO流读写文件

先来看一部分代码:

  1. class Program
  2. {
  3. static void Main(string[] args)
  4. {
  5. var directory = Directory.GetCurrentDirectory();
  6. var program = File.Open("../../../Program.cs", FileMode.OpenOrCreate);
  7. // program = File.Open("Program.cs", FileMode.OpenOrCreate);
  8. var buffers = new byte[1024];// 创建一个8k的缓存区
  9. var list = new List<byte>();
  10. while(true)
  11. {
  12. int length = program.Read(buffers, 0, buffers.Length);
  13. if(length <=0)
  14. {
  15. break;
  16. }
  17. list.AddRange(buffers.Take(length));
  18. }
  19. program.Close();
  20. Console.WriteLine(list.Count);
  21. }
  22. }

到目前为止,打开了一个流读取当前程序源文件,每次读取到一个字节数组里,然后将数据放到list集合里,在读取完成后关闭这个流。虽然以上流并没有太多意义,但是基本演示了一下流的读取操作。
注意到注释的那行代码和上一行代码的区别吗?在编译阶段,Directory.GetCurrentDirectory()表示源文件所在目录;在运行阶段,表示程序编译完成的DLL所在目录。
输出结果:
C# 基础知识系列- 14 IO篇 流的使用 - 图1
以上通过文件流演示了如何读取一个文件,那么我们来简单看看如何通过流写文件:

  1. class Program
  2. {
  3. static void Main(string[] args)
  4. {
  5. var directory = Directory.GetCurrentDirectory();
  6. var program = File.Open("Program.cs", FileMode.OpenOrCreate);
  7. var buffers = new byte[1024];// 创建一个8k的缓存区
  8. var list = new List<byte>();
  9. while(true)
  10. {
  11. int length = program.Read(buffers, 0, buffers.Length);
  12. if(length <=0)
  13. {
  14. break;
  15. }
  16. list.AddRange(buffers.Take(length));
  17. }
  18. program.Close();
  19. Console.WriteLine($"已读取:{list.Count}");
  20. var tempr = File.Open("Program_01.cs", FileMode.OpenOrCreate);
  21. tempr.Write(list.ToArray(), 0, list.Count);
  22. tempr.Close();
  23. }
  24. }

以上方法通过读取当前源码文件,然后将数据写入到另一个文件中:”Program_01.cs“。如果运行无误的话,将会得到一个”Program_01.cs“文件。

2. 使用流适配器

普通的流读取和写入都是使用字节数组,这在实际开发中非常不方便,所以C#又在流的基础上开发了流适配器。C#中流适配器是指XXXReader或者XXXWriter,这种类在初始化的时候传入一个流作为操作对象,然后对这个流进行一定的封装,简化了其操作方法。
现在以StreamReader为例,来看看具体如何使用:

  1. public StreamReader (System.IO.Stream stream);
  2. public StreamReader (System.IO.Stream stream, System.Text.Encoding encoding);

这里是两个以流为主要参数的构造方法,不同的是一个指定了文本编码 encoding,另一个默认使用系统的文本编码。

  1. public StreamReader (string path);
  2. public StreamReader (string path, System.Text.Encoding encoding);

这两个是通过指定文件的路径,然后打开一个StreamReader对象。
现在我们来看下这个Reader对象有哪些方法或者说我们常用的方法有哪些吧:

  1. public override int Read ();
  2. public override int Read (char[] buffer, int index, int count);

读取字符,与普通的流不同的是,StreamReader的读取是以字符为单位的读取,而char类型与int之间存在一定的转换关系,所以方法Read()的返回值是int。

  1. public override string ReadLine ();

这个方法的意思是一次读一行,如果读到末尾则返回null。

  1. public override string ReadToEnd ();

这个方法的意思是一次性读完剩余的数据然后返回一个字符串。
照例,Reader提供了流的关闭和销毁方法:

  1. public override void Close ();

现在让我们来改造一下第一节的示例程序:

  1. class Program
  2. {
  3. static void Main(string[] args)
  4. {
  5. var reader = new StreamReader("Program.cs");
  6. while(true)
  7. {
  8. var str = reader.ReadLine();
  9. if(str == null)
  10. {
  11. break;
  12. }
  13. Console.WriteLine(str);
  14. }
  15. reader.Close();
  16. }
  17. }

这段代码的意思是读取当前主程序的文件,然后按行打印。打印结果应该类似于:
C# 基础知识系列- 14 IO篇 流的使用 - 图2
这是我本地的代码文件。
简单的介绍了一下StreamReader,然后我们来看一下StreamWriter如何使用。按照我的惯例,先从构造函数来:

  1. public StreamWriter (System.IO.Stream stream);
  2. public StreamWriter (System.IO.Stream stream, System.Text.Encoding encoding);

与StreamReader类似,打开一个允许写的流。

  1. public StreamWriter (string path);
  2. public StreamWriter (string path, bool append);
  3. public StreamWriter (string path, bool append, System.Text.Encoding encoding);

打开path对应的文件,然后将数据写入到文件中。append表示当文件存在时,数据是追加到文件末尾还是覆盖文件。
然后看一下它的方法:

  1. public override void Write (string value);
  2. public override void Write (string format, object arg0, object arg1, object arg2);
  3. public override void Write (string format, params object[] arg);

Write方法提供了很多个重载版本,但是我们只需要关注这三个即可。第一个很简单,直接写一个字符串。如果把第二个方法和第三个方法结合起来,然后再联系一下String.Format我想很多小伙伴就知道怎么使用了。没错,这两个方法的效果就是下面这种方式:

  1. var value = string.Format(string format, params object[] arg);
  2. writer.Write(value);
  1. public override void WriteLine (string value);
  2. public override void WriteLine (string format, object arg0, object arg1, object arg2);
  3. public override void WriteLine (string format, params object[] arg);

同时C#也添加了一组WriteLine的方法,该方法与Write不同的是,WriteLine会在写入数据后向流里追加一个换行符,所以这个方法是写入一行。
不过,在使用Writer的时候需要注意以下这三个方法:

  1. public override void Flush ();
  2. public override void Close ();
  3. protected override void Dispose (bool disposing);

其中Dispose(销毁)是受保护的方法,一般场景中遇不到。Flush表示将Writer的数据推送到基础流里,Close表示关闭Writer顺便关闭基础流。
在C#中,对Close动作进行了进一步优化。当调用Close方法的时候,系统会自动调用Flush方法将数据推送到基础流中。那么,为什么还提供了Flush呢?因为如果要操作一个大数据或者数据的来源是分批,这时候为了保证之前的数据不会丢失就需要我们手动调用Flush把数据推送给基础流了。
嗯,所以我们来写个程序验证一下:

  1. class Program
  2. {
  3. static void Main(string[] args)
  4. {
  5. var reader = new StreamReader("Program.cs");
  6. var writer = new StreamWriter("Program.cs.txt");
  7. while(true)
  8. {
  9. var str = reader.ReadLine();
  10. if(str == null)
  11. {
  12. break;
  13. }
  14. Console.WriteLine(str);
  15. writer.WriteLine(str);
  16. }
  17. //writer.Close();
  18. reader.Close();
  19. }
  20. }

如示例,在注释了 writer.Close(); 之后,程序依然会生成一个Program.cs.txt 文件,但文件是空的。这时候取消注释,就会发现Program已经复制到了Program.cs.txt里。

3. 常用的有哪些适配器流

1. BinaryReader
用特定的编码将基元数据类型读作二进制值
2. BinaryWriter
将二进制中的基元类型写入流并支持用特定的编码写入字符串
3.StringReader
从字符串中读取字符串
4.StringWriter
将信息写入字符串中
5.XmlReader/XmlWriter
对xml文件的快速操作
这几个是出镜率较高的,但仍有很多选手藏在幕后,并非是它们不出镜,而是它们经常活跃在特定的领域里。所以这里就没有做过多的介绍。

4. 后言

到这里,IO流基础知识介绍完毕。C#基础知识系列,也只剩下《异常篇》、《实战准备篇》以及《C#基础实战篇-文件检索工具》这三大篇章了。C#系列的下一个篇章就是数据访问系列,会介绍AOD.NET、Entity Framework等数据访问框架。
附:
上文中提到的System.Text.Encoding是一种文本编码类,表示字符串的编码格式。常用的有 UTF-8,GBK2312等。其中C#在Encoding类添加了几大常用编码格式的静态属性,返回的是Encoding实例。

  1. public static System.Text.Encoding UTF8 { get; }
  2. public static System.Text.Encoding ASCII { get; }