QFtp源码学习及目录下载

Posted 2021-10-08 zhoutk

背景

需要在QT5中进行FTP文件下载，并需要支持整目录下载，经过对比选择，最后决定使用Qt4中的QFtp来完成我们的需求。因此决定学习源码，看清结构，做到能真正解决所要面对的问题。

分解源码

Qftp一共只有四个文件，主要文件是qftp.cpp，这个文件中，有太多的类，首先按类分解到各自文件中，这样利用官方的示例代码，跑起来后，可以方便的查看代码。

类说明

• class QFtpCommand : 此类是对FTP命令的封装，将命令与QIODevice设备关联起来，并返回一个唯一的标识ID。
• class QFtpPI : 此类是对FTP协议的封装，processReply是主要函数，应答服务端响应。
• class QFtpDTP : 此类是数据操作封装，数据读取、解析、存储都是在此类中处理。
• class QFtpPrivate : 此类是QFtp的实际操作类，被组合到QFtp类中，是逻辑处理中心。
• class QFtp : 此类是外壳，用户直接面对。
• class QUrlInfo : 此为信息类，存储接收到的每一条文件数据信息。

运行流程

所有的客户端命令被压入到命令堆栈。一个命令运行有两个入口：一是命令被压入堆栈时，若堆栈中只有一条命令，即被运行；二是作响应服务端响应时，类型为idle或not waiting。
每个命运被构造时，都会返回唯一ID，这是很重要的一点，因为命令大多关联着一本地IO设备，在清理IO时，要注意与命令对应，因为所有的操作都是异步的。

改造list响应

QFtp列当前目录的原有逻辑是取一条数据就发送一条文件或目录的消息，这样在我们连续遍历目录时，无法分清楚是哪个目录下的数据，无法进行正确的递归。这样改造效率应该会好一些且完全控制整个目录的显示，比如，目录显示在上面。当然也可以将递归放到commandFinished消息响应中去。

QFtpDTP::socketReadyRead() - 修改读取目录列表时的信号发送方式

if (pi->currentCommand().startsWith(QLatin1String("LIST"))) {
        QVector<QUrlInfo> infos;                        //增加vector来存储整个目录信息
        while (socket->canReadLine()) {
            QUrlInfo i;
            QByteArray line = socket->readLine();
            if (parseDir(line, QLatin1String(""), &i)) {
                infos.push_back(i);
                //emit listInfo(i);                     //原来在循环内，读一条数据发送一个listInfo信号
            }
            else {
                if (line.endsWith("No such file or directory\\r\\n"))
                    err = QString::fromLatin1(line);
            }
        }
        emit listInfos(infos);                          //改为在循环外发送新增的listInfos信号
    }

FtpWindow::addToList(const QVector<QUrlInfo>& urlInfos) - listInfos响应修改

    for (int i = 0; i < urlInfos.size(); i++)
    {
        QTreeWidgetItem* item = new QTreeWidgetItem;
        QUrlInfo urlInfo = urlInfos[i];
        if (urlInfo.name().compare(".") != 0) {
            item->setText(0, urlInfo.name().toLatin1());
            item->setText(1, QString::number(urlInfo.size()));
            item->setText(2, QString::number(urlInfo.isDir()));
            item->setText(3, urlInfo.owner());
            item->setText(4, urlInfo.group());
            item->setText(5, urlInfo.lastModified().toString("MMM dd yyyy"));
            QPixmap pixmap(urlInfo.isDir() ? ":/images/dir.png" : ":/images/file.png");
            item->setIcon(0, pixmap);
            isDirectory[urlInfo.name()] = urlInfo.isDir();
            fileList->addTopLevelItem(item);
        }
    }

目录下载

将FtpWindow::downloadFile() slot分解成两个函数，增加downAllFile(QString rootDir)来完成目录递归。

void FtpWindow::downloadFile()
{
    files.clear();      //初始化本地设备
    downDirs.clear();   //清空需要下载的目录堆栈

    downAllFile(currentPath);   //下载具体操作，另一个入口在list的响应中
    showProgressDialog();       //进度条显示
}

下载的真实操作函数

void FtpWindow::downAllFile(QString rootDir) {
    QString thisRoot(rootDir + "/");        //要下载的父目录
    QList<QTreeWidgetItem*> selectedItemList = fileList->selectedItems();
    for (int i = 0; i < selectedItemList.size(); i++)
    {
        QString fileName = selectedItemList[i]->text(0);
        if (isDirectory.value(fileName)) {      //若是子目录，组合完成的目录，压入待下载目录堆栈
            if(fileName != "..")
                downDirs.push(thisRoot + fileName);
        }
        else {
            downloadTotalBytes += selectedItemList[i]->text(1).toLongLong();    //统计需要下载的字节量
            ...
            QFile* file = new QFile(dirTmp.append("/").append(fileName));
            //文件下载请求，是异步操作
            int id = ftp->get(QString::fromLatin1((selectedItemList[i]->text(0)).toStdString().c_str()), file);
            files.insert(id, file);     //本地IO设备与其命令绑定并存储
        }
    }
    if (downDirs.size() > 0) {      //待下载目录堆栈不空，处理一条
        enterSubDir = true;         //表示正在下载目录
        QString nextDir(downDirs.pop());  //取需要处理的下一个目录
        ftp->cd(nextDir);                 //切换到这个目录
        currentDownPath = nextDir;
        ftp->list();                        //列目录，在其响应中将再递归调用本函数~~~~
    }
}

list响应的递归处理部分

    if (!enterSubDir) {     //下载的文件中没有目录
        ...     
    }
    else {                              //正处理于目录下载中
        fileList->selectAll();          //选中列表中所有
        downAllFile(currentDownPath);   //递归调用下载处理函数
    }

项目地址

https://github.com/zhoutk/qtDemo

命令行编译

git clone https://github.com/zhoutk/qtDemo
cd qtDemo/ftpClient & mkdir build & cd build
cmake ..
cmake --build .      

编译时注意：cmake默认为x86架构，需要与你安装的Qt版本对应；编译好了，运行前，请注意目录结构是否正确。

小结

我选择的这种目录下载方式比较麻烦，没有放到后台再开一个进程去处理，试图做整体考虑，且整个运行过程都是异步的，调试也比较难，其中进度条控件控制还有些坑，需要小心处理。过程艰难，收获颇多。