在进行文件读写时,如果进行单元测试,是需要很多设计,因为本地的文件可能因为单元测试之间的占用,以及还原数据,会影响业务。本文告诉大家使用注入的方式,让文件读写一个抽象的对象

单元测试文件读写的难点是构建出测试的文件,如要求文件的权限是用户不可读,如要求文件的长度很长,如要求文件的修改时间。而 System.IO.Abstractions 这个库提供了注入抽象的文件,所有属性都可以设置

首先安装 System.IO.Abstractions 库,这个库提供了 IFileSystem 接口,使用这个接口提供的文件读写方法代替静态类 File 等方法。这样通过注入 IFileSystem 接口,可以进行文件读写测试

Install-Package System.IO.Abstractions

在使用 System.IO.Abstractions 库进行注入,需要对代码进行一些修改,如将 File.ReadAllText 的代码修改为 fileSystem.File.ReadAllText 这里的 fileSystem 是 IFileSystem 进行注入

在进行单元测试的注入,可选的是构造注入等方法,通过注入的 IFileSystem 属性进行文件读写

    public class Foo
    {
        /// <inheritdoc />
        public Foo(IFileSystem fileSystem)
        {
            FileSystem = fileSystem;
        }

        public IFileSystem FileSystem { get; }
    }

之后的文件读写,大概修改如 File.ReadAllText 和 FileStream 代码

            IFileSystem fileSystem = FileSystem;

            File.ReadAllText("lindexi.txt");
            fileSystem.File.ReadAllText("lindexi.txt");

也就是将 File.ReadAllText 替换 fileSystem.File.ReadAllText 方法

            new FileStream("blog.lindexi.com", FileMode.Create);
            fileSystem.FileStream.Create("blog.lindexi.com", FileMode.Create);

此时进行单元测试注入,这里用 Mock 的方法创建一个抽象的对象

单元测试需要按照 System.IO.Abstractions.TestingHelpers 库

注入 IFileSystem 方法

            var mockFileSystem = new MockFileSystem(new Dictionary<string, MockFileData>()
            {
                {
                    "文件路径", new MockFileData("文件内容")
                },
                { "文件夹", new MockDirectoryData() }
            });

            var foo = new Foo(mockFileSystem);

在 MockFileSystem 支持设置文件或文件夹的属性,不需要存在实际的文件

如果需要虚拟更多接口,请使用 Mock 方法


本文会经常更新,请阅读原文: https://blog.lindexi.com/post/dotnet-%E5%8D%95%E5%85%83%E6%B5%8B%E8%AF%95%E6%B3%A8%E5%85%A5%E6%96%87%E4%BB%B6%E8%AF%BB%E5%86%99.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

如果你想持续阅读我的最新博客,请点击 RSS 订阅,推荐使用RSS Stalker订阅博客,或者前往 CSDN 关注我的主页

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名林德熙(包含链接: https://blog.lindexi.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系

以下是广告时间

推荐关注 Edi.Wang 的公众号