C#FileStream类的使用

C#FileStream类的使用

文件读写流使用 FileStream 类来表示，FileStream 类主要用于文件的读写，不仅能读写普通的文本文件，还可以读取图像文件、声音文件等不同格式的文件。区别于File类的是它对文件可进行分步读写，减小内存压力，缺点是我们需要手动的关闭和释放资源，

FileStream

常见方法

以下是C# FileStream类的常见方法：

• FileStream(string path, FileMode mode)：创建一个新的FileStream对象，用于读取或写入指定路径的文件。
• Read(byte[] buffer, int offset, int count)：从当前流中读取指定数量的字节，并将其存储在缓冲区中。
• Write(byte[] buffer, int offset, int count)：将指定数量的字节从缓冲区写入当前流中。
• Flush()：清除当前流的所有缓冲区，并将其写入基础设备。
• Close()：关闭当前流并释放所有相关资源。

属性

属性或方法	作用
bool CanRead	只读属性，获取一个值，该值指示当前流是否支持读取
bool CanSeek	只读属性，获取一个值，该值指示当前流是否支持查找
bool CanWrite	只读属性，获取一个值，该值指示当前流是否支持写入
bool IsAsync	只读属性，获取一个值，该值指示 FileStream 是异步还 是同步打开的
long Length	只读属性，获取用字节表示的流长度
string Name	只读属性，获取传递给构造方法的 FileStream 的名称
long Position	属性，获取或设置此流的当前位置
int Read(byte[] array, int offset, int count)	从流中读取字节块并将该数据写入给定缓冲区中
int ReadByte()	从文件中读取一个字节，并将读取位置提升一个字节
long Seek(lorig offset, SeekOrigin origin)	将该流的当前位置设置为给定值
void Lock(long position, long length)	防止其他进程读取或写入 System.IO.FileStream
void Unlock(long position, long length)	允许其他进程访问以前锁定的某个文件的全部或部分
void Write(byte[] array, int offset, int count)	将字节块写入文件流
void WriteByte(byte value)	将一个字节写入文件流中的当前位置

示例

使用FileStream类打开了一个名为example.txt的文本文件，并使用Read方法读取了文件的内容。最后使用Console.WriteLine方法将文件内容输出到控制台

using System;
using System.IO;

class Program
{
    static void Main(string[] args)
    {
        // 定义文件路径
        string path = @"C:\example.txt";
        // 使用 FileStream 打开文件
        using (FileStream fs = new FileStream(path, FileMode.Open))
        {
            // 定义缓冲区
            byte[] buffer = new byte[1024];
            // 定义读取的字节数
            int bytesRead = 0;
            // 循环读取文件内容
            while ((bytesRead = fs.Read(buffer, 0, buffer.Length)) > 0)
            {
                // 将读取的字节数组转换为字符串并输出到控制台 
                Console.WriteLine(Encoding.UTF8.GetString(buffer, 0, bytesRead));
            }
        }
    }
}

FileAccess

FileAccess 枚举类型主要用于设置文件的访问方式，具体的枚举值如下。

• Read：以只读方式打开文件。
• Write：以写方式打开文件。
• ReadWrite：以读写方式打开文件。

FileMode

FileMode 枚举类型主要用于设置文件打开或创建的方式，具体的枚举值如下。

• CreateNew：创建新文件，如果文件已经存在，则会抛出异常。
• Create：创建文件，如果文件不存在，则删除原来的文件，重新创建文件。
• Open：打开已经存在的文件，如果文件不存在，则会抛出异常。
• OpenOrCreate：打开已经存在的文件，如果文件不存在，则创建文件。
• Truncate：打开已经存在的文件，并清除文件中的内容，保留文件的创建日期。如果文件不存在，则会抛出异常。
• Append：打开文件，用于向文件中追加内容，如果文件不存在，则创建一个新文件。

FileShare

FileShare 枚举类型主要用于设置多个对象同时访问同一个文件时的访问控制，具体的枚举值如下。

• None：谢绝共享当前的文件。
• Read：允许随后打开文件读取信息。
• ReadWrite：允许随后打开文件读写信息。
• Write：允许随后打开文件写入信息。
• Delete：允许随后删除文件。
• Inheritable：使文件句柄可由子进程继承。

FileOptions

FileOptions 枚举类型用于设置文件的高级选项，包括文件是否加密、访问后是否删除等，具体的枚举值如下。

• WriteThrough：指示系统应通过任何中间缓存、直接写入磁盘。
• None：指示在生成 System.IO.FileStream 对象时不应使用其他选项。
• Encrypted：指示文件是加密的，只能通过用于加密的同一用户账户来解密。
• DeleteOnClose：指示当不再使用某个文件时自动删除该文件。
• SequentialScan：指示按从头到尾的顺序访问文件。
• RandomAccess：指示随机访问文件。
• Asynchronous：指示文件可用于异步读取和写入。

FileStream 类的构造方法有很多，这里介绍一些常用的构造方法，如下表所示。

构造方法	说明
FileStream(string path, FileMode mode)	使用指定路径的文件、文件模式创建 FileStream 类的实例
FileStream(string path, FileMode mode, FileAccess access)	使用指定路径的文件、文件打开模式、文件访问模式创建 FileStream 类的实例
FileStream(string path, FileMode mode, FileAccess access, FileShare share)	使用指定的路径、创建模式、读写权限和共享权限创建 FileStream 类的一个新实例
FileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options)	使用指定的路径、创建模式、读写权限和共享权限、其他 文件选项创建 FileStream 类的实例

File和FileStream的区别

File是一个静态类；FileStream是一个非静态类。

File：是一个文件的类，对文件进行操作。其内部封装了对文件的各种操作(MSDN:提供用于创建、复制、删除、移动和打开单一文件的静态方法，并协助创建FileStream对象)。

FileStream:文件流的类。对txt，xml，avi等文件进行内容写入、读取、复制...时候需要使用的一个工具。

FileStream实例

// 定义文件路径
string path = "D:\\test.txt";
// 打开文件流，使用默认的FileMode.Open模式
FileStream fileStream1 = new FileStream(path, FileMode.Open);
// 打开文件流，使用FileMode.Open模式和FileAccess.Read访问模式
FileStream fileStream2 = new FileStream(path, FileMode.Open, FileAccess.Read);
// 打开文件流，使用FileMode.Open模式、FileAccess.ReadWrite访问模式和FileShare.Read共享模式
FileStream fileStream3 = new FileStream(path, FileMode.Open, FileAccess.ReadWrite, FileShare.Read);
// 打开文件流，使用FileMode.Open模式、FileAccess.Read访问模式、FileShare.Read共享模式、缓冲区大小为10字节和FileOptions.None选项
FileStream fileStream4 = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, 10, FileOptions.None);

//定义文件路径
string path = @"D:\\code\\test.txt";
//创建 FileStream 类的实例
FileStream fileStream = new FileStream(path, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite);
//定义属性
string msg = "11111";
//将字符串转换为字节数组
byte[] bytes = Encoding.UTF8.GetBytes(msg);
//向文件中写入字节数组
fileStream.Write(bytes, 0, bytes.Length);
//刷新缓冲区
fileStream.Flush();
//关闭流
fileStream.Close();

class Program
{
  static void Main(string[] args)
  {
    //定义文件路径
    string path = @"D:\\code\\test.txt";
    //判断是否含有指定文件
    if(File.Exists(path))
    {
      FileStream fileStream = new FileStream(path, FileMode.Open, FileAccess.Read);
      //定义存放文件信息的字节数组
      byte[] bytes = new byte[fileStream.Length];
      //读取文件信息
      fileStream.Read(bytes, 0, bytes.Length);
      //将得到的字节型数组重写编码为字符型数组
      char[] c = Encoding.UTF8.GetChars(bytes);
      //输出
      Console.WriteLine(c);
      //关闭流
      fileStream.Close();
    }
    else
    {
      Console.WriteLine("不存在！");
    }
  }
}

文件复制

 public class FileSreamTest
 {
   public static void CopyFile(string source, string target)
   {
     //读取文件流
     using(FileStream fsRead = new FileStream(source, FileMode.Open, FileAccess.Read))
     {
       //写入流
       using(FileStream fsWrite = new FileStream(target, FileMode.OpenOrCreate, FileAccess.Write))
       {
         byte[] buffer = new byte[1024 * 1024 * 5];
         while(true)
         {
           //返回读取字节数
           int r = fsRead.Read(buffer, 0, buffer.Length);
           if(r == 0)
           {
             break;
           }
           //写入
           fsWrite.Write(buffer, 0, r);
         }
       }
     }
   }
 }
 static void Main(string[] args)
 {
   string source = @"E:\功能流程.7z";
   string target = @"C:\Users\CH190006\Desktop\Test\功能流程.7z";
   FileSreamTest.CopyFile(source, target);
   Console.ReadKey();
 }