一个更好的文件监控类,基于 DotNet 官方提供的 FileSystemWatcher

简介: 一个更好的文件监控类,基于 DotNet 官方提供的 FileSystemWatcher

缘起

前一段时间,想使用 .net 监听特定文件夹中的文件是否发生变化。网上一搜,可以使用 .net 官方提供的 FileSystemWatcher,很开心的写好了代码。随着使用的不断深入,发现了 FileSystemWatcher 几个不够完善的地方。比如,

  1. 事件触发时,文件可能还不能被访问。
  2. 如果监听选项设置的过多,则有可能会触发多次文件变化事件。
  3. 监听过滤器不够灵活,我没找到同时监听多种特定文件类型的方法。比如,同时只监听 .docx.bmp 文件。

鉴于此,基于 .net 官方提供的 FileSystemWatcher,我又封装了一个新的类。可以在一定程度上解决以上几个问题。

问题及解决方案

  1. 当事件触发的时候,文件还不能被访问。如何重现?

    重现方法:

    通过共享文件夹拷贝一个大文件,基本上可以重现。

    解决方案:

    在调用用户的回调函数前,先判断文件是否可以访问。

    实现代码:

    WaitForFileReadyToAccess 可以用来开启/关闭此功能。

    WaitUntilCanAccess() 不断尝试访问文件,以此来确定是否可以访问该文件。

    用户可以通过 FileAccessCheckIntervalMs 来设置尝试间隔,单位是毫秒。

    用户可以通过 MaxWaitMs 设置最大等待时间,单位是毫秒。

  1. 相同的事件触发多次。如何重现?

    重现方法:

    NotifyFilters 设置成下面的样子,拷贝一张文件到监听路径下即可重现。

    NotifyFilters _notifyFilters = NotifyFilters.DirectoryName | NotifyFilters.FileName
            | NotifyFilters.LastWrite | NotifyFilters.CreationTime | NotifyFilters.LastAccess
            | NotifyFilters.Attributes | NotifyFilters.Size | NotifyFilters.Security
            ;
    

    解决方案:

    在调用用户的回调函数前,稍微等一段时间,合并这段时间内的相同事件。

    实现代码:

    TryMergeSameEvent 用来开启/关闭事件合并功能。

    如果 TryMergeSameEvent 为真,那么会通过 eventDataList = eventDataList.Distinct().ToList(); 来去重。

    用户可以通过 DelayTriggerMs 指定延时触发间隔,单位是毫秒。只有在合并事件开启的时候才生效。

  1. 不能同时监听多种特定类型。

    重现方法:

    我没能找到同时监听多种特定类型的方法。

    解决方案:

    封装一个新类。用户可以通过 | 分割多个过滤条件。根据每个过滤条件构造对应的由系统提供的 FileSystemWatcher,保存到

    List<FileSystemWatcher> 中。

    实现代码:

    char[] splitter = {
          '|' };
    var filterList = Filters.Split(splitter).ToList();
    foreach (var filter in filterList)
    {
         
      FileSystemWatcher watcher = new FileSystemWatcher();
    
      watcher.Filter = filter;
      watcher.Path = this.Path;
      watcher.IncludeSubdirectories = this.Recursive;
      watcher.NotifyFilter = this.NotifyFilters;
      watcher.Created += this.OnFileSystemEventHandler;
      watcher.Deleted += this.OnFileSystemEventHandler;
      watcher.Changed += this.OnFileSystemEventHandler;
      watcher.Renamed += this.OnRenamedEventHandler;
      watcher.Error += this.OnErrorHandler;
      watcher.EnableRaisingEvents = true;
      WatcherList.Add(watcher);
    }
    

使用示例

public void OnFileChanged(object sender, System.IO.FileSystemEventArgs e)
{
   
  if (e.ChangeType == System.IO.WatcherChangeTypes.Created 
      || e.ChangeType == System.IO.WatcherChangeTypes.Changed)
  {
   
    this.Invoke(new MethodInvoker(delegate()
    {
   
      try
      {
   
        using (var imageStream = new FileStream(e.FullPath, FileMode.Open))
        {
   
          this.pictureBox1.Image = (Bitmap)Image.FromStream(imageStream);
        }
      }
      catch (Exception ex)
      {
   
        System.Diagnostics.Debug.WriteLine(string.Format("!!!! {0}", ex.ToString()));
      }
    }));
  }
}

private void Form1_Load(object sender, EventArgs e)
{
   
  var monitorPath = System.AppDomain.CurrentDomain.BaseDirectory;
  var fileWatcherEx = new FileSystemWatcherEx(monitorPath, "*.bmp|*.png|*.jpg|*.gif", true, "", OnFileChanged, OnFileChanged, OnFileChanged);
  fileWatcherEx.Start();
}

下载地址

我已经把这个简单的类开源了。欢迎感兴趣的小伙伴儿 clone star pr

githubhttps://github.com/BianChengNan/FileSystemWatcherEx

giteehttps://gitee.com/bianchengnan/FileSystemWatcherEx

如果不想克隆源码,也可以直接下载压缩包:

百度云:https://pan.baidu.com/s/1OBSFpQYRDQHhO5A0Yviqmw 提取码: yic3

CSDN:https://download.csdn.net/download/xiaoyanilw/19648448

总结

犹记得,2013 年在做网盘的时候(用的语言是 C++),也有监听文件变化的需求,我们使用的是 win32 api ReadDirectoryChanges 来实现的。相比原生 api.net 中的 FileSystemWatcher 确实方便了很多。但还有一些不方便的地方。如果你也有类似需求,可以试试 FileSystemWatcherEx

相关文章
|
6月前
|
算法 安全 Java
【C/C++ 实用工具】静态代码检测工具和平台的一览
【C/C++ 实用工具】静态代码检测工具和平台的一览
336 0
|
Swift iOS开发
iOS开发 - 适合工程多环境切换(swift环境),适合经常打很多不同环境包的人
iOS开发 - 适合工程多环境切换(swift环境),适合经常打很多不同环境包的人
291 0
iOS开发 - 适合工程多环境切换(swift环境),适合经常打很多不同环境包的人
|
XML JSON 前端开发
开源的YAPI外还有哪些免费的接口工具?
API 管理这个话题近些年听到的频次越来越多,这本质上是个 web 领域的发展有关,也和开发协作方式有关--前后端分离代替了全栈工程师 hold all 的局面,强调的更多的是 API 复用、分工和协作细化。 API 管理的重要性不言而喻,每家公司随着业务的发展,多多少少都会涉及到;从开源社区的产品到国内各类商业化产品,可以看到大家对于 API 管理是越来越重视的。
|
Web App开发 C++ Windows
C#-clickonce部署和调用
ClickOnce 是一种部署技术,使用它可以用来进行应用程序的自动更新,也可以使用在浏览器中直接调用部署好的应用程序。
227 0
|
运维 安全 NoSQL
如何使用官方最新源代码部署yapi?
我们之前使用的yapi 1.9.2,存在高危漏洞,攻击者可利用该漏洞在目标服务器上执行任意代码,导致服务器被攻击者控制,植入木马或挖矿病毒。通过目前网络上给出的安全解决方案,总感觉解决的不彻底,yapi 官方仓库已经修复了沙箱提权的问题,我尝试使用官方最新源代码部署yapi,遇到好多问题,顺手记录下来,无论部署新环境或者升级新版本,日后方便自己回顾或者他人参考。
1218 0
如何使用官方最新源代码部署yapi?
|
数据可视化 Linux C语言
xmake v2.1.9版本发布,增加可视化图形菜单配置
此版本主要增加xmake f --menu实现用户自定义图形菜单配置,界面风格类似linux的make menuconfig: [图片上传失败…(image-505bc0-1517795319124)] 更多使用说明,请阅读:文档手册。
1267 0
|
Windows 开发工具 Linux