C#多线程读写同一文件处理

在多线程访问读写同一个文件时，经常遇到异常：“文件正在由另一进程使用，因此该进程无法访问此文件”。

多线程访问统一资源的异常，

解决方案1，保证读写操作单线程执行，可以使用lock

解决方案2，使用System.Threading.ReaderWriterLockSlim ，对读写操作锁定处理

读写锁是以 ReaderWriterLockSlim 对象作为锁管理资源的，不同的 ReaderWriterLockSlim 对象中锁定同一个文件也会被视为不同的锁进行管理，这种差异可能会再次导致文件的并发写入问题，所以 ReaderWriterLockSlim 应尽量定义为只读的静态对象。

ReaderWriterLockSlim 有几个关键的方法，本文仅讨论写入锁：

调用 EnterWriteLock 方法 进入写入状态，在调用线程进入锁定状态之前一直处于阻塞状态，因此可能永远都不返回。
调用 TryEnterWriteLock 方法 进入写入状态，可指定阻塞的间隔时间，如果调用线程在此间隔期间并未进入写入模式，将返回false。
调用 ExitWriteLock 方法 退出写入状态，应使用 finally 块执行 ExitWriteLock 方法，从而确保调用方退出写入模式。

一、不是用锁处理，多线程访问文件不定时抛出异常

static void Main(string[] args)
{
    //迭代运行写入日志记录，由于多个线程同时写入同一个文件将会导致错误
    Parallel.For(0, LogCount, e =>
    {
        WriteLog();
    });
    Console.Read();
}
static int LogCount = 100;
static int FailedCount = 0;
static int WriteCount = 0;
static void WriteLog()
{
    try
    {
        WriteCount++;

        LogHelper.LogHelper _log = new LogHelper.LogHelper("g:\\temp2\\one.txt", true);
        DateTime now = DateTime.Now;
        var logContent = string.Format("Tid: {0}{1} {2}=>{3}\r\n", Thread.CurrentThread.ManagedThreadId.ToString().PadRight(4), now.ToLongDateString(), now.ToLongTimeString(), WriteCount);
        _log.WriteLine(logContent);
    }
    catch (Exception ex)
    {
        FailedCount++;
        Console.WriteLine("累计出错数：" + FailedCount);
        Console.WriteLine(ex.Message);
    }
}

二、使用读写锁 同步写入文件处理

 

//读写锁，当资源处于写入模式时，其他线程写入需要等待本次写入结束之后才能继续写入
static ReaderWriterLockSlim LogWriteLock = new ReaderWriterLockSlim();
static void WriteLog()
{
    try
    {
        //设置读写锁为写入模式独占资源，其他写入请求需要等待本次写入结束之后才能继续写入
        //注意：长时间持有读线程锁或写线程锁会使其他线程发生饥饿 (starve)。 为了得到最好的性能，需要考虑重新构造应用程序以将写访问的持续时间减少到最小。
        //从性能方面考虑，请求进入写入模式应该紧跟文件操作之前，在此处进入写入模式仅是为了降低代码复杂度
        //因进入与退出写入模式应在同一个try finally语句块内，所以在请求进入写入模式之前不能触发异常，否则释放次数大于请求次数将会触发异常
        LogWriteLock.EnterWriteLock();


        WriteCount++;
        LogHelper.LogHelper _log = new LogHelper.LogHelper("g:\\temp2\\one.txt", true);
        DateTime now = DateTime.Now;
        var logContent = string.Format("Tid: {0}{1} {2}=>{3}\r\n", Thread.CurrentThread.ManagedThreadId.ToString().PadRight(4), now.ToLongDateString(), now.ToLongTimeString(), WriteCount);
        _log.WriteLine(logContent);
    }
    catch (Exception ex)
    {
        FailedCount++;
        Console.WriteLine("累计出错数：" + FailedCount);
        Console.WriteLine(ex.Message);
    }
    finally
    {
        //退出写入模式，释放资源占用
        //注意：一次请求对应一次释放
        //若释放次数大于请求次数将会触发异常[写入锁定未经保持即被释放]
        //若请求处理完成后未释放将会触发异常[此模式不下允许以递归方式获取写入锁定]
        LogWriteLock.ExitWriteLock();
    }
}

三、补充：初始化FileStream时使用包含文件共享属性(System.IO.FileShare)的构造函数比使用自定义线程锁更为安全和高效

class Program
    {
        static int LogCount = 100;
        static int WritedCount = 0;
        static int FailedCount = 0;

        static void Main(string[] args)
        {
            //迭代运行写入日志记录
            Parallel.For(0, LogCount, e =>
            {
                WriteLog();
            });

            Console.WriteLine(string.Format("\r\nLog Count:{0}.\t\tWrited Count:{1}.\tFailed Count:{2}.", LogCount.ToString(), WritedCount.ToString(), FailedCount.ToString()));
            Console.Read();
        }

        static void WriteLog()
        {
            try
            {
                var logFilePath = "log.txt";
                var now = DateTime.Now;
                var logContent = string.Format("Tid: {0}{1} {2}.{3}\r\n", Thread.CurrentThread.ManagedThreadId.ToString().PadRight(4), now.ToLongDateString(), now.ToLongTimeString(), now.Millisecond.ToString());

                var logContentBytes = Encoding.Default.GetBytes(logContent);
                //由于设置了文件共享模式为允许随后写入，所以即使多个线程同时写入文件，也会等待之前的线程写入结束之后再执行，而不会出现错误
                using (FileStream logFile = new FileStream(logFilePath, FileMode.OpenOrCreate, FileAccess.Write, FileShare.Write))
                {
                    logFile.Seek(0, SeekOrigin.End);
                    logFile.Write(logContentBytes, 0, logContentBytes.Length);
                }

                WritedCount++;
            }
            catch (Exception ex)
            {
                FailedCount++;
                Console.WriteLine(ex.Message);
            }
        }
    }

eg:

public class AppLog
{
    static ReaderWriterLockSlim LogWriteLock = new ReaderWriterLockSlim();

    public static void WriteLog(string log)
    {
        try
        {
            //设置读写锁为写入模式独占资源，其他写入请求需要等待本次写入结束之后才能继续写入
            //注意：长时间持有读线程锁或写线程锁会使其他线程发生饥饿 (starve)。 为了得到最好的性能，需要考虑重新构造应用程序以将写访问的持续时间减少到最小。
            //从性能方面考虑，请求进入写入模式应该紧跟文件操作之前，在此处进入写入模式仅是为了降低代码复杂度
            //因进入与退出写入模式应在同一个try finally语句块内，所以在请求进入写入模式之前不能触发异常，否则释放次数大于请求次数将会触发异常
            LogWriteLock.EnterWriteLock();

            StackTrace trace = new StackTrace();
            StackFrame frame = trace.GetFrame(1);
            MethodBase method = frame.GetMethod();
            String className = method.ReflectedType.Name;
            String methodName = method.Name;

            string filepath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "log");
            filepath = filepath + "\\" + DateTime.Now.ToString("yyyyMMdd");
            string filename = Path.Combine(filepath, DateTime.Now.ToString("yyyyMMdd") + ".log");
            string strLog = DateTime.Now.ToString("yyyyMMdd HH:mm:ss:ffff") + " : " + log + " (ClassName:" + className + " MethodName:" + methodName + ")";

            if (!Directory.Exists(filepath))
            {
                Directory.CreateDirectory(filepath);
            }

            //由于设置了文件共享模式为允许随后写入，所以即使多个线程同时写入文件，也会等待之前的线程写入结束之后再执行，而不会出现错误
            using (FileStream fs = new FileStream(filename, FileMode.Append, FileAccess.Write, FileShare.Write))
            {
                using (StreamWriter mvarStreamLog = new StreamWriter(fs))
                {
                    mvarStreamLog.WriteLine(strLog);
                    mvarStreamLog.Flush();
                    mvarStreamLog.Close();

                    fs.Close();
                }
            }
        }
        catch (Exception ex)
        {
            throw new Exception(ex.ToString());
        }
        finally
        {
            //退出写入模式，释放资源占用
            //注意：一次请求对应一次释放
            //若释放次数大于请求次数将会触发异常[写入锁定未经保持即被释放]
            //若请求处理完成后未释放将会触发异常[此模式不下允许以递归方式获取写入锁定]
            LogWriteLock.ExitWriteLock();
        }
    }
}