FileStream 类

定义

public ref class FileStream : System::IO::Stream

public class FileStream : System.IO.Stream

[System.Runtime.InteropServices.ComVisible(true)]
public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

[<System.Runtime.InteropServices.ComVisible(true)>]
type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

继承

Object

Stream

FileStream

继承

Object

MarshalByRefObject

Stream

FileStream

派生

System.IO.IsolatedStorage.IsolatedStorageFileStream

属性

ComVisibleAttribute

示例

以下示例演示了 FileStream 一些构造函数。

using System;
using System.IO;
using System.Text;

class Test
{

    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";

        // Delete the file if it exists.
        if (File.Exists(path))
        {
            File.Delete(path);
        }

        //Create the file.
        using (FileStream fs = File.Create(path))
        {
            AddText(fs, "This is some text");
            AddText(fs, "This is some more text,");
            AddText(fs, "\r\nand this is on a new line");
            AddText(fs, "\r\n\r\nThe following is a subset of characters:\r\n");

            for (int i=1;i < 120;i++)
            {
                AddText(fs, Convert.ToChar(i).ToString());
            }
        }

        //Open the stream and read it back.
        using (FileStream fs = File.OpenRead(path))
        {
            byte[] b = new byte[1024];
            UTF8Encoding temp = new UTF8Encoding(true);
            int readLen;
            while ((readLen = fs.Read(b,0,b.Length)) > 0)
            {
                Console.WriteLine(temp.GetString(b,0,readLen));
            }
        }
    }

    private static void AddText(FileStream fs, string value)
    {
        byte[] info = new UTF8Encoding(true).GetBytes(value);
        fs.Write(info, 0, info.Length);
    }
}

open System
open System.IO
open System.Text

let addText (fs:FileStream) (value: string) =
    let info = UTF8Encoding(true).GetBytes value
    fs.Write(info, 0, info.Length);

let path = @"c:\temp\MyTest.txt"

// Delete the file if it exists.
if File.Exists path then
    File.Delete path

//Create the file.
do
    use fs = File.Create path

    addText fs "This is some text"
    addText fs "This is some more text,"
    addText fs "\r\nand this is on a new line"
    addText fs "\r\n\r\nThe following is a subset of characters:\r\n"

    for i = 1 to 119 do
        Convert.ToChar i
        |> string
        |> addText fs
    
do
    //Open the stream and read it back.
    use fs = File.OpenRead path
    let b = Array.zeroCreate 1024
    let temp = UTF8Encoding true
    let mutable readLen = fs.Read(b,0,b.Length);
    while readLen> 0 do
        printfn $"{temp.GetString(b,0,readLen)}"
        readLen <- fs.Read(b,0,b.Length)

Imports System.IO
Imports System.Text

Public Class Test

    Public Shared Sub Main()
        Dim path As String = "c:\temp\MyTest.txt"

        ' Delete the file if it exists.
        If File.Exists(path) Then
            File.Delete(path)
        End If

        'Create the file.
        Dim fs As FileStream = File.Create(path)

        AddText(fs, "This is some text")
        AddText(fs, "This is some more text,")
        AddText(fs, Environment.NewLine & "and this is on a new line")
        AddText(fs, Environment.NewLine & Environment.NewLine)
        AddText(fs, "The following is a subset of characters:" & Environment.NewLine)

        Dim i As Integer

        For i = 1 To 120
            AddText(fs, Convert.ToChar(i).ToString())

        Next

        fs.Close()

        'Open the stream and read it back.
        fs = File.OpenRead(path)
        Dim b(1023) As Byte
        Dim temp As UTF8Encoding = New UTF8Encoding(True)

        Do While fs.Read(b, 0, b.Length) > 0
            Console.WriteLine(temp.GetString(b))
        Loop

        fs.Close()
    End Sub

    Private Shared Sub AddText(ByVal fs As FileStream, ByVal value As String)
        Dim info As Byte() = New UTF8Encoding(True).GetBytes(value)
        fs.Write(info, 0, info.Length)
    End Sub
End Class

以下示例演示如何异步写入文件。 此代码在WPF应用中运行，该应用具有名为 UserInput 的 TextBlock，以及一个与名为Button_Click的 Click 事件处理程序挂钩的按钮。 文件路径需要更改为计算机上存在的文件。

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            UnicodeEncoding uniencoding = new UnicodeEncoding();
            string filename = @"c:\Users\exampleuser\Documents\userinputlog.txt";

            byte[] result = uniencoding.GetBytes(UserInput.Text);

            using (FileStream SourceStream = File.Open(filename, FileMode.OpenOrCreate))
            {
                SourceStream.Seek(0, SeekOrigin.End);
                await SourceStream.WriteAsync(result, 0, result.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
        Dim filename As String = "c:\Users\exampleuser\Documents\userinputlog.txt"

        Dim result As Byte() = uniencoding.GetBytes(UserInput.Text)

        Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
            SourceStream.Seek(0, SeekOrigin.End)
            Await SourceStream.WriteAsync(result, 0, result.Length)
        End Using
    End Sub
End Class

注解

使用 FileStream 类读取、写入、打开和关闭文件系统上的文件，并操作其他与文件相关的操作系统句柄，包括管道、标准输入和标准输出。 可以使用 Read、Write、CopyTo 和 Flush 方法来执行同步操作，或者使用 ReadAsync、WriteAsync、CopyToAsync 和 FlushAsync 方法来执行异步操作。 使用异步的方法以执行资源占用较多的文件操作，而不阻止主线程。 此性能注意事项在桌面应用中尤其重要，其中耗时的流操作可以阻止 UI 线程，并使应用看起来好像不起作用一样。 FileStream 缓冲输入和输出以提高性能。

该 IsAsync 属性检测文件句柄是否已异步打开。 使用具有 FileStream、isAsync或useAsync参数的options构造函数创建类的实例时，请指定此值。 当属性是 true 时，流利用重叠 I/O 异步执行文件作业。 但是，IsAsync 属性不必是 true 即可调用 ReadAsync、WriteAsync 或 CopyToAsync 方法。 当 IsAsync 属性为 false 时，调用异步读写操作，UI 线程仍然不会被阻止，但实际的 I/O 操作将同步执行。

该方法 Seek 支持对文件的随机访问。 Seek 允许将读/写位置移动到文件中的任何位置。 这是通过字节偏移引用点参数完成的。 字节偏移量是相对于查找引用点而言的，该引用点可以是基础文件的开头、当前位置或末尾，分别由枚举的三个成员表示。

如果一个进程终止时部分文件被锁定，或者关闭了一个仍有未释放锁的文件，其行为是未定义的。

有关目录操作和其他文件操作，请参阅File、Directory和Path类。 该 File 类是一个实用工具类，其静态方法主要用于基于文件路径创建 FileStream 对象。 该 MemoryStream 类从字节数组创建流，类似于 FileStream 类。

有关常见文件和目录作的列表，请参阅 常见 I/O 任务。

检测流位置更改

FileStream当一个对象没有在其句柄上进行独占保留时，另一个线程可以并发访问该文件句柄，并更改与该文件句柄关联的操作系统文件指针的位置。 在这种情况下，对象中的 FileStream 缓存位置以及缓冲区中缓存的数据可能会受到损害。 该 FileStream 对象定期检查访问缓存缓冲区的方法，以确保操作系统的句柄位置与 FileStream 对象使用的缓存位置相同。

如果在调用 Read 方法时检测到句柄位置的意外更改，.NET 将丢弃缓冲区的内容，并从文件开始重新读取流。 这可能会影响性能，具体取决于文件大小以及可能影响文件流位置的任何其他进程。

如果在调用Write方法时检测到句柄位置发生意外更改，缓冲区的内容将被丢弃，并会引发IOException异常。

当访问 FileStream 属性来公开句柄，或者在构造函数中为 SafeFileHandle 对象赋予 FileStream 属性时，SafeFileHandle 对象将不会独占其句柄。

另请参阅

• File
• FileAccess
• FileMode
• FileShare
• 文件和流输入/输出
• 如何：从文件读取文本
• 如何：将文本写入文件
• 如何：读取和写入新创建的数据文件