c#使用filesystemwatcher實時監(jiān)控文件目錄的添加和刪除
首先,我們需要對.net提供的FileSystemWatcher類有所了解。我有些懶,找了MSDN對該類的描述。
FileSystemWatcher類偵聽文件系統(tǒng)更改通知,并在目錄或目錄中的文件發(fā)生更改時引發(fā)事件。
使用 FileSystemWatcher 監(jiān)視指定目錄中的更改??杀O(jiān)視指定目錄中的文件或子目錄的更改??梢詣?chuàng)建一個組件來監(jiān)視本地計算機(jī)、網(wǎng)絡(luò)驅(qū)動器或遠(yuǎn)程計算機(jī)上的文件。
若要監(jiān)視所有文件中的更改,請將 Filter 屬性設(shè)置為空字符串 ("") 或使用通配符(“*.*”)。若要監(jiān)視特定的文件,請將 Filter 屬性設(shè)置為該文件名。例如,若要監(jiān)視文件 MyDoc.txt 中的更改,請將 Filter 屬性設(shè)置為“MyDoc.txt”。也可以監(jiān)視特定類型文件中的更改。例如,若要監(jiān)視文本文件中的更改,請將 Filter 屬性設(shè)置為“*.txt”。
可監(jiān)視目錄或文件中的若干種更改。例如,可監(jiān)視文件或目錄的 Attributes、LastWrite 日期和時間或 Size 方面的更改。通過將 NotifyFilter 屬性設(shè)置為 NotifyFilters 值之一來達(dá)到此目的。有關(guān)可監(jiān)視的更改類型的更多信息,請參見 NotifyFilters。
可監(jiān)視文件或目錄的重命名、刪除或創(chuàng)建。例如,若要監(jiān)視文本文件的重命名,請將 Filter 屬性設(shè)置為“*.txt”,并使用為其參數(shù)指定的 Renamed 來調(diào)用 WaitForChanged 方法。
Windows 操作系統(tǒng)在 FileSystemWatcher 創(chuàng)建的緩沖區(qū)中通知組件文件發(fā)生更改。如果短時間內(nèi)有很多更改,則緩沖區(qū)可能會溢出。這將導(dǎo)致組件失去對目錄更改的跟蹤,并且它將只提供一般性通知。使用 InternalBufferSize 屬性來增加緩沖區(qū)大小的開銷較大,因為它來自無法換出到磁盤的非頁面內(nèi)存,所以應(yīng)確保緩沖區(qū)大小適中(盡量小,但也要有足夠大小以便不會丟失任何文件更改事件)。若要避免緩沖區(qū)溢出,請使用 NotifyFilter 和 IncludeSubdirectories 屬性,以便可以篩選掉不想要的更改通知。
使用 FileSystemWatcher 類時,請注意以下事項。
1) 對包括隱藏文件(夾)在內(nèi)的所有文件(夾)進(jìn)行監(jiān)控。
2) 您可以為 InternalBufferSize 屬性(用于監(jiān)視網(wǎng)絡(luò)上的目錄)設(shè)置的最大大小為 64 KB。
FileSystemWatcher的實例監(jiān)控到文件(夾)的變化后,會觸發(fā)相應(yīng)的事件,其中文件(夾)的添加,刪除和修改會分別觸發(fā)Created,Deleted,Changed事件,文件(夾)重命名時觸發(fā)OnRenamed事件。
然后,在熟悉了FileSystemWatcher類后,我們開始自己的程序編寫。
實例化FileSystemWatcher類,并傳入需要監(jiān)控的目錄路徑,以及是否制定監(jiān)控的文件類型(文章前面有所介紹)。
_watcher = new FileSystemWatcher(_path, _filter);
注冊監(jiān)聽事件,以及編寫事件觸發(fā)后相關(guān)的處理邏輯。
_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類,是一個數(shù)據(jù)先進(jìn)先出的集合,用來存儲所有的文件變化消息,并提供數(shù)據(jù)持久化功能。
監(jiān)控類 - FileWatcher,代碼如下:
/// <summary>
/// 文件監(jiān)控類,用于監(jiān)控指定目錄下文件以及文件夾的變化
/// </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>
/// 監(jiān)控是否正在運行
/// </summary>
public bool IsWatch
{
get
{
return _isWatch;
}
}
/// <summary>
/// 文件變更信息隊列
/// </summary>
public CustomQueue<FileChangeInformation> FileChangeQueue
{
get
{
return _queue;
}
}
/// <summary>
/// 初始化FileWatcher類
/// </summary>
/// <param name="path">監(jiān)控路徑</param>
public FileWatcher(string path)
{
_path = path;
_queue = new CustomQueue<FileChangeInformation>();
}
/// <summary>
/// 初始化FileWatcher類,并指定是否持久化文件變更消息
/// </summary>
/// <param name="path">監(jiān)控路徑</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類,并指定是否監(jiān)控指定類型文件
/// </summary>
/// <param name="path">監(jiān)控路徑</param>
/// <param name="filter">指定類型文件,格式如:*.txt,*.doc,*.rar</param>
public FileWatcher(string path, string filter)
{
_path = path;
_filter = filter;
_queue = new CustomQueue<FileChangeInformation>();
}
/// <summary>
/// 初始化FileWatcher類,并指定是否監(jiān)控指定類型文件,是否持久化文件變更消息
/// </summary>
/// <param name="path">監(jiān)控路徑</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>
/// 打開文件監(jiān)聽器
/// </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);
}
//注冊監(jiān)聽事件
_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>
/// 關(guān)閉監(jiān)聽器
/// </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>
/// 監(jiān)聽事件觸發(fā)的方法
/// </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)
{
//部分文件創(chuàng)建時同樣觸發(fā)文件變化事件,此時記錄變化操作沒有意義
//如果
if (_queue.SelectAll(
delegate(FileChangeInformation fcm)
{
return fcm.NewPath == e.FullPath && fcm.ChangeType == FileChangeType.Change;
}).Count<FileChangeInformation>() > 0)
{
return;
}
//文件夾的變化,只針對創(chuàng)建,重命名和刪除動作,修改不做任何操作。
//因為文件夾下任何變化同樣會觸發(fā)文件的修改操作,沒有任何意義.
if (File.GetAttributes(e.FullPath) == FileAttributes.Directory)
{
return;
}
changeType = FileChangeType.Change;
}
else if (e.ChangeType == WatcherChangeTypes.Deleted)
{
changeType = FileChangeType.Delete;
}
//創(chuàng)建消息,并壓入隊列中
FileChangeInformation info = new FileChangeInformation(Guid.NewGuid().ToString(), changeType, e.FullPath, e.FullPath, e.Name, e.Name);
_queue.Enqueue(info);
}
catch
{
Close();
}
}
/// <summary>
/// 文件或目錄重命名時觸發(fā)的事件
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void OnFileRenamed(object sender, RenamedEventArgs e)
{
try
{
//創(chuàng)建消息,并壓入隊列中
FileChangeInformation info = new FileChangeInformation(Guid.NewGuid().ToString(), FileChangeType.Rename, e.OldFullPath, e.FullPath, e.OldName, e.Name);
_queue.Enqueue(info);
}
catch
{
Close();
}
}
}
最后,功能調(diào)用如下:
//初始化監(jiān)控器
FileWatcher watcher = new FileWatcher(@"D:\");
watcher.Open();
FileChangeInformation fci = null;
//獲取消息
while (true)
{
//如果IsWatch為False,則可能監(jiān)控內(nèi)部發(fā)生異常終止了監(jiān)控,需要重新開啟監(jiān)控
if (watcher.IsWatch)
{
//隊列頂端的變更消息
fci = watcher.Get();
//處理消息的代碼
//Print(fci);
}
else
{
watcher.Open();
}
Thread.Sleep(1000);
}
該程序?qū)崿F(xiàn)了對文件目錄下所有子目錄和子文件的變化進(jìn)行監(jiān)控,并可通過FileChangeQueue屬性訪問文件變更消息,同時也可以設(shè)置其是否需要將數(shù)據(jù)持久化到磁盤文件中。
相關(guān)文章
深入理解c# checked unchecked 關(guān)鍵字
本篇文章是對c#中的checked unchecked 關(guān)鍵字進(jìn)行了詳細(xì)的分析介紹,需要的朋友參考下2013-05-05