# 档案系统测试：使用System.IO.Abstractions 模拟档案操作 ## 适用于当被要求执行以下任务时，请使用此技能： * 重构直接使用 `System.IO.File`、`System.IO.Directory` 等静态类别的程序代码 * 为涉及档案读写、目录操作的程序码编写单元测试 * 使用MockFileSystem 模拟各种文件系统状态 * 档案测试权限不足、档案不存在等问题 * 设计可测试的文件处理服务架构 ## 核心原则 ### 1\. 档案系统相关性的根本问题传统直接使用 `System.IO` 静态类别的程序代码难以测试，原因包括： * **速度问题** ：实际磁碟IO比记忆体操作慢10-100倍 * **环境相依** ：测试结果受档案系统状态、权限、路径影响 * **后果** ：测试会在磁碟上留下痕迹，影响其他测试 * **同时毛问题** ：多个测试操作相同的档案会产生竞争条件 * **错误模拟困难**：难以模拟权限不足、磁碟空间不足等异常 ### 2\. System.IO.Abstractions解决方案这是一个将 System.IO 静态颜色包装成介面的套件，支持依赖注入和测试替换体。 **核心介面架构**：公共接口 IFileSystem { IFile 文件 { 获取; } IDirectory 目录 { 获取; } IFileInfo 文件信息 { 获取； } IDirectoryInfo DirectoryInfo { 获取； } IPath 路径 { 获取； } IDriveInfo DriveInfo { 获取； } } **必要的NuGet套件**： ### 3\. 步骤重构 **步骤一** ：将直接使用静态类别的程序代码改为依赖 `IFileSystem` // ❌重构前（不可测试）公共类配置服务 { 公共字符串LoadConfig（字符串路径） { 返回 File.ReadAllText(路径); } } // ✅ 重构后（可测试）公共类配置服务 { 私有只读 IFileSystem _fileSystem；公共 ConfigService(IFileSystem 文件系统) { _文件系统=文件系统； } 公共字符串LoadConfig（字符串路径） { 返回 _fileSystem.File.ReadAllText(路径); } } **步骤二** ：在DI容器中注册真实实作 // 程序.cs services.AddSingleton(); services.AddScoped(); **步骤三** ：在测试中使用MockFileSystem var mockFs = new MockFileSystem(new Dictionary<字符串, MockFileData> { ["config.json"] = new MockFileData("{ \"key\": \"value\" }") }); var service = new ConfigService(mockFs); ## MockFileSystem 测试模式 ### 模式一：默认文件状态 [事实] public async Task LoadConfig_档案存在_应回传内容() { // 整理-建立预设的档案系统状态 var mockFileSystem = new MockFileSystem(new Dictionary<字符串, MockFileData> { ["config.json"] = new MockFileData("{ \"key\": \"value\" }"), [@"C:\data\users.csv"] = new MockFileData("姓名,年龄\nJohn,25"), [@"C:\logs\"] = new MockDirectoryData() // 空目录 }); var service = new ConfigService(mockFileSystem); // 行动 var result = wait service.LoadConfigAsync("config.json"); // 断言结果.Should().Contain("key"); } ### 模式二：验证写入结果 [事实] 公共异步任务SaveConfig_指定内容_应正确写入() { // 排列 var mockFileSystem = new MockFileSystem(); var service = new ConfigService(mockFileSystem); // 行动等待 service.SaveConfigAsync("output.json", "{ \"saved\": true }"); // 断言-验证档案系统的最终状态 mockFileSystem.File.Exists("output.json").Should().BeTrue(); var content =等待mockFileSystem.File.ReadAllTextAsync(“output.json”); content.Should().Contain("已保存"); } ### 模式三：测试目录操作 [事实] public void CopyFile_目标目录不存在_应自动建立() { // 排列 var mockFileSystem = new MockFileSystem(new Dictionary<字符串, MockFileData> { [@"C:\source\file.txt"] = new MockFileData("内容") }); var service = new FileManagerService(mockFileSystem); // 行动 service.CopyFileToDirectory(@"C:\source\file.txt", @"C:\target\subfolder"); // 断言 mockFileSystem.Directory.Exists(@"C:\target\subfolder").Should().BeTrue(); mockFileSystem.File.Exists(@"C:\target\subfolder\file.txt").Should().BeTrue(); } ###模式四：使用NSubstitute模拟错误当需要模拟特定异常时，MockFileSystem 支持有限，可使用 NSubstitute： [事实] public void TryReadFile_权限不足_应回传False() { // 排列 var mockFileSystem = Substitute.For(); var mockFile = Substitute.For(); mockFileSystem.File.Returns(mockFile); mockFile.Exists("protected.txt").Returns(true); mockFile.ReadAllText(“受保护的.txt”) .Throws(new UnauthorizedAccessException("访问被拒")); var service = new FilePermissionService(mockFileSystem); // 行动 var result = service.TryReadFile("protected.txt", out var content); // 断言结果.Should().BeFalse(); 内容.Should().BeNull(); } ## 进阶测试技巧 ### 串流操作测试 [事实] public async Task CountLines_多行档案_应回传正确行数() { // 排列 var content = "第 1 行\n第 2 行\n第 3 行\n第 4 行"; var mockFileSystem = new MockFileSystem(new Dictionary<字符串, MockFileData> { [“data.txt”] = new MockFileData(内容) }); var 处理器 = new StreamProcessorService(mockFileSystem); // 行动 var 结果 = 等待处理器.CountLinesAsync("data.txt"); // 断言结果.Should().Be(4); } ### 档案资讯测试 [事实] public void GetFileInfo_档案存在_应回传正确资讯() { // 排列 var content = "你好，世界！"; var mockFileSystem = new MockFileSystem(new Dictionary<字符串, MockFileData> { [@"C:\test.txt"] = new MockFileData(内容) }); var service = new FileManagerService(mockFileSystem); // 行动 var info = service.GetFileInfo(@"C:\test.txt"); // 断言 info.Should().NotBeNull(); info!.Name.Should().Be("test.txt"); info.Size.Should().Be(内容.长度); } ### 备份文件测试 [事实] public void BackupFile_档案存在_应建立时间记备份() { // 排列 var mockFileSystem = new MockFileSystem(new Dictionary<字符串, MockFileData> { [@"C:\data\important.txt"] = new MockFileData("重要资料") }); var service = new FileManagerService(mockFileSystem); // 行动 var backupPath = service.BackupFile(@"C:\data\important.txt"); // 断言 backupPath.Should().StartWith(@"C:\data\important_"); backupPath.Should().EndWith(".txt"); mockFileSystem.File.Exists(backupPath).Should().BeTrue(); } ## 最佳实践 ### ✅ 应该这样做 1. **使用Path.Combine处理路径** ： var path = _fileSystem.Path.Combine("configs", "app.json"); 2. **防御性检查档案存在性**： if (!_fileSystem.File.Exists(filePath)) { 返回默认值； } 3. **自动建立必要目录** ： var dir = _fileSystem.Path.GetDirectoryName(filePath); if (!string.IsNullOrEmpty(dir) && !_fileSystem.Directory.Exists(dir)) { _fileSystem.Directory.CreateDirectory(dir); } 4. **通道处理各种IO异常**：尝试 { 返回等待_fileSystem.File.ReadAllTextAsync（路径）； } catch (UnauthorizedAccessException) { /* 权限不足 */ } catch (IOException) { /* 档案被锁定 */ } catch (DirectoryNotFoundException) { /* 目录不存在 */ } 5. **每个测试都使用独立的MockFileSystem**：公共类服务测试 { [事实] 公共无效测试1（） { var mockFs = new MockFileSystem(); // 独立实例 } [事实] 公共无效测试2（） { var mockFs = new MockFileSystem(); // 独立实例 } } ### ❌应该避免 1. **硬编码路径分隔符号** ： // ❌不要这样做 var 路径 = "configs\\app.json"; // 仅限Windows var 路径 = "configs/app.json"; // 仅限 Unix // ✅ 应该这样做 var path = _fileSystem.Path.Combine("configs", "app.json"); 2. **在单元测试中使用真实档案系统**： // ❌这不是单元测试 var realFs = new FileSystem(); // ✅ 单元测试应使用 MockFileSystem var mockFs = new MockFileSystem(); 3. **忽略例外处理** ： // ❌不要假设档案一定存在 var content = _fileSystem.File.ReadAllText(路径); // ✅ 加入存在性检查和例外处理 if (_fileSystem.File.Exists(路径)) { 尝试{返回_fileSystem.File.ReadAllText(路径); } catch (IOException) { 返回默认值; } } ## 符合考量 ### MockFileSystem 优势 * **速度** ：比真实文件操作快 10-100 倍 * **可靠性** ：不受磁碟状态影响 * **隔离性** ：测试之间完全隔离 * **错误模拟**：可准确模拟各种异常安全 ### 记忆体使用建议 * 只建立测试必要的文件 * 避免在测试中模拟超大文件 * 对于大档案处理逻辑，使用适应大小的测试数据： // ✅ 适应大小的测试数据 var testContent = string.Join("\n", Enumerable.Range(1, 1000).Select(i => $"第 {i} 行")); mockFileSystem.AddFile("test.txt", new MockFileData(testContent)); ## 实务整合范例 ### 设定档管理服务请参考 `templates/configmanager-service.cs` 中的完整实现，包含： * 设定档加载与存储 * JSON序列化与反序列化 * 自动建立目录 * 设置文件备份功能 ### 档案管理服务请参考 `templates/filemanager-service.cs` 中的实作，包含： * 档案复制与备份 * 目录操作 * 档案资讯查询 * 错误处理模式 ## 参考资源 ### 原始文章本技能内容提炼自「老派软体工程师的测试修练 - 30天挑战」系列文章： * **第 17 天 - 档案与 IO 测试：使用 System.IO.Abstractions 模拟档案系统** * 铁人赛文章： * 示例程序代码： ### 官方文件 * [System.IO.Abstractions GitHub]() * [System.IO.Abstractions NuGet]() * [TestingHelpers NuGet]() ### 相关技能 * `nsubstitute-mocking` \- 测试替身与模拟 * `unit-test-fundamentals` \- 单元测试基础

Dotnet 测试文件系统测试抽象

包含技能