异步文件访问 (C#)

可使用异步功能访问文件。 通过使用异步功能，你可以调用异步方法而无需使用回调，也不需要跨多个方法或 lambda 表达式来拆分代码。 若要使同步代码异步，只需调用异步方法而非同步方法，并向代码中添加几个关键字。

可能出于以下原因向文件访问调用中添加异步：

使用适当的类

本主题中的简单示例演示 File.WriteAllTextAsync 和 File.ReadAllTextAsync。 要对文件 I/O 操作进行精细的控制，请使用 FileStream 类，该类有一个可导致在操作系统级别出现异步 I/O 的选项。 使用此选项可避免在许多情况下阻止线程池线程。 若要启用此选项，可在构造函数调用中指定 useAsync=true 或 options=FileOptions.Asynchronous 参数。

如果通过指定文件路径直接打开 StreamReader 和 StreamWriter，则无法将此选项与这二者配合使用。 但是，如果为二者提供已由 FileStream 类打开的 Stream，则可以使用此选项。 即使线程池线程受到阻止，UI 应用中的异步调用也会更快，因为 UI 线程在等待期间不会受到阻止。

写入文本

下面的示例将文本写入文件。 在每个 await 语句中，该方法会立即退出。 文件 I/O 完成后，该方法将在 await 语句后面的语句中继续。 Async 修饰符位于使用 await 语句的方法定义中。

简单示例

public async Task SimpleWriteAsync()
{
    string filePath = "simple.txt";
    string text = $"Hello World";

    await File.WriteAllTextAsync(filePath, text);
}

有限控制示例

public async Task ProcessWriteAsync()
{
    string filePath = "temp.txt";
    string text = $"Hello World{Environment.NewLine}";

    await WriteTextAsync(filePath, text);
}

async Task WriteTextAsync(string filePath, string text)
{
    byte[] encodedText = Encoding.Unicode.GetBytes(text);

    using var sourceStream =
        new FileStream(
            filePath,
            FileMode.Create, FileAccess.Write, FileShare.None,
            bufferSize: 4096, useAsync: true);

    await sourceStream.WriteAsync(encodedText, 0, encodedText.Length);
}

原始示例包含 await sourceStream.WriteAsync(encodedText, 0, encodedText.Length); 语句，它是下面两个语句的缩写式：

Task theTask = sourceStream.WriteAsync(encodedText, 0, encodedText.Length);
await theTask;

第一条语句返回任务，并会导致文件处理启动。 具有 await 的第二条语句将使方法立即退出并返回一个不同的任务。 文件处理稍后完成后，执行将返回到 await 后面的语句中。

读取文本

下面的示例从文件中读取文本。

简单示例

public async Task SimpleReadAsync()
{
    string filePath = "simple.txt";
    string text = await File.ReadAllTextAsync(filePath);

    Console.WriteLine(text);
}

有限控制示例

将会缓冲文本，并且在此情况下，会将其放入 StringBuilder。 与前一示例不同，await 的计算将生成一个值。 ReadAsync 方法返回 Task<Int32>，因此在操作完成后 await 的评估会得出 Int32 值 numRead。 有关详细信息，请参阅异步返回类型 (C#)。

public async Task ProcessReadAsync()
{
    try
    {
        string filePath = "temp.txt";
        if (File.Exists(filePath) != false)
        {
            string text = await ReadTextAsync(filePath);
            Console.WriteLine(text);
        }
        else 
        {
            Console.WriteLine($"file not found: {filePath}");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.Message);
    }
}

async Task<string> ReadTextAsync(string filePath)
{
    using var sourceStream =
        new FileStream(
            filePath,
            FileMode.Open, FileAccess.Read, FileShare.Read,
            bufferSize: 4096, useAsync: true);

    var sb = new StringBuilder();

    byte[] buffer = new byte[0x1000];
    int numRead;
    while ((numRead = await sourceStream.ReadAsync(buffer, 0, buffer.Length)) != 0)
    {
        string text = Encoding.Unicode.GetString(buffer, 0, numRead);
        sb.Append(text);
    }

    return sb.ToString();
}

并行异步 I/O

下面的示例通过编写 10 个文本文件来演示并行处理。

简单示例

public async Task SimpleParallelWriteAsync()
{
    string folder = Directory.CreateDirectory("tempfolder").Name;
    IList<Task> writeTaskList = new List<Task>();

    for (int index = 11; index <= 20; ++ index)
    {
        string fileName = $"file-{index:00}.txt";
        string filePath = $"{folder}/{fileName}";
        string text = $"In file {index}{Environment.NewLine}";

        writeTaskList.Add(File.WriteAllTextAsync(filePath, text));
    }

    await Task.WhenAll(writeTaskList);
}

有限控制示例

对于每个文件，WriteAsync 方法将返回一个任务，此任务随后将添加到任务列表中。 await Task.WhenAll(tasks); 语句将退出该方法，并在所有任务的文件处理完成时在此方法中继续。

该示例将在任务完成后关闭 finally 块中的所有 FileStream 实例。 如果每个 FileStream 均已在 using 语句中创建，则可能在任务完成前释放 FileStream。

任何性能提升都几乎完全来自并行处理而不是异步处理。 异步的优点在于它不会占用多个线程，也不会占用用户界面线程。

public async Task ProcessMulitpleWritesAsync()
{
    IList<FileStream> sourceStreams = new List<FileStream>();

    try
    {
        string folder = Directory.CreateDirectory("tempfolder").Name;
        IList<Task> writeTaskList = new List<Task>();

        for (int index = 1; index <= 10; ++ index)
        {
            string fileName = $"file-{index:00}.txt";
            string filePath = $"{folder}/{fileName}";

            string text = $"In file {index}{Environment.NewLine}";
            byte[] encodedText = Encoding.Unicode.GetBytes(text);

            var sourceStream = 
                new FileStream(
                    filePath,
                    FileMode.Create, FileAccess.Write, FileShare.None,
                    bufferSize: 4096, useAsync: true);

            Task writeTask = sourceStream.WriteAsync(encodedText, 0, encodedText.Length);
            sourceStreams.Add(sourceStream);

            writeTaskList.Add(writeTask);
        }

        await Task.WhenAll(writeTaskList);
    }
    finally
    {
        foreach (FileStream sourceStream in sourceStreams)
        {
            sourceStream.Close();
        }
    }
}

当使用 WriteAsync 和 ReadAsync 方法时，可以指定可用于取消操作中间流的 CancellationToken。 有关详细信息，请参阅托管线程中的取消。

另请参阅

• 使用 Async 和 Await 的异步编程 (C#)
• 异步返回类型 (C#)