谨慎使用 FileInfo.Exists 实例方法,而是使用 File.Exists 静态方法替代

如果你在代码中使用了 FileInfo.Exists 实例方法来判断一个文件是否存在,也许会发现此方法可能错误地判断来一个文件是否真的存在。这是一个坑。

本文将介绍坑的原因,并提供填坑的办法。


问题代码

我们使用两种不同的方式判断文件是否存在:

static async Task Main(string[] args)
{
    var filePath = @"C:\Users\lvyi\Desktop\walterlv.log";
    var fileInfo = new FileInfo(filePath);
    while (true)
    {
        Console.WriteLine($"FileInfo.Exists = {fileInfo.Exists}");
        Console.WriteLine($"    File.Exists = {File.Exists(filePath)}");
        Console.WriteLine("----");
        await Task.Delay(1000);
    }
}

现在运行这个程序,我们会发现,中途删除了 walterlv.log 文件之后,FileInfo.Exists 依然返回了 true,而 File.Exists 已经开始返回 false 了。

以上代码在的运行结果

原因分析

实际翻阅代码可以发现,FileInfo.ExistsFile.Exists 方法最终都是使用相同的方法来完成文件存在与否的判断。

这是 FileInfo.Exists 的判断:

public override bool Exists
{
    [SecuritySafeCritical] get
    {
        try
        {
            if (this._dataInitialised == -1)
                this.Refresh();
            if (this._dataInitialised != 0)
                return false;
            return (this._data.fileAttributes & 16) == 0;
        }
        catch
        {
            return false;
        }
    }
}

这是 File.Exists 的最终判断:

public static bool FileExists(string fullPath)
{
    Interop.Kernel32.WIN32_FILE_ATTRIBUTE_DATA data = new Interop.Kernel32.WIN32_FILE_ATTRIBUTE_DATA();
    int errorCode = FillAttributeInfo(fullPath, ref data, returnErrorOnNotFound: true);

    return (errorCode == 0) && (data.dwFileAttributes != -1)
            && ((data.dwFileAttributes & Interop.Kernel32.FileAttributes.FILE_ATTRIBUTE_DIRECTORY) == 0);
}

只不过,FileInfo.Exists 只会在没有初始化的时候初始化一次,而 File.Exists 是没有缓存的,每次都是直接去获取文件的属性(这就涉及到 IO)。

解决办法

所以,如果你正在处理的文件在不同的时间可能存在也可能不存在,那么最好使用 File.Exists 来判断文件存在与否,而不是使用 FileInfo.Exists 来判断。

不过,如果你需要一次性判断文件的非常多的信息(而不只是文件存在与否),那么依然建议使用 FileInfo,只不过在使用之前需要调用 Refresh 进行一次刷新。

blog bulletin

本文会经常更新,请阅读原文: https://blog.walterlv.com/post/file-exists-vs-fileinfo-exists.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

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

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