System.IO.Abstractions 项目技术文档

1. 安装指南

为了使用 System.IO.Abstractions 项目，首先需要通过 NuGet 包管理器安装相应的包。以下是安装命令：

dotnet add package TestableIO.System.IO.Abstractions.Wrappers

请注意，此 NuGet 包也以 System.IO.Abstractions 名称发布，但我们建议使用前缀，以明确这不是一个官方的 .NET 包。

2. 项目的使用说明

System.IO.Abstractions 项目提供了一个可注入和可测试的 IFileSystem 接口及其实现 FileSystem。与其直接调用如 File.ReadAllText 这样的静态方法，不如使用 IFileSystem.File.ReadAllText。本项目提供的 API 与标准 .NET API 完全相同，但具有更好的测试性。

以下是一个使用 IFileSystem 接口的简单示例：

public class MyComponent
{
    readonly IFileSystem fileSystem;

    public MyComponent(IFileSystem fileSystem)
    {
        this.fileSystem = fileSystem;
    }

    public MyComponent() : this(new FileSystem()) // 使用默认实现
    {
    }

    public void Validate()
    {
        foreach (var textFile in fileSystem.Directory.GetFiles(@"c:\", "*.txt", SearchOption.TopDirectoryOnly))
        {
            var text = fileSystem.File.ReadAllText(textFile);
            if (text != "Testing is awesome.")
                throw new NotSupportedException("我们无法继续。这不是我的问题，是你的问题。");
        }
    }
}

3. 项目API使用文档

本项目提供了与标准 .NET System.IO 命名空间相似的 API，但所有方法都是通过 IFileSystem 接口实现的，这使得它们可以被注入和测试。

以下是一些关键接口和类的简要说明：

• IFileSystem：提供文件系统操作的核心接口。
• FileSystem：IFileSystem 接口的默认实现，调用实际的 System.IO 方法。
• IFile：提供文件操作的接口。
• IDirectory：提供目录操作的接口。
• IFileSystemWatcher：用于监视文件系统更改的接口。

4. 项目安装方式

项目的安装方式已在安装指南中说明，此处再次简要概述：

• 使用 NuGet 包管理器安装 TestableIO.System.IO.Abstractions.Wrappers 包。

dotnet add package TestableIO.System.IO.Abstractions.Wrappers

此外，如果需要进行单元测试，可以安装 TestableIO.System.IO.Abstractions.TestingHelpers 包，它提供了一系列测试辅助工具，用于模拟文件系统。

dotnet add package TestableIO.System.IO.Abstractions.TestingHelpers

以上步骤将为项目添加所需的引用，以便使用 System.IO.Abstractions 提供的功能。