C# 基础知识系列- 14 IO篇 流的使用

0. 前言

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

注：之前更新了一篇《spring cloud 实战日记》，这是一个新的系列，有兴趣的小伙伴可以从我的账号首页进去看看。

1. 简单的io流读写文件

先来看一部分代码：

class program
{
    static void main(string[] args)
    {
        var directory = directory.getcurrentdirectory();
        var program = file.open("../../../program.cs", filemode.openorcreate);
        // program = file.open("program.cs", filemode.openorcreate);
        var buffers = new byte[1024];// 创建一个8k的缓存区
        var list = new list<byte>();
        while(true)
        {
            int length = program.read(buffers, 0, buffers.length);
            if(length <=0)
            {
                break;
            }
            list.addrange(buffers.take(length));
        }

        program.close();
        console.writeline(list.count);
    }
}

到目前为止，打开了一个流读取当前程序源文件，每次读取到一个字节数组里，然后将数据放到list集合里，在读取完成后关闭这个流。虽然以上流并没有太多意义，但是基本演示了一下流的读取操作。

注意到注释的那行代码和上一行代码的区别吗？在编译阶段，directory.getcurrentdirectory()表示源文件所在目录；在运行阶段，表示程序编译完成的dll所在目录。

输出结果：

以上通过文件流演示了如何读取一个文件，那么我们来简单看看如何通过流写文件：

class program
{
    static void main(string[] args)
    {
        var directory = directory.getcurrentdirectory();
        var program = file.open("program.cs", filemode.openorcreate);
        var buffers = new byte[1024];// 创建一个8k的缓存区
        var list = new list<byte>();
        while(true)
        {
            int length = program.read(buffers, 0, buffers.length);
            if(length <=0)
            {
                break;
            }
            list.addrange(buffers.take(length));
        }
        program.close();
        console.writeline($"已读取：{list.count}");
        var tempr = file.open("program_01.cs", filemode.openorcreate);
        tempr.write(list.toarray(), 0, list.count);
        tempr.close();
    }
}

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

2. 使用流适配器

普通的流读取和写入都是使用字节数组，这在实际开发中非常不方便，所以c#又在流的基础上开发了流适配器。c#中流适配器是指xxxreader或者xxxwriter，这种类在初始化的时候传入一个流作为操作对象，然后对这个流进行一定的封装，简化了其操作方法。

现在以streamreader为例，来看看具体如何使用：

public streamreader (system.io.stream stream);
public streamreader (system.io.stream stream, system.text.encoding encoding);

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

public streamreader (string path);
public streamreader (string path, system.text.encoding encoding);

这两个是通过指定文件的路径，然后打开一个streamreader对象。

现在我们来看下这个reader对象有哪些方法或者说我们常用的方法有哪些吧：

public override int read ();
public override int read (char[] buffer, int index, int count);

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

public override string readline ();

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

public override string readtoend ();

这个方法的意思是一次性读完剩余的数据然后返回一个字符串。

照例，reader提供了流的关闭和销毁方法：

public override void close ();

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

class program
{
    static void main(string[] args)
    {
        var reader = new streamreader("program.cs");
        while(true)
        {
            var str = reader.readline();
            if(str == null)
            {
                break;
            }
            console.writeline(str);
        }
        reader.close();
    }
}

这段代码的意思是读取当前主程序的文件，然后按行打印。打印结果应该类似于：

这是我本地的代码文件。

简单的介绍了一下streamreader，然后我们来看一下streamwriter如何使用。按照我的惯例，先从构造函数来：

public streamwriter (system.io.stream stream);
public streamwriter (system.io.stream stream, system.text.encoding encoding);

与streamreader类似，打开一个允许写的流。

public streamwriter (string path);
public streamwriter (string path, bool append);
public streamwriter (string path, bool append, system.text.encoding encoding);

打开path对应的文件，然后将数据写入到文件中。append表示当文件存在时，数据是追加到文件末尾还是覆盖文件。

然后看一下它的方法：

public override void write (string value);
public override void write (string format, object arg0, object arg1, object arg2);
public override void write (string format, params object[] arg);

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

var value = string.format(string format, params object[] arg);
writer.write(value);

public override void writeline (string value);
public override void writeline (string format, object arg0, object arg1, object arg2);
public override void writeline (string format, params object[] arg);

同时c#也添加了一组writeline的方法，该方法与write不同的是，writeline会在写入数据后向流里追加一个换行符，所以这个方法是写入一行。

不过，在使用writer的时候需要注意以下这三个方法：

public override void flush ();
public override void close ();
protected override void dispose (bool disposing);

其中dispose（销毁）是受保护的方法，一般场景中遇不到。flush表示将writer的数据推送到基础流里，close表示关闭writer顺便关闭基础流。

在c#中，对close动作进行了进一步优化。当调用close方法的时候，系统会自动调用flush方法将数据推送到基础流中。那么，为什么还提供了flush呢？因为如果要操作一个大数据或者数据的来源是分批，这时候为了保证之前的数据不会丢失就需要我们手动调用flush把数据推送给基础流了。

嗯，所以我们来写个程序验证一下：

class program
{
    static void main(string[] args)
    {
        var reader = new streamreader("program.cs");
        var writer = new streamwriter("program.cs.txt");
        while(true)
        {
            var str = reader.readline();
            if(str == null)
            {
                break;
            }
            console.writeline(str);
            writer.writeline(str);
        }
        //writer.close();
        reader.close();
    }
}

如示例，在注释了 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实例。

public static system.text.encoding utf8 { get; }
public static system.text.encoding ascii { get; }

更多内容烦请关注