在C#使用文件監控對象FileSystemWatcher 實現數據同步 - smiler－IT工程師數位筆記本

文章出處

最近在項目中有這么個需求，就是得去實時獲取某個在無規律改變的文本文件中的內容。首先想到的是用程序定期去訪問這個文件，因為對實時性要求很高，間隔不能超過1S，而且每次獲取到文本內容都要去分發給WEB服務器做別的操作，而那個文本的寫入有時候會頻繁，1秒可能多次，但是也有可能在相當長一段時間內是沒有任何寫入的。

這樣一來如果每秒都去訪問文件的話，一個是IO問題，還有就是每次操作都會引起后端一系列程序的反應，文本在長時間內無寫入的話，一秒一次的觸發一系列徒勞的事情太不可取了。

最終發現了c#中的FileSystemWatcher對象，在應用FileSystemWatcher之前，首先了解一下這個對象的基本屬性和事件，首先普及一下FileSystemWatcher基本知識。

FileSystemWatcher基礎

屬性：

Path——這個屬性告訴FileSystemWatcher它需要監控哪條路徑。例如，如果我們將這個屬性設為“C:\test”，對象就監控test目錄下所有文件發生的所有改變（包括刪除，修改，創建，重命名）。

IncludeSubDirectories——這個屬性說明FileSystemWatcher對象是否應該監控子目錄中（所有文件）發生的改變。

Filter——這個屬性允許你過濾掉某些類型的文件發生的變化。例如，如果我們只希望在TXT文件被修改/新建/刪除時提交通知，可以將這個屬性設為“*txt”。在處理高流量或大型目錄時，使用這個屬性非常方便。

NotifyFilter——獲取或設置要監視的更改類型。可以進一步的過濾要監控的更改類型，如watcher.NotifyFilter = NotifyFilters.LastAccess | NotifyFilters.LastWrite

| NotifyFilters.FileName | NotifyFilters.DirectoryName;

事件：

Changed——當被監控的目錄中有一個文件被修改時，就提交這個事件。值得注意的是，這個事件可能會被提交多次，即使文件的內容僅僅發生一項改變。這是由于在保存文件時，文件的其它屬性也發生了改變。

Created——當被監控的目錄新建一個文件時，就提交這個事件。如果你計劃用這個事件移動新建的事件，你必須在事件處理器中寫入一些錯誤處理代碼，它能處理當前文件被其它進程使用的情況。之所以要這樣做，是因為Created事件可能在建立文件的進程釋放文件之前就被提交。如果你沒有準備正確處理這種情況的代碼，就可能出現異常。

Deleted——當被監控的目錄中有一個文件被刪除，就提交這個事件。

Renamed——當被監控的目錄中有一個文件被重命名，就提交這個事件。

注：如果你沒有將EnableRaisingEvents設為真，系統不會提交任何一個事件。如果有時FileSystemWatcher對象似乎無法工作，請首先檢查EnableRaisingEvents，確保它被設為真。

事件處理
當FileSystemWatcher調用一個事件處理器時，它包含兩個自變量——一個叫做“sender”的對象和一個叫做“e”的 FileSystemEventArgs對象。我們感興趣的自變量為FileSystemEventArgs自變量。這個對象中包含有提交事件的原因。以下是FileSystemEventArgs對象的一些屬性：

屬性：
Name——這個屬性中使事件被提交的文件的名稱。其中并不包含文件的路徑——只包含使用事件被提交的文件或目錄名稱。

ChangeType——這是一個WatcherChangeTypes，它指出要提交哪個類型的事件。其有效值包括：

Changed

Created

Deleted

Renamed

FullPath——這個屬性中包含使事件被提交的文件的完整路徑，包括文件名和目錄名。

注意：FileSystemEventArgs對象是監控文件夾下有文件創建、刪除、修改時的自變量，如果是重命名的話為RenamedEventArgs對象此時除了FileSystemEventArgs對象的屬性值，多了一個OldFullPath，為重命名之前的文件名。

以上為FileSystemEventArgs的基本知識，大部分是從網上搜找的然后自己稍微整理了一下。

下面為簡單用法：

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

namespace WpfApplication1
{
    /// <summary>
    /// MainWindow.xaml 的交互邏輯
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
            
        }

        private void button1_Click(object sender, RoutedEventArgs e)
        {
            FileSystemWatcher watcher = new FileSystemWatcher();
            watcher.Path = @"C:\test";
            watcher.IncludeSubdirectories = true;
            watcher.NotifyFilter = NotifyFilters.LastAccess | NotifyFilters.LastWrite
                                   | NotifyFilters.FileName | NotifyFilters.DirectoryName;
            watcher.Filter = "*.txt";

            watcher.Changed += (s,e1)=> this.Dispatcher.Invoke(new Action(() =>
            {
                label1.Content = e1.Name + "被修改！";
            }));
            watcher.Created += (s, e1) =>  this.Dispatcher.Invoke(new Action(() => { label1.Content = e1.Name + "被添加！"; }));
            watcher.Deleted += (s, e1) =>  this.Dispatcher.Invoke(new Action(() => { label1.Content = e1.Name + "被刪除！"; }));
            watcher.Renamed += (s, e1) =>  this.Dispatcher.Invoke(new Action(() =>
            {
                label1.Content = e1.OldName + "被重命名為:"+e1.Name;
            }));

            //開始監視
            watcher.EnableRaisingEvents = true;
        }
    }
}