IT-Swarm.Net

有没有办法检查文件是否正在使用?

我正在用C#编写一个需要重复访问1个图像文件的程序。大部分时间它都可以工作,但是如果我的计算机运行得很快,它将尝试在将文件保存回文件系统之前访问该文件并抛出错误: “另一个进程正在使用的文件”

我想找到解决这个问题的方法,但是我所有的谷歌搜索都只通过使用异常处理来创建检查。这违背了我的宗教信仰,所以我想知道是否有人有更好的方法呢?

768
Dawsy

对此解决方案的更新说明 :使用FileAccess.ReadWrite检查将对只读文件失败,因此已修改解决方案以使用FileAccess.Read进行检查。虽然此解决方案有效,因为如果文件上有写入或读取锁定,尝试使用FileAccess.Read检查将失败,但是,如果文件上没有写入或读取锁定,则此解决方案将无效,即它已被使用FileShare.Read或FileShare.Write访问打开(用于读取或写入)。

原文: 我在过去的几年中使用过这段代码,我没有遇到任何问题。

了解您对使用异常的犹豫,但您无法一直避免它们:

protected virtual bool IsFileLocked(FileInfo file)
{
    FileStream stream = null;

    try
    {
        stream = file.Open(FileMode.Open, FileAccess.Read, FileShare.None);
    }
    catch (IOException)
    {
        //the file is unavailable because it is:
        //still being written to
        //or being processed by another thread
        //or does not exist (has already been processed)
        return true;
    }
    finally
    {
        if (stream != null)
            stream.Close();
    }

    //file is not locked
    return false;
}
499
ChrisW

您可能会遇到线程争用情况,其中有文档示例将此用作安全漏洞。如果您检查该文件是否可用,但是然后尝试使用它,那么您可以抛出这一点,恶意用户可以使用该文件来强制和利用您的代码。

你最好的选择是尝试catch/finally,它试图获取文件句柄。

try
{
   using (Stream stream = new FileStream("MyFilename.txt", FileMode.Open))
   {
        // File/Stream manipulating code here
   }
} catch {
  //check here why it failed and ask user to retry if the file is in use.
}
529
Spence

用它来检查文件是否被锁定:

using System.IO;
using System.Runtime.InteropServices;
internal static class Helper
{
const int ERROR_SHARING_VIOLATION = 32;
const int ERROR_LOCK_VIOLATION = 33;

private static bool IsFileLocked(Exception exception)
{
    int errorCode = Marshal.GetHRForException(exception) & ((1 << 16) - 1);
    return errorCode == ERROR_SHARING_VIOLATION || errorCode == ERROR_LOCK_VIOLATION;
}

internal static bool CanReadFile(string filePath)
{
    //Try-Catch so we dont crash the program and can check the exception
    try {
        //The "using" is important because FileStream implements IDisposable and
        //"using" will avoid a heap exhaustion situation when too many handles  
        //are left undisposed.
        using (FileStream fileStream = File.Open(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None)) {
            if (fileStream != null) fileStream.Close();  //This line is me being overly cautious, fileStream will never be null unless an exception occurs... and I know the "using" does it but its helpful to be explicit - especially when we encounter errors - at least for me anyway!
        }
    }
    catch (IOException ex) {
        //THE FUNKY MAGIC - TO SEE IF THIS FILE REALLY IS LOCKED!!!
        if (IsFileLocked(ex)) {
            // do something, eg File.Copy or present the user with a MsgBox - I do not recommend Killing the process that is locking the file
            return false;
        }
    }
    finally
    { }
    return true;
}
}

出于性能原因,我建议您在同一操作中读取文件内容。这里有些例子:

public static byte[] ReadFileBytes(string filePath)
{
    byte[] buffer = null;
    try
    {
        using (FileStream fileStream = File.Open(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
        {
            int length = (int)fileStream.Length;  // get file length
            buffer = new byte[length];            // create buffer
            int count;                            // actual number of bytes read
            int sum = 0;                          // total number of bytes read

            // read until Read method returns 0 (end of the stream has been reached)
            while ((count = fileStream.Read(buffer, sum, length - sum)) > 0)
                sum += count;  // sum is a buffer offset for next reading

            fileStream.Close(); //This is not needed, just me being paranoid and explicitly releasing resources ASAP
        }
    }
    catch (IOException ex)
    {
        //THE FUNKY MAGIC - TO SEE IF THIS FILE REALLY IS LOCKED!!!
        if (IsFileLocked(ex))
        {
            // do something? 
        }
    }
    catch (Exception ex)
    {
    }
    finally
    {
    }
    return buffer;
}

public static string ReadFileTextWithEncoding(string filePath)
{
    string fileContents = string.Empty;
    byte[] buffer;
    try
    {
        using (FileStream fileStream = File.Open(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
        {
            int length = (int)fileStream.Length;  // get file length
            buffer = new byte[length];            // create buffer
            int count;                            // actual number of bytes read
            int sum = 0;                          // total number of bytes read

            // read until Read method returns 0 (end of the stream has been reached)
            while ((count = fileStream.Read(buffer, sum, length - sum)) > 0)
            {
                sum += count;  // sum is a buffer offset for next reading
            }

            fileStream.Close(); //Again - this is not needed, just me being paranoid and explicitly releasing resources ASAP

            //Depending on the encoding you wish to use - I'll leave that up to you
            fileContents = System.Text.Encoding.Default.GetString(buffer);
        }
    }
    catch (IOException ex)
    {
        //THE FUNKY MAGIC - TO SEE IF THIS FILE REALLY IS LOCKED!!!
        if (IsFileLocked(ex))
        {
            // do something? 
        }
    }
    catch (Exception ex)
    {
    }
    finally
    { }     
    return fileContents;
}

public static string ReadFileTextNoEncoding(string filePath)
{
    string fileContents = string.Empty;
    byte[] buffer;
    try
    {
        using (FileStream fileStream = File.Open(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
        {
            int length = (int)fileStream.Length;  // get file length
            buffer = new byte[length];            // create buffer
            int count;                            // actual number of bytes read
            int sum = 0;                          // total number of bytes read

            // read until Read method returns 0 (end of the stream has been reached)
            while ((count = fileStream.Read(buffer, sum, length - sum)) > 0) 
            {
                sum += count;  // sum is a buffer offset for next reading
            }

            fileStream.Close(); //Again - this is not needed, just me being paranoid and explicitly releasing resources ASAP

            char[] chars = new char[buffer.Length / sizeof(char) + 1];
            System.Buffer.BlockCopy(buffer, 0, chars, 0, buffer.Length);
            fileContents = new string(chars);
        }
    }
    catch (IOException ex)
    {
        //THE FUNKY MAGIC - TO SEE IF THIS FILE REALLY IS LOCKED!!!
        if (IsFileLocked(ex))
        {
            // do something? 
        }
    }
    catch (Exception ex)
    {
    }
    finally
    {
    }

    return fileContents;
}

亲自尝试一下:

byte[] output1 = Helper.ReadFileBytes(@"c:\temp\test.txt");
string output2 = Helper.ReadFileTextWithEncoding(@"c:\temp\test.txt");
string output3 = Helper.ReadFileTextNoEncoding(@"c:\temp\test.txt");
82
Jeremy Thompson

也许您可以使用 FileSystemWatcher 并监视Changed事件。

我自己没有用过,但它可能值得一试。如果filesystemwatcher在这种情况下有点重,我会选择try/catch/sleep循环。

6
Karl Johan

只需按预期使用例外。接受文件正在使用中并重复尝试,直到您的操作完成。这也是最有效的,因为在行动之前不会浪费任何检查状态的周期。

例如,使用下面的功能

TimeoutFileAction(() => { System.IO.File.etc...; return null; } );

可重复使用的方法,在2秒后超时

private T TimeoutFileAction<T>(Func<T> func)
{
    var started = DateTime.UtcNow;
    while ((DateTime.UtcNow - started).TotalMilliseconds < 2000)
    {
        try
        {
            return func();                    
        }
        catch (System.IO.IOException exception)
        {
            //ignore, or log somewhere if you want to
        }
    }
    return default(T);
}
5
kernowcode

您可以返回一个任务,该任务在可用时立即为您提供流。这是一个简化的解决方案,但它是一个很好的起点。这是线程安全的。

private async Task<Stream> GetStreamAsync()
{
    try
    {
        return new FileStream("sample.mp3", FileMode.Open, FileAccess.Write);
    }
    catch (IOException)
    {
        await Task.Delay(TimeSpan.FromSeconds(1));
        return await GetStreamAsync();
    }
}

您可以像往常一样使用此流:

using (var stream = await FileStreamGetter.GetStreamAsync())
{
    Console.WriteLine(stream.Length);
}
4
Ivan Branets
static bool FileInUse(string path)
    {
        try
        {
            using (FileStream fs = new FileStream(path, FileMode.OpenOrCreate))
            {
                fs.CanWrite
            }
            return false;
        }
        catch (IOException ex)
        {
            return true;
        }
    }

string filePath = "C:\\Documents And Settings\\yourfilename";
bool isFileInUse;

isFileInUse = FileInUse(filePath);

// Then you can do some checking
if (isFileInUse)
   Console.WriteLine("File is in use");
else
   Console.WriteLine("File is not in use");

希望这可以帮助!

4
Julian

我所知道的唯一方法是使用Win32独占锁API,它不是太快,但存在示例。

对于一个简单的解决方案,大多数人只是尝试/捕获/睡眠循环。

4
Luke Schafer

上面接受的答案遇到一个问题,即如果文件已经打开以使用FileShare.Read模式进行写入,或者如果文件具有只读属性,则代码将不起作用。这个修改过的解决方案工作最可靠,需要牢记两件事(对于已接受的解决方案也是如此):

  1. 它不适用于使用写共享模式打开的文件
  2. 这不会考虑线程问题,因此您需要将其锁定或单独处理线程问题。

记住以上内容,这将检查文件是否被 锁定以进行写入 锁定以防止读取

public static bool FileLocked(string FileName)
{
    FileStream fs = null;

    try
    {
        // NOTE: This doesn't handle situations where file is opened for writing by another process but put into write shared mode, it will not throw an exception and won't show it as write locked
        fs = File.Open(FileName, FileMode.Open, FileAccess.ReadWrite, FileShare.None); // If we can't open file for reading and writing then it's locked by another process for writing
    }
    catch (UnauthorizedAccessException) // https://msdn.Microsoft.com/en-us/library/y973b725(v=vs.110).aspx
    {
        // This is because the file is Read-Only and we tried to open in ReadWrite mode, now try to open in Read only mode
        try
        {
            fs = File.Open(FileName, FileMode.Open, FileAccess.Read, FileShare.None);
        }
        catch (Exception)
        {
            return true; // This file has been locked, we can't even open it to read
        }
    }
    catch (Exception)
    {
        return true; // This file has been locked
    }
    finally
    {
        if (fs != null)
            fs.Close();
    }
    return false;
}
3
rboy

您可以使用我的库访问多个应用程序中的文件。

您可以从nuget安装它:Install-Package Xabe.FileLock

如果您想了解更多相关信息,请查看 https://github.com/tomaszzmuda/Xabe.FileLock

ILock fileLock = new FileLock(file);
if(fileLock.Acquire(TimeSpan.FromSeconds(15), true))
{
    using(fileLock)
    {
        // file operations here
    }
}

fileLock.Acquire方法仅在可以锁定此对象的独占文件时才返回true。但是上传文件的app也必须在文件锁中做。如果对象不可访问,则metod返回false。

2
Tomasz Żmuda

除了工作3行并仅供参考:如果你想要 full blown information - 在Microsoft开发中心有一个小项目:

https://code.msdn.Microsoft.com/windowsapps/How-to-know-the-process-704839f4

来自简介:

在.NET Framework 4.0中开发的C#示例代码有助于找出锁定文件的进程。 RmStartSession function,它包含在rstrtmgr.dll中,用于创建重启管理器会话,并根据返回结果创建一个新的Win32Exception对象实例。通过 RmRegisterRescources function, RmGetList 函数将资源注册到Restart Manager会话之后通过枚举 RM_PROCESS_INFO 来调用以检查应用程序使用特定文件的内容阵列。

它通过连接到“重新启动管理器会话”来工作。

Restart Manager使用向会话注册的资源列表来确定必须关闭和重新启动哪些应用程序和服务。 资源可以通过文件名,服务短名称或RM_UNIQUE_PROCESS结构来识别 描述正在运行的应用程序。

对于你的特殊需求,它可能有点过度设计但是如果那是想要的话,继续前进并抓住vs项目。

2
Bernhard

以下是一些代码,据我所知,它与接受的答案相同,但代码较少:

    public static bool IsFileLocked(string file)
    {
        try
        {
            using (var stream = File.OpenRead(file))
                return false;
        }
        catch (IOException)
        {
            return true;
        }        
    }

但是我认为以下列方式执行它会更加健壮:

    public static void TryToDoWithFileStream(string file, Action<FileStream> action, 
        int count, int msecTimeOut)
    {
        FileStream stream = null;
        for (var i = 0; i < count; ++i)
        {
            try
            {
                stream = File.OpenRead(file);
                break;
            }
            catch (IOException)
            {
                Thread.Sleep(msecTimeOut);
            }
        }
        action(stream);
    }
2
cdiggins

根据我的经验,您通常希望这样做,然后“保护”您的文件以做一些奇特的事情然后使用“受保护”文件。如果您只想使用这样一个文件,则可以使用Jeremy Thompson在答案中解释的技巧。但是,如果您尝试在许多文件上执行此操作(例如,当您编写安装程序时),那么您会受到相当大的伤害。

这可以解决的一个非常优雅的方法是使用这样一个事实:如果使用其中一个文件,您的文件系统将不允许您更改文件夹名称。将文件夹保存在同一个文件系统中,它就像魅力一样。

请注意,您应该了解可以利用的明显方法。毕竟,文件不会被锁定。另外,请注意,还有其他原因可能导致Move操作失败。显然,正确的错误处理(MSDN)可以在这里提供帮助。

var originalFolder = @"c:\myHugeCollectionOfFiles"; // your folder name here
var someFolder = Path.Combine(originalFolder, "..", Guid.NewGuid().ToString("N"));

try
{
    Directory.Move(originalFolder, someFolder);

    // Use files
}
catch // TODO: proper exception handling
{
    // Inform user, take action
}
finally
{
    Directory.Move(someFolder, originalFolder);
}

对于单个文件,我会坚持使用Jeremy Thompson发布的锁定建议。

1
atlaste

我很想知道这是否会触发任何WTF反应。我有一个过程,它创建并随后从控制台应用程序启动PDF文档。但是,我正在处理一个脆弱的问题,如果用户多次运行该进程,生成相同的文件而不先关闭先前生成的文件,应用程序将抛出异​​常并死亡。这种情况经常发生,因为文件名基于销售报价编号。

我决定依靠自动递增的文件版本控制,而不是以这种不合理的方式失败:

private static string WriteFileToDisk(byte[] data, string fileName, int version = 0)
{
    try
    {
        var versionExtension = version > 0 ? $"_{version:000}" : string.Empty;
        var filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, $"{fileName}{versionExtension}.pdf");
        using (var writer = new FileStream(filePath, FileMode.Create))
        {
            writer.Write(data, 0, data.Length);
        }
        return filePath;
    }
    catch (IOException)
    {
        return WriteFileToDisk(data, fileName, ++version);
    }
}

可能会对catch块给予更多的关注,以确保我捕获正确的IOException。我可能还会在启动时清除应用程序存储,因为这些文件无论如何都是临时的。

我意识到这超出了OP的问题范围,只是检查文件是否正在使用,但这确实是我到达这里时想要解决的问题,所以它可能会对其他人有用。

0
Vinney Kelly

这样的事情有帮助吗?

var fileWasWrittenSuccessfully = false;
while (fileWasWrittenSuccessfully == false)
{
    try
    {
        lock (new Object())
        {
            using (StreamWriter streamWriter = new StreamWriter(filepath.txt"), true))
            {
                streamWriter.WriteLine("text");
            }
        }

        fileWasWrittenSuccessfully = true;
    }
    catch (Exception)
    {

    }
}
0
Tadej