Apakah ada cara untuk memeriksa apakah suatu file sedang digunakan?

Saya sedang menulis sebuah program dalam C # yang perlu berulang kali mengakses 1 file gambar. Sebagian besar waktu berfungsi, tetapi jika komputer saya berjalan cepat, ia akan mencoba mengakses file sebelum disimpan kembali ke sistem file dan membuat kesalahan: "File digunakan oleh proses lain" .

Saya ingin mencari jalan keluar, tetapi semua Googling saya hanya menghasilkan membuat cek dengan menggunakan penanganan pengecualian. Ini bertentangan dengan agama saya, jadi saya bertanya-tanya apakah ada cara yang lebih baik untuk melakukannya?

CATATAN yang diperbarui pada solusi ini : Memeriksa FileAccess.ReadWriteakan gagal untuk file Read-Only sehingga solusi telah dimodifikasi untuk memeriksa FileAccess.Read. Meskipun solusi ini berfungsi karena mencoba memeriksa FileAccess.Readakan gagal jika file memiliki kunci Tulis atau Baca di atasnya, namun, solusi ini tidak akan berfungsi jika file tidak memiliki kunci Tulis atau Baca di dalamnya, yaitu telah dibuka (untuk membaca atau menulis) dengan akses FileShare.Read atau FileShare.Write.

ASLI: Saya telah menggunakan kode ini selama beberapa tahun terakhir, dan saya belum punya masalah dengannya.

Pahami keraguan Anda tentang penggunaan pengecualian, tetapi Anda tidak bisa menghindarinya sepanjang waktu:

protected virtual bool IsFileLocked(FileInfo file)
{
    try
    {
        using(FileStream stream = file.Open(FileMode.Open, FileAccess.Read, FileShare.None))
        {
            stream.Close();
        }
    }
    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;
    }

    //file is not locked
    return false;
}

Anda dapat menderita dari kondisi ras thread di mana ada contoh-contoh yang terdokumentasi dari ini digunakan sebagai kerentanan keamanan. Jika Anda memeriksa apakah file tersebut tersedia, tetapi kemudian coba dan gunakan, Anda bisa melempar pada titik itu, yang bisa digunakan oleh pengguna jahat untuk memaksa dan mengeksploitasi kode Anda.

Taruhan terbaik Anda adalah try catch / akhirnya yang mencoba untuk mendapatkan file menangani.

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.
}

Gunakan ini untuk memeriksa apakah file terkunci:

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;
}
}

Untuk alasan kinerja, saya sarankan Anda membaca konten file dalam operasi yang sama. Berikut ini beberapa contohnya:

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;
}

Cobalah sendiri:

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

Cukup gunakan pengecualian sebagaimana dimaksud. Terima bahwa file sedang digunakan dan coba lagi, berulang kali hingga tindakan Anda selesai. Ini juga yang paling efisien karena Anda tidak membuang siklus memeriksa keadaan sebelum bertindak.

Gunakan fungsi di bawah ini, misalnya

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

Metode yang dapat digunakan kembali yang habis setelah 2 detik

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);
}

Mungkin Anda bisa menggunakan FileSystemWatcher dan menonton acara yang Diubah.

Saya belum pernah menggunakan ini sendiri, tetapi mungkin layak dicoba. Jika filesystemwatcher ternyata agak berat untuk kasus ini, saya akan mencoba loop coba / tangkap / tidur.

Anda dapat mengembalikan tugas yang memberi Anda streaming segera setelah tersedia. Ini solusi yang disederhanakan, tetapi ini adalah titik awal yang baik. Itu aman dari utas.

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();
    }
}

Anda dapat menggunakan aliran ini seperti biasa:

using (var stream = await FileStreamGetter.GetStreamAsync())
{
    Console.WriteLine(stream.Length);
}

satu-satunya cara saya tahu adalah dengan menggunakan API kunci Win32 eksklusif yang tidak terlalu cepat, tetapi ada contoh.

Kebanyakan orang, untuk solusi sederhana untuk ini, cukup mencoba / menangkap / tidur loop.

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");

Semoga ini membantu!

Jawaban yang diterima di atas mengalami masalah di mana jika file telah dibuka untuk menulis dengan mode FileShare.Read atau jika file memiliki atribut Read-Only kode tidak akan berfungsi. Solusi yang dimodifikasi ini berfungsi paling andal, dengan dua hal yang perlu diingat (seperti juga untuk solusi yang diterima):

1. Ini tidak akan berfungsi untuk file yang telah dibuka dengan mode berbagi tulis
2. Ini tidak mempertimbangkan masalah threading akun sehingga Anda perlu menguncinya atau menangani masalah threading secara terpisah.

Ingatlah hal di atas, ini memeriksa apakah file dikunci untuk ditulis atau dikunci untuk mencegah pembacaan :

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;
}

Selain bekerja 3-liner dan hanya untuk referensi: Jika Anda ingin full blown - ada sedikit proyek di Microsoft Dev Center:

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

Dari Pendahuluan:

Kode sampel C # yang dikembangkan dalam .NET Framework 4.0 akan membantu dalam mencari tahu proses mana yang memiliki kunci pada file. Fungsi RmStartSession yang termasuk dalam rstrtmgr.dll telah digunakan untuk membuat sesi manajer restart dan sesuai dengan hasil kembali instance baru objek Win32Exception dibuat. Setelah mendaftarkan sumber daya ke sesi Restart Manager melalui fungsi RmRegisterRescources , fungsi RmGetList dipanggil untuk memeriksa aplikasi apa yang menggunakan file tertentu dengan menyebutkan array RM_PROCESS_INFO .

Ini bekerja dengan menghubungkan ke "Restart Manager Session".

Restart Manager menggunakan daftar sumber daya yang terdaftar dalam sesi untuk menentukan aplikasi dan layanan mana yang harus dimatikan dan dimulai kembali. Sumber daya dapat diidentifikasi dengan nama file, nama pendek layanan, atau struktur RM_UNIQUE_PROCESS yang menjelaskan aplikasi yang sedang berjalan.

Mungkin sedikit overengineered untuk kebutuhan khusus Anda ... Tetapi jika itu yang Anda inginkan, silakan dan ambil vs-proyek.

Dalam pengalaman saya, Anda biasanya ingin melakukan ini, kemudian 'melindungi' file Anda untuk melakukan sesuatu yang mewah dan kemudian menggunakan file 'dilindungi'. Jika Anda hanya memiliki satu file yang ingin Anda gunakan seperti ini, Anda dapat menggunakan trik yang dijelaskan dalam jawaban oleh Jeremy Thompson. Namun, jika Anda mencoba melakukan ini pada banyak file (katakanlah, misalnya ketika Anda sedang menulis installer), Anda akan terluka.

Cara yang sangat elegan ini dapat dipecahkan adalah dengan menggunakan fakta bahwa sistem file Anda tidak akan memungkinkan Anda untuk mengubah nama folder jika salah satu file di sana sedang digunakan. Simpan folder dalam sistem file yang sama dan itu akan berfungsi seperti pesona.

Harap dicatat bahwa Anda harus mengetahui cara-cara yang jelas ini dapat dieksploitasi. Lagi pula, file tidak akan dikunci. Perlu diketahui juga bahwa ada alasan lain yang dapat menyebabkan Moveoperasi Anda gagal. Jelas penanganan kesalahan yang tepat (MSDN) dapat membantu di sini.

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);
}

Untuk file individual saya akan tetap dengan saran penguncian diposting oleh Jeremy Thompson.

Berikut adalah beberapa kode yang sejauh yang saya tahu terbaik dapat melakukan hal yang sama dengan jawaban yang diterima tetapi dengan kode lebih sedikit:

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

Namun saya pikir lebih kuat untuk melakukannya dengan cara berikut:

    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);
    }

Anda dapat menggunakan perpustakaan saya untuk mengakses file dari berbagai aplikasi.

Anda dapat menginstalnya dari nuget: Install-Package Xabe.FileLock

Jika Anda ingin informasi lebih lanjut tentang hal ini, periksa https://github.com/tomaszzmuda/Xabe.FileLock

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

Metode fileLock.Acquire akan mengembalikan true hanya jika dapat mengunci file eksklusif untuk objek ini. Tetapi aplikasi yang mengunggah file juga harus melakukannya dalam kunci file. Jika objek tidak dapat diakses, metod mengembalikan false.

Saya pernah perlu mengunggah PDF ke arsip cadangan online. Tetapi cadangan akan gagal jika pengguna membuka file di program lain (seperti pembaca PDF). Dengan tergesa-gesa, saya mencoba beberapa jawaban teratas di utas ini tetapi tidak dapat membuatnya bekerja. Apa yang berhasil bagi saya adalah mencoba untuk memindahkan file PDF ke direktori sendiri . Saya menemukan bahwa ini akan gagal jika file dibuka di program lain, dan jika langkah itu berhasil tidak akan ada operasi pemulihan yang diperlukan karena akan ada jika dipindahkan ke direktori yang terpisah. Saya ingin memposting solusi dasar saya jika berguna untuk kasus penggunaan khusus orang lain.

string str_path_and_name = str_path + '\\' + str_filename;
FileInfo fInfo = new FileInfo(str_path_and_name);
bool open_elsewhere = false;
try
{
    fInfo.MoveTo(str_path_and_name);
}
catch (Exception ex)
{
    open_elsewhere = true;
}

if (open_elsewhere)
{
    //handle case
}

Saya tertarik untuk melihat apakah ini memicu refleks WTF. Saya memiliki proses yang membuat dan kemudian meluncurkan dokumen PDF dari aplikasi konsol. Namun, saya berurusan dengan kelemahan di mana jika pengguna menjalankan proses beberapa kali, menghasilkan file yang sama tanpa terlebih dahulu menutup file yang dihasilkan sebelumnya, aplikasi akan melempar pengecualian dan mati. Ini adalah kejadian yang agak sering karena nama file didasarkan pada nomor kutipan penjualan.

Alih-alih gagal dengan cara yang tidak berterima, saya memutuskan untuk mengandalkan versi file yang ditambahkan secara otomatis:

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);
    }
}

Mungkin lebih banyak perhatian dapat diberikan pada catchblok untuk memastikan saya menangkap IOException yang benar. Saya mungkin juga akan menghapus penyimpanan aplikasi saat startup karena file-file ini dimaksudkan untuk sementara waktu.

Saya menyadari ini melampaui lingkup pertanyaan OP yaitu hanya memeriksa apakah file tersebut digunakan tetapi ini memang masalah yang saya cari untuk diselesaikan ketika saya tiba di sini jadi mungkin itu akan berguna untuk orang lain.

Apakah sesuatu seperti ini membantu?

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)
    {

    }
}

Coba dan pindahkan / salin file ke direktori temp. Jika Anda bisa, itu tidak memiliki kunci dan Anda dapat bekerja dengan aman di direktori temp tanpa mendapatkan kunci. Jika tidak, cobalah untuk memindahkannya lagi dalam x detik.

Saya menggunakan solusi ini, tetapi saya memiliki rentang waktu antara ketika saya memeriksa penguncian file dengan fungsi IsFileLocked dan ketika saya membuka file. Dalam rentang waktu ini beberapa utas lainnya dapat membuka file, jadi saya akan mendapatkan IOException.

Jadi, saya menambahkan kode tambahan untuk ini. Dalam kasus saya, saya ingin memuat XDocument:

        XDocument xDoc = null;

        while (xDoc == null)
        {
            while (IsFileBeingUsed(_interactionXMLPath))
            {
                Logger.WriteMessage(Logger.LogPrioritet.Warning, "Deserialize can not open XML file. is being used by another process. wait...");
                Thread.Sleep(100);
            }
            try
            {
                xDoc = XDocument.Load(_interactionXMLPath);
            }
            catch
            {
                Logger.WriteMessage(Logger.LogPrioritet.Error, "Load working!!!!!");
            }
        }

Bagaimana menurut anda? Bisakah saya mengubah sesuatu? Mungkin saya tidak harus menggunakan fungsi IsFileBeingUsed sama sekali?

Terima kasih