C# FileSystemWatcher控件用法详解

FileSystemWatcher控件主要功能:
监控指定文件或目录的文件的创建、删除、改动、重命名等活动。可以动态地定义需要监控的文件类型及文件属性改动的类型。
1.常用的几个基本属性:
(1) Path :设置要监视的目录的路径。
(2) IncludeSubdirectories :设置是否级联监视指定路径中的子目录。
(3) Filter :设置筛选字符串,用于确定在目录中监视哪些类型的文件。
(4) NotifyFilter :设置文件的哪些属性的变动会触发Changed事件,同时监控多个属性变动可以按“或”组合。(默认值为 NotifyFilter.LastWrite | NotifyFilter.FileName | NotifyFilter.DirectoryName 组合)
    子项:    Attributes     --  文件或文件夹的属性。  
             CreationTime   --  文件或文件夹的创建时间。  
             DirectoryName --  目录名。(常用) 
             FileName          --  文件名。 (常用)
             LastAccess       --  文件或文件夹上一次打开的日期。  
             LastWrite           --  上一次向文件或文件夹写入内容的日期。  
             Security              --  文件或文件夹的安全设置。  
             Size                    --   文件或文件夹的大小。 (常用)
(5) EnableRaisingEvents :设置是否开始监控。(默认为false)
2.常用事件:
(1) Changed  :当更改文件和目录时发生,可以通过NotifyFilter属性设置触发该事件的需要文件更改的属性。
(2) Created  :  当创建文件和目录时发生。 
(3) Deleted :    删除文件或目录时发生。 
(4) Renamed  :重命名文件或目录时发生。
(5) FileSystemEventArgs 对象:
            成员:Name:     获取受影响的文件或目录的名称。 注意:如果是级联监控子目录的话,该值为从监控目录的下个目录到受影响的文件的路径,而不只是受影响的文件名。
            FullPath : 获取受影响的文件或目录的完全限定的路径。 
            ChangeType :获取受影响的文件或目录的发生的事件类型。
                       子项:All    -- 文件或文件夹的创建、删除、更改或重命名。  
                       Changed     -- 文件或文件夹的更改。更改的类型包括大小、属性、安全设置、最近写入时间和最近访问时间方面的更改。  
                       Created       -- 文件或文件夹的创建。  
                       Deleted       --  文件或文件夹的删除。  
                       Renamed   --  文件或文件夹的重命名。  
(6) RenamedEventArgs 对象:
            成员:Name:           获取受影响的文件或目录的新名称。 
            OldName :    获取受影响的文件或目录的旧名称。
            FullPath :      获取受影响的文件或目录的完全限定的路径。
            OldFullPath : 获取受影响的文件或目录的前一个完全限定的路径。
            ChangeType :获取受影响的文件或目录的发生的事件类型。
                       子项:All    -- 文件或文件夹的创建、删除、更改或重命名。  
                       Changed     -- 文件或文件夹的更改。更改的类型包括大小、属性、安全设置、最近写入时间和最近访问时间方面的更改。  
                       Created     -- 文件或文件夹的创建。  
                       Deleted     --  文件或文件夹的删除。  
                       Renamed     --  文件或文件夹的重命名。 
演示源码:
private delegate void setLogTextDelegate(FileSystemEventArgs e); //声明传递FileSystemEventArgs对象的委托,用于文件Created,Deleted和Changed变动时更新UI界面。
private delegate void renamedDelegate(RenamedEventArgs e);  //声明传递RenamedEventArgs对象的委托,用于文件Renamed时更新UI界面。
FileSystemWatcher fsw= new FileSystemWatcher();
fsw.Path = “C:\\”;   //设置监控的文件目录
fsw.IncludeSubdirectories = true;   //设置监控C盘目录下的所有子目录
//fsw.Filter = "*.txt|*.doc|*.jpg";   //设置监控文件的类型(看到大家的评论,暂时没时间测试,文件过滤监控的大家自己测试)
fsw.NotifyFilter = NotifyFilters.FileName | NotifyFilters.DirectoryName | NotifyFilters.Size;   //设置文件的文件名、目录名及文件的大小改动会触发Changed事件
fsw.Created += new FileSystemEventHandler(this.fileSystemWatcher_EventHandle);  //绑定事件触发后处理数据的方法。
fsw.Deleted += new FileSystemEventHandler(this.fileSystemWatcher_EventHandle);
fsw.Changed += new FileSystemEventHandler(this.fileSystemWatcher_EventHandle);
fsw.Renamed += new RenamedEventHandler(this.fileSystemWatcher_Renamed);  //重命名事件与增删改传递的参数不一样。
fsw.EnableRaisingEvents = true;  //启动监控
private void fileSystemWatcher_EventHandle(object sender, FileSystemEventArgs e)  //文件增删改时被调用的处理方法
{
      if (this.listView1.InvokeRequired)  //判断是否跨线程
      {
           this.listView1.Invoke(new setLogTextDelegate(setLogText), new object[] { e });   //使用委托将方法封送到UI主线程处理
      }
}
private void fileSystemWatcher_Renamed(object sender,RenamedEventArgs e)   //文件重命名时被调用的处理方法
{
      if (this.listView1.InvokeRequired) //判断是否跨线程
       { 
           this.listView1.Invoke(new renamedDelegate(setRenamedLogText), new object[] { e });  //使用委托将方法封送到UI主线程处理
       }
}
private void setLogText(FileSystemEventArgs e)  //更新UI界面
{
      ListViewItem lvi = new ListViewItem();
      lvi.SubItems.Add(e.Name);   //受影响的文件名
      lvi.SubItems.Add(e.ChangeType.ToString());   //受影响文件的变动类型(可能为Created、Changed、Deleted)
      lvi.SubItems.Add(e.FullPath);     //受影响的文件完整路径
      this.listView1.Items.Add(lvi);
}
private void setRenamedLogText(RenamedEventArgs e)  //更新UI界面
{
       ListViewItem lvi = new ListViewItem();
       lvi.SubItems.Add(e.OldName);   //受影响的文件的原名
       lvi.SubItems.Add(e.ChangeType.ToString());  //受影响的文件的改动类型(Rename)
       lvi.SubItems.Add(e.Name);   //受影响的文件的新名
       lvi.SubItems.Add(e.OldFullPath);     //受影响的文件的原路径
       lvi.SubItems.Add(e.FullPath);  //受影响的文件的完整路径(其实和原路径一样)
       this.fileEventLog_lvw.Items.Add(lvi);
 }
重点:
1、因为FileSystemWatcher类本身就是多线程的控件,也就是每实例化一个FileSystemWatcher自动就会创建一条线程。
2、我们需要利用委托进行跨线程更新UI界面,因为重命名事件传递的是RenameEventArgs对象,而创建、修改、删除事件传递的是FileEventArgs对象,所以需要声明两个委托。
3、如果需要同时监控多个文件(如监控系统全盘),只需要创建FileSystemWatcher数组,每个文件用一个FileSystemWatcher进行监控。
来源:https://blog.csdn.net/chen_zw/article/details/7916262
FileSystemWatcher事件多次触发的解决方法:
1、问题描述
      程序里需要监视某个目录下的文件变化情况: 一旦目录中出现新文件或者旧的文件被覆盖,程序需要读取文件内容并进行处理。于是使用了下面的代码:
 public void Initial()
 {
   System.IO.FileSystemWatcher fsw = new System.IO.FileSystemWatcher();           
   fsw.Filter = "*.*";
   fsw.NotifyFilter = NotifyFilters.FileName  |
                      NotifyFilters.LastWrite |
                      NotifyFilters.CreationTime;
   // Add event handlers.
   fsw.Created += new FileSystemEventHandler(fsw_Changed);
   fsw.Changed += new FileSystemEventHandler(fsw_Changed);
   // Begin watching.
   fsw.EnableRaisingEvents = true;
 }
 void fsw_Changed(object sender, FileSystemEventArgs e)
 {
    MessageBox.Show("Changed", e.Name);
 }
结果发现当一个文件产生变化时,Change事件被反复触发了好几次。这样可能的结果是造成同一文件的重复处理。
2、解决方案:
  通过一个计时器,在文件事件处理中让计时器延迟一段时间之后,再执行加载新的配置文件操作。这样可以避免对文件做一次操作触发了多个更改事件,而多次加载配置文件。"
(1). 定义变量
private int TimeoutMillis = 2000; //定时器触发间隔
System.IO.FileSystemWatcher fsw = new System.IO.FileSystemWatcher();
System.Threading.Timer m_timer = null;
List<String> files = new List<string>(); //记录待处理文件的队列
(2). 初始化FileSystemWatcher和定时器
       fsw.Filter = "*.*";
       fsw.NotifyFilter = NotifyFilters.FileName  |
                          NotifyFilters.LastWrite |
                          NotifyFilters.CreationTime;
       // Add event handlers.
      fsw.Created += new FileSystemEventHandler(fsw_Changed);
      fsw.Changed += new FileSystemEventHandler(fsw_Changed);
      // Begin watching.
      fsw.EnableRaisingEvents = true;
      // Create the timer that will be used to deliver events. Set as disabled
      if (m_timer == null)
      {
         //设置定时器的回调函数。此时定时器未启动
         m_timer = new System.Threading.Timer(new TimerCallback(OnWatchedFileChange),
                                      null, Timeout.Infinite, Timeout.Infinite);
      }
(3). 文件监视事件触发代码:修改定时器,记录文件名待以后处理
        void fsw_Changed(object sender, FileSystemEventArgs e)
        {
            Mutex mutex = new Mutex(false, "FSW");
            mutex.WaitOne();
            if (!files.Contains(e.Name))
            {
                files.Add(e.Name);
            }
            mutex.ReleaseMutex();
            //重新设置定时器的触发间隔,并且仅仅触发一次
            m_timer.Change(TimeoutMillis, Timeout.Infinite);
        }
(4). 定时器事件触发代码:进行文件的实际处理
        private void OnWatchedFileChange(object state)
        {
            List<String> backup = new List<string>();
            Mutex mutex = new Mutex(false, "FSW");
            mutex.WaitOne();
            backup.AddRange(files);
            files.Clear();
            mutex.ReleaseMutex();
            foreach (string file in backup)
            {
                MessageBox.Show("File Change", file + " changed");
            }
        }
附:
FileSystemWatcher
1. BufferSize
Windows操作系统使用FileSystemWatcher创建的一个内存缓冲区通知程序文件的修改信息,如果在很短的时间内有非常多的文件修改,这个缓冲区会溢出, 造成部分追踪丢失,并且FileSystemWatcher不会产生异常。
加大InternalBufferSize属性值可以避免这种情况。 InternalBufferSize默认值是8K,可以设置的最小值是4K,增加或减小InternalBufferSize最好用4K的整数倍。每一个事件通知需要使用16字节,并不包含文件名。InternalBufferSize的内存来自non
-paged内存,注意这部分内存资源比较宝贵。 使用NotifyFilter、IncludeSubdirectories属性减小trace范围,设置filter属性并不会影响进入缓冲区的事件通知,另外尽快的完成事件处理,也是避免缓冲区溢出造成事件丢失的一个措施。 2. 隐藏文件也会监控 3. 有些系统中,FileSystemWatcher的事件里对长文件名使用8.3短文件名方式表示。
 将上面的代码整理一下,封装成一个类,使用上更加便利一些:
    public class WatcherTimer
    {
        private int TimeoutMillis = 2000;
        System.IO.FileSystemWatcher fsw = new System.IO.FileSystemWatcher();
        System.Threading.Timer m_timer = null;
        List<String> files = new List<string>();
        FileSystemEventHandler fswHandler = null;

        public WatcherTimer(FileSystemEventHandler watchHandler)
        {
            m_timer = new System.Threading.Timer(new TimerCallback(OnTimer), 
                         null, Timeout.Infinite, Timeout.Infinite);
            fswHandler = watchHandler;

        }


        public WatcherTimer(FileSystemEventHandler watchHandler, int timerInterval)
        {
            m_timer = new System.Threading.Timer(new TimerCallback(OnTimer), 
                        null, Timeout.Infinite, Timeout.Infinite);
            TimeoutMillis = timerInterval;
            fswHandler = watchHandler;

        }

        public void OnFileChanged(object sender, FileSystemEventArgs e)
        {
            Mutex mutex = new Mutex(false, "FSW");
            mutex.WaitOne();
            if (!files.Contains(e.Name))
            {
                files.Add(e.Name);
            }
            mutex.ReleaseMutex();

            m_timer.Change(TimeoutMillis, Timeout.Infinite);
        }

        private void OnTimer(object state)
        {
            List<String> backup = new List<string>();

            Mutex mutex = new Mutex(false, "FSW");
            mutex.WaitOne();
            backup.AddRange(files);
            files.Clear();
            mutex.ReleaseMutex();


            foreach (string file in backup)
            {
                fswHandler(this, new FileSystemEventArgs(
                       WatcherChangeTypes.Changed, string.Empty, file));
            }

        }
在主调程序使用非常简单,只需要如下2步:
1、生成用于文件监视的定时器对象
   watcher = new WatcherTimer(fsw_Changed, TimeoutMillis);
其中fsw_Changed是你自己的文件监视事件代码,将它传递给定时器对象的目的是用于定时到时的时候定时器对象可以调用你自己真正用于处理文件的代码。例如:
void fsw_Changed(object sender, FileSystemEventArgs e)
{
   //Read file.
   //Remove file from folder after reading
      
}
2、将FileSystemWatcher的Create/Change/Rename/Delete等事件句柄关联到定时器的事件上
  fsw.Created += new FileSystemEventHandler(watcher.OnFileChanged);
  fsw.Changed += new FileSystemEventHandler(watcher.OnFileChanged);
  fsw.Renamed += new RenamedEventHandler(watcher.OnFileChanged);
  fsw.Deleted += new FileSystemEventHandler(watcher.OnFileChanged);
来源:https://www.cnblogs.com/dragon/archive/2008/07/04/filesystemwatcher.html
FileSystemWatcher事件多次触发的解决方法2:
2.延迟调用事件的代理,将多次事件合并为一次,从而很好的解决了此问题,唯一的缺憾是时间激发不及时,不适用于实时性较高的系统。推出检查最后更新时间法。
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
        private void Form1_Load(object sender, EventArgs e)
        {
            new GiantFileSystemWatcher("F:\\", "*.txt").Start();
        }
    }
    public class GiantFileSystemWatcher : IDisposable
    {
        private FileSystemEventHandler m_FileChangeHandler;
        public event FileSystemEventHandler FileChangeHandler
        {
            add { m_FileChangeHandler += value; }
            remove { m_FileChangeHandler -= value; }
        }
        public void test (object sender, FileSystemEventArgs e)
        {
            int i = 0;
        }
        private FileSystemWatcher m_Watcher;
        private Dictionary<string, DateTime> m_DictUpdateTime = new Dictionary<string, DateTime>();
        public GiantFileSystemWatcher(string path, string filter)
        {
            m_FileChangeHandler = test;
            m_Watcher = new FileSystemWatcher(path, filter);
            m_Watcher.Error += new ErrorEventHandler(m_Watcher_Error);
            m_Watcher.EnableRaisingEvents = false;
            m_Watcher.IncludeSubdirectories = true;
        }
        void m_Watcher_Error(object sender, ErrorEventArgs e)
        {
            //LogUtil.LogError(e.GetException());
        }
        public bool Start()
        {
            if (m_FileChangeHandler != null)
            {
                m_Watcher.Changed += new FileSystemEventHandler(m_Watcher_Changed);
                m_Watcher.Created += new FileSystemEventHandler(m_Watcher_Changed);
                m_Watcher.Renamed += new RenamedEventHandler(m_Watcher_Changed);
                m_Watcher.EnableRaisingEvents = true;
                return true;
            }
            else
            {
                return false;
            }
        }
        void m_Watcher_Changed(object sender, FileSystemEventArgs e)
        {
            try
            {
                DateTime lastModifyTime = File.GetLastWriteTime(e.FullPath);
                DateTime prevModifyTime = DateTime.MinValue;
                if (m_DictUpdateTime.TryGetValue(e.FullPath.ToLower(), out prevModifyTime))
                {
                    if (lastModifyTime <= prevModifyTime)
                    {
                        return;
                    }
                    else
                    {
                        m_DictUpdateTime[e.FullPath.ToLower()] = lastModifyTime;
                    }
                }
                else
                {
                    m_DictUpdateTime[e.FullPath.ToLower()] = lastModifyTime;
                }
                if (m_FileChangeHandler != null)
                {
                    m_FileChangeHandler.Invoke(this, e);
                }
            }
            catch (Exception exc)
            {
                //LogUtil.LogError(exc);
            }
        }
        
        public void Dispose()
        {
            m_DictUpdateTime.Clear();
            m_DictUpdateTime = null;
            m_Watcher.EnableRaisingEvents = false;
            if (m_FileChangeHandler != null)
            {
                m_Watcher.Changed -= new FileSystemEventHandler(m_Watcher_Changed);
                m_Watcher.Created -= new FileSystemEventHandler(m_Watcher_Changed);
                m_Watcher.Renamed -= new RenamedEventHandler(m_Watcher_Changed);
            }
            m_Watcher.Dispose();
        }
    }
来源:
https://www.cnblogs.com/jzywh/archive/2008/07/23/filesystemwatcher.html
https://blog.csdn.net/kongwei521/article/details/51626589
https://blog.csdn.net/kongwei521/article/details/53185788/

 

posted @ 2023-06-14 10:16  【君莫笑】  阅读(1314)  评论(0编辑  收藏  举报