Qt 之 QFileSystemWatcher用法(监控目录和文件变更)

概述

QFileSystemWatcher类提供用于监控文件和目录进行修改的接口,通过观察指定路径的列表来监视文件系统对文件和目录的更改。

调用addPath()来观察特定的文件或目录。可以使用addPaths()函数添加多个路径。可以使用removePath()和removePaths()函数删除现有路径。

QFileSystemWatcher检查添加到它的每个路径。可以使用files()函数和使用directories()函数的目录来访问已添加到QFileSystemWatcher的文件。

当文件已被修改、重命名或从磁盘中删除会发出fileChanged信号。类似地,directoryChanged()信号在目录或其内容被修改或删除时发出。请注意,QFileSystemWatcher会在文件被重命名或从磁盘中删除后停止监视文件,以及从磁盘删除文件后停止监视文件。

备注:

  • 在运行Linux内核而不支持inotify的系统上,包含受监视路径的文件系统无法卸载。

  • 监视修改文件和目录的行为会消耗系统资源。这意味着同时监视的文件和目录数量有限制。默认情况下,某些系统将打开的文件描述符的数量限制为256。也就是说进程尝试向文件系统监视器添加多于256个文件或目录,则addPath()和addPaths()将会失败。另外请注意,除了被监视文件的文件描述符外,进程还可以打开其他文件描述符,并且这些其他打开的描述符也会计入总数中。而macOS使用不同的后端,所以不会遇到这个问题。

应用场景

该类可以用到的场景主要是针对需要对某个目录的文件进行及时监控的时候,例如开发一个展示本地文件的程序,那么在目录有文件发生变化时,可以通过QFileSystemWatcher来监控并及时刷新程序中的文件信息。再比如,自定义一个打开文件目录的窗口时,如果目录中文件变化,也可以通过该类监视并实时刷新目录文件等等。

成员函数说明

  • bool addPath(const QString &path)
    如果路径存在,则向文件系统观察器添加路径。如果该路径不存在,或者文件系统监视器已在监视路径,则不会添加该路径。
    如果路径指定了一个目录,当路径被修改或从磁盘移除时,directoryChanged()信号将被发出; 否则当修改,重命名或删除路径时,会发出fileChanged()信号。
    失败的原因通常取决于系统,但可能包括资源不存在,访问失败或总计数限制。
    注意:可以同时监视的文件和目录数量可能受系统限制。如果达到此限制,则不会监视路径,并返回false。

  • QStringList addPaths(const QStringList &paths)
    增加了在每个路径的路径到文件系统观察。如果它们不存在,或者它们已经被文件系统监视器监视,则不会添加路径。
    注意:可以同时监视的文件和目录数量可能受系统限制。如果达到此限制,则不会监视超出的路径,并且它们将被添加到返回的QStringList中。

  • QStringList directories() const
    返回正在监视的目录的路径列表。

  • QStringList files() const
    返回正在监视的文件的路径列表。

  • bool removePath(const QString &path)
    从文件系统观察器中删除指定的路径。
    如果成功移除,则返回true。
    移除失败的原因通常取决于系统,但可能是由于路径已被删除。

  • QStringList removePaths(const QStringList &paths)
    从文件系统观察器中删除指定的路径。

信号

  • void directoryChanged(const QString &path)
    当修改指定路径的目录时(例如,添加或删除文件时)或从磁盘中删除该目录时,会发出此信号。请注意,如果在短时间内发生多处更改,某些更改可能不会发出此信号。但是,更改顺序的最后更改将始终生成此信号。
    注意:这是一个私有信号。它可以用于信号连接,但不能由用户发射。

  • void fileChanged(const QString &path)
    当指定路径中的文件被修改,重命名或从磁盘中移除时,将发出此信号。
    注意:这是一个私有信号。它可以用于信号连接,但不能由用户发射。

示例

写了一个非常简单的示例,主要展示QFileSystemWatcher的用法以及实际效果。

Widget::Widget(QWidget *parent)
    : QWidget(parent)
{
    m_fileSystemWatcher = new QFileSystemWatcher(this);
    m_fileSystemWatcher->addPath(QStandardPaths::writableLocation(QStandardPaths::HomeLocation));
    connect(m_fileSystemWatcher,&QFileSystemWatcher::fileChanged,this,[=](const QString &path){
        qDebug() << __FUNCTION__ << "fileChanged path = " << path;
    });
    connect(m_fileSystemWatcher,&QFileSystemWatcher::directoryChanged,this,[=](const QString &path){
        qDebug() << __FUNCTION__ << "directoryChanged path = " << path;
    });
}

Widget::~Widget()
{
    if(m_fileSystemWatcher){
        delete m_fileSystemWatcher;
        m_fileSystemWatcher = Q_NULLPTR;
    }
}

当我在 home 目录下新建文件、对文件重命名、修改文件等操作时,程序输出如下:

operator() fileChanged path =  "/Users/luoyayun361"

说明已经监控到目录中文件的变化。
这里只是一个非常简单的示例展示最基本的用法。其实可以将该类封装得更完善一些,比如目录名变更过后重新添加监视、新建文件后增加监视等等操作。
可以参考这位大神写的示例:Qt之QFileSystemWatcher,比较有借鉴意义。

参考资料:
http://doc.qt.io/qt-5/qfilesystemwatcher.html
https://blog.csdn.net/liang19890820/article/details/51849252
https://blog.csdn.net/king523103/article/details/49452073

阅读更多
版权声明: https://blog.csdn.net/luoyayun361/article/details/80345318
个人分类: Qt
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭
关闭