C#使用讀寫鎖三句代碼簡單解決多線程並發寫入文件時提示“文件正在由另一進程使用，因此該進程無法訪問此文件”的問題
在開發程序的過程中，難免少不了寫入錯誤日志這個關鍵功能。實現這個功能，可以選擇使用第三方日志插件，也可以選擇使用數據庫，還可以自己寫個簡單的方法把錯誤信息記錄到日志文件。
選擇最后一種方法實現的時候，若對文件操作與線程同步不熟悉，問題就有可能出現了，因為同一個文件並不允許多個線程同時寫入，否則會提示“文件正在由另一進程使用，因此該進程無法訪問此文件”。
這是文件的並發寫入問題，就需要用到線程同步。而微軟也給進程同步提供了一些相關的類可以達到這樣的目的，本文使用到的 System.Threading.ReaderWriterLockSlim 便是其中之一。
該類用於管理資源訪問的鎖定狀態，可實現多線程讀取或進行獨占式寫入訪問。利用這個類，我們就可以避免在同一時間段多線程同時寫入一個文件而導致的並發寫入問題。
讀寫鎖是以 ReaderWriterLockSlim 對象作為管理資源的，不同的 ReaderWriterLockSlim 對象中鎖定同一個文件也會被視為不同的鎖進行管理，這種差異可能會再次導致文件的並發寫入問題，所以 ReaderWriterLockSlim 應盡量定義為只讀的靜態對象。
ReaderWriterLockSlim 有幾個關鍵的方法，本文僅討論寫入鎖：
調用 EnterWriteLock 方法 進入寫入狀態，在調用線程進入鎖定狀態之前一直處於阻塞狀態，因此可能永遠都不返回。
調用 TryEnterWriteLock 方法 進入寫入狀態，可指定阻塞的間隔時間，如果調用線程在此間隔期間並未進入寫入模式，將返回false。
調用 ExitWriteLock 方法 退出寫入狀態，應使用 finally 塊執行 ExitWriteLock 方法，從而確保調用方退出寫入模式。
Don't talk, show me the code.
1.多線程同時寫入文件
1 class Program 2 { 3 static void Main(string[] args) 4 { 5 int logCount = 100; 6 int writedCount = 0; 7 int failedCount = 0; 8 //迭代運行寫入日志記錄，由於多個線程同時寫入同一個文件將會導致錯誤 9 Parallel.For(0, logCount, e => 10 { 11 try 12 { 13 var logFilePath = "log.txt"; 14 var now = DateTime.Now; 15 var logContent = string.Format("Tid: {0}{1} {2}.{3}\r\n", Thread.CurrentThread.ManagedThreadId.ToString().PadRight(4), now.ToLongDateString(), now.ToLongTimeString(), now.Millisecond.ToString()); 16 File.AppendAllText(logFilePath, logContent); 17 writedCount++; 18 } 19 catch (Exception ex) 20 { 21 failedCount++; 22 Console.WriteLine(ex.Message); 23 } 24 }); 25 26 Console.WriteLine(string.Format("\r\nLog Count:{0}.\t\tWrited Count:{1}.\tFailed Count:{2}.", logCount.ToString(), writedCount.ToString(), failedCount.ToString())); 27 Console.Read(); 28 } 29 }
運行結果：
不使用讀寫鎖，只有部分日志成功寫入了日志文件。
2.多線程使用讀寫鎖同步寫入文件
1 class Program 2 { 3 //讀寫鎖，當資源處於寫入模式時，其他線程寫入需要等待本次寫入結束之后才能繼續寫入 4 static ReaderWriterLockSlim LogWriteLock = new ReaderWriterLockSlim(); 5 static void Main(string[] args) 6 { 7 int logCount = 100; 8 int writedCount = 0; 9 int failedCount = 0; 10 //迭代運行寫入日志記錄 11 Parallel.For(0, logCount, e => 12 { 13 try 14 { 15 //設置讀寫鎖為寫入模式獨占資源，其他寫入請求需要等待本次寫入結束之后才能繼續寫入 16 //注意：長時間持有讀線程鎖或寫線程鎖會使其他線程發生飢餓 (starve)。 為了得到最好的性能，需要考慮重新構造應用程序以將寫訪問的持續時間減少到最小。 17 // 從性能方面考慮，請求進入寫入模式應該緊跟文件操作之前，在此處進入寫入模式僅是為了降低代碼復雜度 18 // 因進入與退出寫入模式應在同一個try finally語句塊內，所以在請求進入寫入模式之前不能觸發異常，否則釋放次數大於請求次數將會觸發異常 19 LogWriteLock.EnterWriteLock(); 20 21 var logFilePath = "log.txt"; 22 var now = DateTime.Now; 23 var logContent = string.Format("Tid: {0}{1} {2}.{3}\r\n", Thread.CurrentThread.ManagedThreadId.ToString().PadRight(4), now.ToLongDateString(), now.ToLongTimeString(), now.Millisecond.ToString()); 24 25 File.AppendAllText(logFilePath, logContent); 26 writedCount++; 27 } 28 catch (Exception ex) 29 { 30 failedCount++; 31 Console.WriteLine(ex.Message); 32 } 33 finally 34 { 35 //退出寫入模式，釋放資源占用 36 //注意：一次請求對應一次釋放 37 // 若釋放次數大於請求次數將會觸發異常[寫入鎖定未經保持即被釋放] 38 // 若請求處理完成后未釋放將會觸發異常[此模式不下允許以遞歸方式獲取寫入鎖定] 39 LogWriteLock.ExitWriteLock(); 40 } 41 }); 42 43 Console.WriteLine(string.Format("\r\nLog Count:{0}.\t\tWrited Count:{1}.\tFailed Count:{2}.", logCount.ToString(), writedCount.ToString(), failedCount.ToString())); 44 Console.Read(); 45 } 46 }
運行結果：
使用讀寫鎖，全部日志成功寫入了日志文件。
3.復雜多線程環境下使用讀寫鎖同步寫入文件
1 class Program 2 { 3 //讀寫鎖，當資源處於寫入模式時，其他線程寫入需要等待本次寫入結束之后才能繼續寫入 4 static ReaderWriterLockSlim LogWriteLock = new ReaderWriterLockSlim(); 5 6 static int LogCount = 1000; 7 static int SumLogCount = 0; 8 static int WritedCount = 0; 9 static int FailedCount = 0; 10 11 static void Main(string[] args) 12 { 13 //往線程池里添加一個任務，迭代寫入N個日志 14 SumLogCount += LogCount; 15 ThreadPool.QueueUserWorkItem((obj) => 16 { 17 Parallel.For(0, LogCount, e => 18 { 19 WriteLog(); 20 }); 21 }); 22 23 //在新的線程里，添加N個寫入日志的任務到線程池 24 SumLogCount += LogCount; 25 var thread1 = new Thread(() => 26 { 27 Parallel.For(0, LogCount, e => 28 { 29 ThreadPool.QueueUserWorkItem((subObj) => 30 { 31 WriteLog(); 32 }); 33 }); 34 }); 35 thread1.IsBackground = false; 36 thread1.Start(); 37 38 //添加N個寫入日志的任務到線程池 39 SumLogCount += LogCount; 40 Parallel.For(0, LogCount, e => 41 { 42 ThreadPool.QueueUserWorkItem((obj) => 43 { 44 WriteLog(); 45 }); 46 }); 47 48 //在新的線程里，迭代寫入N個日志 49 SumLogCount += LogCount; 50 var thread2 = new Thread(() => 51 { 52 Parallel.For(0, LogCount, e => 53 { 54 WriteLog(); 55 }); 56 }); 57 thread2.IsBackground = false; 58 thread2.Start(); 59 60 //在當前線程里，迭代寫入N個日志 61 SumLogCount += LogCount; 62 Parallel.For(0, LogCount, e => 63 { 64 WriteLog(); 65 }); 66 67 Console.WriteLine("Main Thread Processed.\r\n"); 68 while (true) 69 { 70 Console.WriteLine(string.Format("Sum Log Count:{0}.\t\tWrited Count:{1}.\tFailed Count:{2}.", SumLogCount.ToString(), WritedCount.ToString(), FailedCount.ToString())); 71 Console.ReadLine(); 72 } 73 } 74 75 static void WriteLog() 76 { 77 try 78 { 79 //設置讀寫鎖為寫入模式獨占資源，其他寫入請求需要等待本次寫入結束之后才能繼續寫入 80 //注意：長時間持有讀線程鎖或寫線程鎖會使其他線程發生飢餓 (starve)。 為了得到最好的性能，需要考慮重新構造應用程序以將寫訪問的持續時間減少到最小。 81 // 從性能方面考慮，請求進入寫入模式應該緊跟文件操作之前，在此處進入寫入模式僅是為了降低代碼復雜度 82 // 因進入與退出寫入模式應在同一個try finally語句塊內，所以在請求進入寫入模式之前不能觸發異常，否則釋放次數大於請求次數將會觸發異常 83 LogWriteLock.EnterWriteLock(); 84 85 var logFilePath = "log.txt"; 86 var now = DateTime.Now; 87 var logContent = string.Format("Tid: {0}{1} {2}.{3}\r\n", Thread.CurrentThread.ManagedThreadId.ToString().PadRight(4), now.ToLongDateString(), now.ToLongTimeString(), now.Millisecond.ToString()); 88 89 File.AppendAllText(logFilePath, logContent); 90 WritedCount++; 91 } 92 catch (Exception) 93 { 94 FailedCount++; 95 } 96 finally 97 { 98 //退出寫入模式，釋放資源占用 99 //注意：一次請求對應一次釋放 100 // 若釋放次數大於請求次數將會觸發異常[寫入鎖定未經保持即被釋放] 101 // 若請求處理完成后未釋放將會觸發異常[此模式不下允許以遞歸方式獲取寫入鎖定] 102 LogWriteLock.ExitWriteLock(); 103 } 104 } 105 }
運行結果：
部分日志文件內容：
1 ... 2 Tid: 36 2016年12月11日 15:29:22.825 3 Tid: 29 2016年12月11日 15:29:22.830 4 Tid: 6 2016年12月11日 15:29:22.838 5 Tid: 26 2016年12月11日 15:29:22.845 6 Tid: 34 2016年12月11日 15:29:22.854 7 Tid: 24 2016年12月11日 15:29:22.863 8 Tid: 27 2016年12月11日 15:29:22.872 9 Tid: 14 2016年12月11日 15:29:22.877 10 Tid: 23 2016年12月11日 15:29:22.886 11 Tid: 20 2016年12月11日 15:29:22.892 12 Tid: 30 2016年12月11日 15:29:22.898 13 Tid: 9 2016年12月11日 15:29:22.904 14 Tid: 21 2016年12月11日 15:29:22.909 15 Tid: 22 2016年12月11日 15:29:22.915 16 Tid: 7 2016年12月11日 15:29:22.920 17 Tid: 3 2016年12月11日 15:29:22.925 18 Tid: 12 2016年12月11日 15:29:22.931 19 Tid: 5 2016年12月11日 15:29:22.937 20 Tid: 13 2016年12月11日 15:29:22.942 21 Tid: 11 2016年12月11日 15:29:22.947 22 Tid: 19 2016年12月11日 15:29:22.953 23 Tid: 37 2016年12月11日 15:29:22.958 24 Tid: 37 2016年12月11日 15:29:22.964 25 Tid: 40 2016年12月11日 15:29:22.970 26 Tid: 40 2016年12月11日 15:29:22.975 27 Tid: 40 2016年12月11日 15:29:22.980 28 Tid: 40 2016年12月11日 15:29:22.985 29 Tid: 40 2016年12月11日 15:29:22.991 30 Tid: 40 2016年12月11日 15:29:22.997 31 Tid: 31 2016年12月11日 15:29:23.3 32 Tid: 31 2016年12月11日 15:29:23.9 33 Tid: 31 2016年12月11日 15:29:23.14 34 Tid: 31 2016年12月11日 15:29:23.20 35 Tid: 31 2016年12月11日 15:29:23.27 36 Tid: 31 2016年12月11日 15:29:23.33 37 Tid: 31 2016年12月11日 15:29:23.38 38 Tid: 31 2016年12月11日 15:29:23.44 39 Tid: 31 2016年12月11日 15:29:23.49 40 Tid: 31 2016年12月11日 15:29:23.57 41 Tid: 31 2016年12月11日 15:29:23.63 42 Tid: 31 2016年12月11日 15:29:23.68 43 Tid: 31 2016年12月11日 15:29:23.74 44 Tid: 16 2016年12月11日 15:29:23.80 45 Tid: 16 2016年12月11日 15:29:23.86 46 Tid: 16 2016年12月11日 15:29:23.93 47 Tid: 16 2016年12月11日 15:29:23.99 48 Tid: 16 2016年12月11日 15:29:23.105 49 Tid: 16 2016年12月11日 15:29:23.110 50 Tid: 16 2016年12月11日 15:29:23.116 51 Tid: 38 2016年12月11日 15:29:23.122 52 Tid: 38 2016年12月11日 15:29:23.128 53 Tid: 28 2016年12月11日 15:29:23.134 54 Tid: 19 2016年12月11日 15:29:23.139 55 Tid: 25 2016年12月11日 15:29:23.146 56 Tid: 37 2016年12月11日 15:29:23.152 57 Tid: 39 2016年12月11日 15:29:23.158 58 Tid: 32 2016年12月11日 15:29:23.164 59 Tid: 33 2016年12月11日 15:29:23.170 60 Tid: 31 2016年12月11日 15:29:23.176 61 Tid: 35 2016年12月11日 15:29:23.182 62 Tid: 40 2016年12月11日 15:29:23.189 63 Tid: 15 2016年12月11日 15:29:23.194 64 Tid: 18 2016年12月11日 15:29:23.202 65 Tid: 17 2016年12月11日 15:29:23.208 66 Tid: 10 2016年12月11日 15:29:23.215 67 Tid: 16 2016年12月11日 15:29:23.221
復雜多線程環境下使用讀寫鎖，全部日志成功寫入了日志文件，由ThreadId和DateTime可以看出是由不同的線程同步寫入。