欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

c#使用filesystemwatcher实时监控文件目录的添加和删除

程序员文章站 2023-12-21 12:11:16
首先,我们需要对.net提供的filesystemwatcher类有所了解。我有些懒,找了msdn对该类的描述。 filesystemwatcher类侦听文件系统更改通知...

首先,我们需要对.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);
                }

该程序实现了对文件目录下所有子目录和子文件的变化进行监控,并可通过filechangequeue属性访问文件变更消息,同时也可以设置其是否需要将数据持久化到磁盘文件中。

上一篇:

下一篇: