c#使用filesystemwatcher實時監控文件目錄的添加和刪除

2020-01-24 02:49:24

字體：大中小

來源：轉載

供稿：網友

首先，我們需要對.net提供的FileSystemWatcher類有所了解。我有些懶，找了MSDN對該類的描述。

FileSystemWatcher類偵聽文件系統更改通知，并在目錄或目錄中的文件發生更改時引發事件。

使用 FileSystemWatcher 監視指定目錄中的更改。可監視指定目錄中的文件或子目錄的更改。可以創建一個組件來監視本地計算機、網絡驅動器或遠程計算機上的文件。

若要監視所有文件中的更改，請將 Filter 屬性設置為空字符串 ("") 或使用通配符（“*.*”）。若要監視特定的文件，請將 Filter 屬性設置為該文件名。例如，若要監視文件 MyDoc.txt 中的更改，請將 Filter 屬性設置為“MyDoc.txt”。也可以監視特定類型文件中的更改。例如，若要監視文本文件中的更改，請將 Filter 屬性設置為“*.txt”。

可監視目錄或文件中的若干種更改。例如，可監視文件或目錄的 Attributes、LastWrite 日期和時間或 Size 方面的更改。通過將 NotifyFilter 屬性設置為 NotifyFilters 值之一來達到此目的。有關可監視的更改類型的更多信息，請參見 NotifyFilters。

可監視文件或目錄的重命名、刪除或創建。例如，若要監視文本文件的重命名，請將 Filter 屬性設置為“*.txt”，并使用為其參數指定的 Renamed 來調用 WaitForChanged 方法。

Windows 操作系統在 FileSystemWatcher 創建的緩沖區中通知組件文件發生更改。如果短時間內有很多更改，則緩沖區可能會溢出。這將導致組件失去對目錄更改的跟蹤，并且它將只提供一般性通知。使用 InternalBufferSize 屬性來增加緩沖區大小的開銷較大，因為它來自無法換出到磁盤的非頁面內存，所以應確保緩沖區大小適中（盡量小，但也要有足夠大小以便不會丟失任何文件更改事件）。若要避免緩沖區溢出，請使用 NotifyFilter 和 IncludeSubdirectories 屬性，以便可以篩選掉不想要的更改通知。

使用 FileSystemWatcher 類時，請注意以下事項。

1）對包括隱藏文件(夾)在內的所有文件(夾)進行監控。

2）您可以為 InternalBufferSize 屬性（用于監視網絡上的目錄）設置的最大大小為 64 KB。

FileSystemWatcher的實例監控到文件(夾)的變化后，會觸發相應的事件，其中文件(夾)的添加，刪除和修改會分別觸發Created，Deleted，Changed事件，文件(夾)重命名時觸發OnRenamed事件。

然后，在熟悉了FileSystemWatcher類后，我們開始自己的程序編寫。

實例化FileSystemWatcher類，并傳入需要監控的目錄路徑，以及是否制定監控的文件類型（文章前面有所介紹）。

復制代碼代碼如下:

_watcher = new FileSystemWatcher(_path, _filter);

注冊監聽事件，以及編寫事件觸發后相關的處理邏輯。

復制代碼代碼如下:

_watcher.Created += new FileSystemEventHandler(OnChanged);
            _watcher.Changed += new FileSystemEventHandler(OnChanged);
            _watcher.Deleted += new FileSystemEventHandler(OnChanged);
            _watcher.Renamed += new RenamedEventHandler(OnRenamed);
            _watcher.IncludeSubdirectories = true;
            _watcher.EnableRaisingEvents = true;

在本程序中，專門定義了一個FileChangeInformation類來記錄文件變化信息，并定義了一個CustomQueue類，該類類似于Queue類，是一個數據先進先出的集合，用來存儲所有的文件變化消息，并提供數據持久化功能。

監控類 - FileWatcher，代碼如下：

復制代碼代碼如下:

/// <summary>
    /// 文件監控類，用于監控指定目錄下文件以及文件夾的變化
    /// </summary>
    public class FileWatcher
    {
        private FileSystemWatcher _watcher = null;
        private string _path = string.Empty;
        private string _filter = string.Empty;
        private bool _isWatch = false;
        private CustomQueue<FileChangeInformation> _queue = null;

        /// <summary>
        /// 監控是否正在運行
        /// </summary>
        public bool IsWatch
        {
            get
            {
                return _isWatch;
            }
        }

        /// <summary>
        /// 文件變更信息隊列
        /// </summary>
        public CustomQueue<FileChangeInformation> FileChangeQueue
        {
            get
            {
                return _queue;
            }
        }

        /// <summary>
        /// 初始化FileWatcher類
        /// </summary>
        /// <param name="path">監控路徑</param>
        public FileWatcher(string path)
        {
            _path = path;
            _queue = new CustomQueue<FileChangeInformation>();
        }
        /// <summary>
        /// 初始化FileWatcher類，并指定是否持久化文件變更消息
        /// </summary>
        /// <param name="path">監控路徑</param>
        /// <param name="isPersistence">是否持久化變更消息</param>
        /// <param name="persistenceFilePath">持久化保存路徑</param>
        public FileWatcher(string path, bool isPersistence, string persistenceFilePath)
        {
            _path = path;
            _queue = new CustomQueue<FileChangeInformation>(isPersistence, persistenceFilePath);
        }

        /// <summary>
        /// 初始化FileWatcher類，并指定是否監控指定類型文件
        /// </summary>
        /// <param name="path">監控路徑</param>
        /// <param name="filter">指定類型文件，格式如:*.txt,*.doc,*.rar</param>
        public FileWatcher(string path, string filter)
        {
            _path = path;
            _filter = filter;
            _queue = new CustomQueue<FileChangeInformation>();
        }

        /// <summary>
        /// 初始化FileWatcher類，并指定是否監控指定類型文件，是否持久化文件變更消息
        /// </summary>
        /// <param name="path">監控路徑</param>
        /// <param name="filter">指定類型文件，格式如:*.txt,*.doc,*.rar</param>
        /// <param name="isPersistence">是否持久化變更消息</param>
        /// <param name="persistenceFilePath">持久化保存路徑</param>
        public FileWatcher(string path, string filter, bool isPersistence, string persistenceFilePath)
        {
            _path = path;
            _filter = filter;
            _queue = new CustomQueue<FileChangeInformation>(isPersistence, persistenceFilePath);
        }

        /// <summary>
        /// 打開文件監聽器
        /// </summary>
        public void Open()
        {
            if (!Directory.Exists(_path))
            {
                Directory.CreateDirectory(_path);
            }

            if (string.IsNullOrEmpty(_filter))
            {
                _watcher = new FileSystemWatcher(_path);
            }
            else
            {
                _watcher = new FileSystemWatcher(_path, _filter);
            }
            //注冊監聽事件
            _watcher.Created += new FileSystemEventHandler(OnProcess);
            _watcher.Changed += new FileSystemEventHandler(OnProcess);
            _watcher.Deleted += new FileSystemEventHandler(OnProcess);
            _watcher.Renamed += new RenamedEventHandler(OnFileRenamed);
            _watcher.IncludeSubdirectories = true;
            _watcher.EnableRaisingEvents = true;
            _isWatch = true;
        }

        /// <summary>
        /// 關閉監聽器
        /// </summary>
        public void Close()
        {
            _isWatch = false;
            _watcher.Created -= new FileSystemEventHandler(OnProcess);
            _watcher.Changed -= new FileSystemEventHandler(OnProcess);
            _watcher.Deleted -= new FileSystemEventHandler(OnProcess);
            _watcher.Renamed -= new RenamedEventHandler(OnFileRenamed);
            _watcher.EnableRaisingEvents = false;
            _watcher = null;
        }

        /// <summary>
        /// 獲取一條文件變更消息
        /// </summary>
        /// <returns></returns>
        public FileChangeInformation Get()
        {
            FileChangeInformation info = null;
            if (_queue.Count > 0)
            {
                lock (_queue)
                {
                    info = _queue.Dequeue();
                }
            }
            return info;
        }

        /// <summary>
        /// 監聽事件觸發的方法
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void OnProcess(object sender, FileSystemEventArgs e)
        {
            try
            {
                FileChangeType changeType = FileChangeType.Unknow;
                if (e.ChangeType == WatcherChangeTypes.Created)
                {
                    if (File.GetAttributes(e.FullPath) == FileAttributes.Directory)
                    {
                        changeType = FileChangeType.NewFolder;
                    }
                    else
                    {
                        changeType = FileChangeType.NewFile;
                    }
                }
                else if (e.ChangeType == WatcherChangeTypes.Changed)
                {
                    //部分文件創建時同樣觸發文件變化事件，此時記錄變化操作沒有意義
                    //如果
                    if (_queue.SelectAll(
                        delegate(FileChangeInformation fcm)
                        {
                            return fcm.NewPath == e.FullPath && fcm.ChangeType == FileChangeType.Change;
                        }).Count<FileChangeInformation>() > 0)
                    {
                        return;
                    }

                    //文件夾的變化，只針對創建，重命名和刪除動作，修改不做任何操作。
                    //因為文件夾下任何變化同樣會觸發文件的修改操作，沒有任何意義.
                    if (File.GetAttributes(e.FullPath) == FileAttributes.Directory)
                    {
                        return;
                    }

                    changeType = FileChangeType.Change;
                }
                else if (e.ChangeType == WatcherChangeTypes.Deleted)
                {
                    changeType = FileChangeType.Delete;
                }

                //創建消息，并壓入隊列中
                FileChangeInformation info = new FileChangeInformation(Guid.NewGuid().ToString(), changeType, e.FullPath, e.FullPath, e.Name, e.Name);
                _queue.Enqueue(info);
            }
            catch
            {
                Close();
            }
        }

        /// <summary>
        /// 文件或目錄重命名時觸發的事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void OnFileRenamed(object sender, RenamedEventArgs e)
        {
            try
            {
                //創建消息，并壓入隊列中
                FileChangeInformation info = new FileChangeInformation(Guid.NewGuid().ToString(), FileChangeType.Rename, e.OldFullPath, e.FullPath, e.OldName, e.Name);
                _queue.Enqueue(info);
            }
            catch
            {
                Close();
            }
        }
    }

最后，功能調用如下：

復制代碼代碼如下:

//初始化監控器
FileWatcher watcher = new FileWatcher(@"D:/");
watcher.Open();

                FileChangeInformation fci = null;
                //獲取消息
                while (true)
                {
                    //如果IsWatch為False，則可能監控內部發生異常終止了監控，需要重新開啟監控
                    if (watcher.IsWatch)
                    {
                        //隊列頂端的變更消息
                        fci = watcher.Get();
                        //處理消息的代碼
                        //Print(fci);
                    }
                    else
                    {
                        watcher.Open();
                    }
                    Thread.Sleep(1000);
                }