C#使用讀寫鎖三行代碼簡單解決多線程併發寫入文件時線程同步的問題

時間  2019-11-11
標籤 c# 使用 讀寫 三行 代碼 簡單 解決 多線程 併發 寫入 文件 線程 同步 問題 欄目 C# 简体版
原文   原文鏈接

原文出處：http://www.cnblogs.com/Tench/p/6159763.htmlhtml

（補充：初始化FileStream時使用包含文件共享屬性(System.IO.FileShare)的構造函數比使用自定義線程鎖更爲安全和高效，更多內容可點擊參閱）數據庫

 

在開發程序的過程當中，不免少不了寫入錯誤日誌這個關鍵功能。實現這個功能，能夠選擇使用第三方日誌插件，也能夠選擇使用數據庫，還能夠本身寫個簡單的方法把錯誤信息記錄到日誌文件。安全

選擇最後一種方法實現的時候，若對文件操做與線程同步不熟悉，問題就有可能出現了，由於同一個文件並不容許多個線程同時寫入，不然會提示「文件正在由另外一進程使用，所以該進程沒法訪問此文件」。多線程

 

這是文件的併發寫入問題，就須要用到線程同步。而微軟也給線程同步提供了一些相關的類能夠達到這樣的目的，本文使用到的 System.Threading.ReaderWriterLockSlim 即是其中之一。併發

該類用於管理資源訪問的鎖定狀態，可實現多線程讀取或進行獨佔式寫入訪問。利用這個類，咱們就能夠避免在同一時間段內多線程同時寫入一個文件而致使的併發寫入問題。函數

 

讀寫鎖是以 ReaderWriterLockSlim 對象做爲鎖管理資源的，不一樣的 ReaderWriterLockSlim 對象中鎖定同一個文件也會被視爲不一樣的鎖進行管理，這種差別可能會再次致使文件的併發寫入問題，因此 ReaderWriterLockSlim 應儘可能定義爲只讀的靜態對象。性能

 

ReaderWriterLockSlim 有幾個關鍵的方法，本文僅討論寫入鎖：測試

調用 EnterWriteLock 方法 進入寫入狀態，在調用線程進入鎖定狀態以前一直處於阻塞狀態，所以可能永遠都不返回。
調用 TryEnterWriteLock 方法 進入寫入狀態，可指定阻塞的間隔時間，若是調用線程在此間隔期間並未進入寫入模式，將返回false。
調用 ExitWriteLock 方法 退出寫入狀態，應使用 finally 塊執行 ExitWriteLock 方法，從而確保調用方退出寫入模式。spa

 

Don't talk, show me the code.

 

1.多線程同時寫入文件插件

複製代碼 
      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());
                 File.AppendAllText(logFilePath, logContent);
                 WritedCount++;
             }
             catch (Exception ex)
             {
                 FailedCount++;
                 Console.WriteLine(ex.Message);
             }
         }
     }
複製代碼

運行結果：


不使用讀寫鎖，只有部分日誌成功寫入了日誌文件。

 

2.多線程使用讀寫鎖同步寫入文件

複製代碼 
      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 ReaderWriterLockSlim LogWriteLock = new ReaderWriterLockSlim();
         static void WriteLog()
         {
             try
             {
                 //設置讀寫鎖爲寫入模式獨佔資源，其餘寫入請求須要等待本次寫入結束以後才能繼續寫入
                 //注意：長時間持有讀線程鎖或寫線程鎖會使其餘線程發生飢餓 (starve)。 爲了獲得最好的性能，須要考慮從新構造應用程序以將寫訪問的持續時間減小到最小。
                 //      從性能方面考慮，請求進入寫入模式應該緊跟文件操做以前，在此處進入寫入模式僅是爲了下降代碼複雜度
                 //      因進入與退出寫入模式應在同一個try finally語句塊內，因此在請求進入寫入模式以前不能觸發異常，不然釋放次數大於請求次數將會觸發異常
                 LogWriteLock.EnterWriteLock();
 
                 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());
 
                 File.AppendAllText(logFilePath, logContent);
                 WritedCount++;
             }
             catch (Exception)
             {
                 FailedCount++;
             }
             finally
             {
                 //退出寫入模式，釋放資源佔用
                 //注意：一次請求對應一次釋放
                 //      若釋放次數大於請求次數將會觸發異常[寫入鎖定未經保持即被釋放]
                 //      若請求處理完成後未釋放將會觸發異常[此模式不下容許以遞歸方式獲取寫入鎖定]
                 LogWriteLock.ExitWriteLock();
             }
         }
     }
複製代碼

 

運行結果：


使用讀寫鎖，所有日誌成功寫入了日誌文件。

 

3.測試複雜多線程環境下使用讀寫鎖同步寫入文件

複製代碼 
     class Program
     {
         static int LogCount = 1000;
         static int SumLogCount = 0;
         static int WritedCount = 0;
         static int FailedCount = 0;
 
         static void Main(string[] args)
         {
             //往線程池裏添加一個任務，迭代寫入N個日誌
             SumLogCount += LogCount;
             ThreadPool.QueueUserWorkItem((obj) =>
             {
                 Parallel.For(0, LogCount, e =>
                 {
                     WriteLog();
                 });
             });
 
             //在新的線程裏，添加N個寫入日誌的任務到線程池
             SumLogCount += LogCount;
             var thread1 = new Thread(() =>
             {
                 Parallel.For(0, LogCount, e =>
                 {
                     ThreadPool.QueueUserWorkItem((subObj) =>
                     {
                         WriteLog();
                     });
                 });
             });
             thread1.IsBackground = false;
             thread1.Start();
 
             //添加N個寫入日誌的任務到線程池
             SumLogCount += LogCount;
             Parallel.For(0, LogCount, e =>
             {
                 ThreadPool.QueueUserWorkItem((obj) =>
                 {
                     WriteLog();
                 });
             });
 
             //在新的線程裏，迭代寫入N個日誌
             SumLogCount += LogCount;
             var thread2 = new Thread(() =>
             {
                 Parallel.For(0, LogCount, e =>
                 {
                     WriteLog();
                 });
             });
             thread2.IsBackground = false;
             thread2.Start();
 
             //在當前線程裏，迭代寫入N個日誌
             SumLogCount += LogCount;
             Parallel.For(0, LogCount, e =>
             {
                 WriteLog();
             });
 
             Console.WriteLine("Main Thread Processed.\r\n");
             while (true)
             {
                 Console.WriteLine(string.Format("Sum Log Count:{0}.\t\tWrited Count:{1}.\tFailed Count:{2}.", SumLogCount.ToString(), WritedCount.ToString(), FailedCount.ToString()));
                 Console.ReadLine();
             }
         }
 
         //讀寫鎖，當資源處於寫入模式時，其餘線程寫入須要等待本次寫入結束以後才能繼續寫入
         static ReaderWriterLockSlim LogWriteLock = new ReaderWriterLockSlim();
         static void WriteLog()
         {
             try
             {
                 //設置讀寫鎖爲寫入模式獨佔資源，其餘寫入請求須要等待本次寫入結束以後才能繼續寫入
                 //注意：長時間持有讀線程鎖或寫線程鎖會使其餘線程發生飢餓 (starve)。 爲了獲得最好的性能，須要考慮從新構造應用程序以將寫訪問的持續時間減小到最小。
                 //      從性能方面考慮，請求進入寫入模式應該緊跟文件操做以前，在此處進入寫入模式僅是爲了下降代碼複雜度
                 //      因進入與退出寫入模式應在同一個try finally語句塊內，因此在請求進入寫入模式以前不能觸發異常，不然釋放次數大於請求次數將會觸發異常
                 LogWriteLock.EnterWriteLock();
 
                 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());
 
                 File.AppendAllText(logFilePath, logContent);
                 WritedCount++;
             }
             catch (Exception)
             {
                 FailedCount++;
             }
             finally
             {
                 //退出寫入模式，釋放資源佔用
                 //注意：一次請求對應一次釋放
                 //      若釋放次數大於請求次數將會觸發異常[寫入鎖定未經保持即被釋放]
                 //      若請求處理完成後未釋放將會觸發異常[此模式不下容許以遞歸方式獲取寫入鎖定]
                 LogWriteLock.ExitWriteLock();
             }
         }
     }
複製代碼

運行結果：

部分日誌文件內容：

複製代碼 
 ...
 Tid: 36  2016年12月11日 15:29:22.825
 Tid: 29  2016年12月11日 15:29:22.830
 Tid: 6   2016年12月11日 15:29:22.838
 Tid: 26  2016年12月11日 15:29:22.845
 Tid: 34  2016年12月11日 15:29:22.854
 Tid: 24  2016年12月11日 15:29:22.863
 Tid: 27  2016年12月11日 15:29:22.872
 Tid: 14  2016年12月11日 15:29:22.877
 Tid: 23  2016年12月11日 15:29:22.886
 Tid: 20  2016年12月11日 15:29:22.892
 Tid: 30  2016年12月11日 15:29:22.898
 Tid: 9   2016年12月11日 15:29:22.904
 Tid: 21  2016年12月11日 15:29:22.909
 Tid: 22  2016年12月11日 15:29:22.915
 Tid: 7   2016年12月11日 15:29:22.920
 Tid: 3   2016年12月11日 15:29:22.925
 Tid: 12  2016年12月11日 15:29:22.931
 Tid: 5   2016年12月11日 15:29:22.937
 Tid: 13  2016年12月11日 15:29:22.942
 Tid: 11  2016年12月11日 15:29:22.947
 Tid: 19  2016年12月11日 15:29:22.953
 Tid: 37  2016年12月11日 15:29:22.958
 Tid: 37  2016年12月11日 15:29:22.964
 Tid: 40  2016年12月11日 15:29:22.970
 Tid: 40  2016年12月11日 15:29:22.975
 Tid: 40  2016年12月11日 15:29:22.980
 Tid: 40  2016年12月11日 15:29:22.985
 Tid: 40  2016年12月11日 15:29:22.991
 Tid: 40  2016年12月11日 15:29:22.997
 Tid: 31  2016年12月11日 15:29:23.3
 Tid: 31  2016年12月11日 15:29:23.9
 Tid: 31  2016年12月11日 15:29:23.14
 Tid: 31  2016年12月11日 15:29:23.20
 Tid: 31  2016年12月11日 15:29:23.27
 Tid: 31  2016年12月11日 15:29:23.33
 Tid: 31  2016年12月11日 15:29:23.38
 Tid: 31  2016年12月11日 15:29:23.44
 Tid: 31  2016年12月11日 15:29:23.49
 Tid: 31  2016年12月11日 15:29:23.57
 Tid: 31  2016年12月11日 15:29:23.63
 Tid: 31  2016年12月11日 15:29:23.68
 Tid: 31  2016年12月11日 15:29:23.74
 Tid: 16  2016年12月11日 15:29:23.80
 Tid: 16  2016年12月11日 15:29:23.86
 Tid: 16  2016年12月11日 15:29:23.93
 Tid: 16  2016年12月11日 15:29:23.99
 Tid: 16  2016年12月11日 15:29:23.105
 Tid: 16  2016年12月11日 15:29:23.110
 Tid: 16  2016年12月11日 15:29:23.116
 Tid: 38  2016年12月11日 15:29:23.122
 Tid: 38  2016年12月11日 15:29:23.128
 Tid: 28  2016年12月11日 15:29:23.134
 Tid: 19  2016年12月11日 15:29:23.139
 Tid: 25  2016年12月11日 15:29:23.146
 Tid: 37  2016年12月11日 15:29:23.152
 Tid: 39  2016年12月11日 15:29:23.158
 Tid: 32  2016年12月11日 15:29:23.164
 Tid: 33  2016年12月11日 15:29:23.170
 Tid: 31  2016年12月11日 15:29:23.176
 Tid: 35  2016年12月11日 15:29:23.182
 Tid: 40  2016年12月11日 15:29:23.189
 Tid: 15  2016年12月11日 15:29:23.194
 Tid: 18  2016年12月11日 15:29:23.202
 Tid: 17  2016年12月11日 15:29:23.208
 Tid: 10  2016年12月11日 15:29:23.215
 Tid: 16  2016年12月11日 15:29:23.221
複製代碼

複雜多線程環境下使用讀寫鎖，所有日誌成功寫入了日誌文件，由ThreadId和DateTime能夠看出是由不一樣的線程同步寫入。

 

4.補充：初始化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);
             }
         }
     }
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程