基于Qt 文本读写(QFile/QTextStream/QDataStream)实现

321 阅读8分钟

image.png

在很多时候我们需要读写文本文件进行读写,比如写个 Mp3 音乐播放器需要读 Mp3 歌词里的文本,比如修改了一个 txt 文件后保存,就需要对这个文件进行读写操作。本章介绍简单的文本文件读写,内容精简,让大家了解文本读写的基本操作。

QFile 读写文本

QFile 类提供了读取和写入文件的接口。在嵌入式里如果需要读写文件,最简单的方法就是用 QFile, QFile 来读写 Linux 下的字符设备(可把字符设备当作一个文本处理,linux 下一切皆文件),虽然只是写‘0’或‘1’,但也是对文件(文本)的读写了。QFile 是一个读写文本、二进制文件和资源的 I/O 设备。QFile 可以自己使用,也可以更方便地与 QTextStream 或 QDataStream 一起使用。

文件名通常在构造函数中传递,但它可以在任何时候使用 setFileName()设置。不支持使用其他分隔符(例如'')。所以在 Windows、 Linux 或者 Mac 里文件的路径都是用'/'。不能看到Windows 的路径是'',我们就可以在写入的文件路径里添加这个''。不管操作系统是什么,QFile的文件分隔符都是'/'。

可以使用 exists()检查文件是否存在,并使用 remove()删除文件。(更高级的文件系统相关操作由 QFileInfo 和 QDir 提供。)用 open()打开文件,用 close()关闭文件,用 flush()刷新文件。通常使用 QDataStream 或 QTextStream 读写数据,但也可以调用 QIODevice 继承的函数 read()、

readLine()、readAll()、write()。QFile 还继承 getChar()、putChar()和 ungetChar(),它们一次只处理一个字符。文件的大小由 size()返回。可以使用 pos()获取当前文件位置,也可以使用 seek()移动到新的文件位置。如果已经到达文件的末尾,则 atEnd()返回 true。

QFile::open()函数打开文件时需要传递 QIODevice::OpenModeFlag 枚举类型的参数,决定

文件以什么方式打开,QIODevice::OpenModeFlag 类型的主要取值如下:

  • QIODevice::ReadOnly:以只读方式打开文件,用于载入文件。
  • QIODevice::WriteOnly:以只写方式打开文件,用于保存文件。
  • QIODevice::ReadWrite:以读写方式打开。
  • QIODevice::Append:以添加模式打开,新写入文件的数据添加到文件尾部。
  • QIODevice::Truncate:以截取方式打开文件,文件原有的内容全部被删除。
  • QIODevice::Text:以文本方式打开文件,读取时“\n”被自动翻译为换行符,写入时字符串结束符会自动翻译为系统平台的编码,如 Windows 平台下是“\r\n”。 这些取值可以组合,例如 QIODevice::ReadOnly | QIODevice::Text 表示以只读和文本方式打开文件。

使用 QFile 对一个文本文件的操作流程是以下这样的。

应用实例

在头文件“mainwindow.h”具体代码如下。

1 #ifndef MAINWINDOW_H
2 #define MAINWINDOW_H
3
4 #include <QMainWindow>
5 #include <QTextEdit>
6 #include <QFile>
7 #include <QVBoxLayout>
8 #include <QHBoxLayout>
9 #include <QPushButton>
10
11 class MainWindow : public QMainWindow
12 {
13 Q_OBJECT
14
15 public:
16 MainWindow(QWidget *parent = nullptr);
17 ~MainWindow();
18
19 private:
20 /* 用于读取文件后显示 */
21 QTextEdit *textEdit;
22
23 /* QFile 类型对象 */
24 QFile file;
25
26 /* 水平布局 */
27 QHBoxLayout *hBoxLayout;
28
29 /* 垂直布局 */30 QVBoxLayout *vBoxLayout;
​
3132 /* 水平布局 Widget */33 QWidget *hWidget;
​
3435 /* 垂直布局 Widget */36 QWidget *vWidget;
​
3738 /* 打开文件按钮 */39 QPushButton *openPushButton;
​
4041 /* 关闭文件按钮 */42 QPushButton *closePushButton;
​
4344 private slots:
​
4546 /* 打开文本文件 */47 bool openFile();
​
4849 /* 关闭文本文件 */50 void closeFile();
​
51 };
​
52 #endif // MAINWINDOW_H

在源文件“mainwindow.cpp”具体代码如下。

#include "mainwindow.h"
 #include <QFileDialog>
 #include <QDebug>
1 MainWindow::MainWindow(QWidget *parent)
2 : QMainWindow(parent)
3 {
4 /* 设置窗口的位置与大小 */
5 this->setGeometry(0, 0, 800, 480);
6 
7 /* 布局设置 */
8 textEdit = new QTextEdit();
9 vBoxLayout = new QVBoxLayout();
10 hBoxLayout = new QHBoxLayout();
11 vWidget = new QWidget();
12 hWidget = new QWidget();
13 openPushButton = new QPushButton();
14 closePushButton = new QPushButton();
15
16 /* 设置两个按钮的大小 */
17 openPushButton->setMinimumHeight(50);
18 openPushButton->setMaximumWidth(120);
19 closePushButton->setMinimumHeight(50);
20 closePushButton->setMaximumWidth(120);
21
22 /* 设置两个按钮的文本 */
23 openPushButton->setText("打开");
24 closePushButton->setText("关闭");
25
26 /* 设置关闭按钮为不可用属性,需要打开文件才设置为可用属性 */
27 closePushButton->setEnabled(false);
28
29 /* 水平布局 */
30 hBoxLayout->addWidget(openPushButton);
31 hBoxLayout->addWidget(closePushButton);
32 hWidget->setLayout(hBoxLayout);
33
34 /* 垂直布局 */
35 vBoxLayout->addWidget(textEdit);
36 vBoxLayout->addWidget(hWidget);
37 vWidget->setLayout(vBoxLayout);
38
39 /* 居中 */
40 setCentralWidget(vWidget);
41
42 /* 信号槽连接 */
43 connect(openPushButton, SIGNAL(clicked()),
44 this, SLOT(openFile()));
45 connect(closePushButton, SIGNAL(clicked()),
46 this, SLOT(closeFile()));
47 }
​
48
49 MainWindow::~MainWindow()
50 {
51 }
52
53 bool MainWindow::openFile()
54 {
55 /* 获取文件的路径 */
56 QString fileName = QFileDialog::getOpenFileName(this);
57
58 /* 指向文件 */
59 file.setFileName(fileName);
60
61 /* 判断文件是否存在 */
62 if (!file.exists())
63 return false;
64
65 /* 以读写的方式打开 */
66 if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
67 return false;
68
69 /* 读取文本到 textEdit */
70 textEdit->setPlainText(file.readAll());
71
72 /* 设置打开按钮不可用,需要关闭再打开 */
73 openPushButton->setEnabled(false);
74
75 /* 设置关闭按钮为可用属性 */
76 closePushButton->setEnabled(true);
77
78 /* 关闭文件 */
79 file.close();
80
81 return true;
82 }
83
84 void MainWindow::closeFile()
85 {
86 /* 检测打开按钮是否可用,不可用时,说明已经打开了文件 */
87 if (!openPushButton->isEnabled()) {
88 /* 获取 textEdit 的文本内容 */
89 QString str = textEdit->toPlainText();
90
91 /* 以只读的方式打开 */92 if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
​
93 return;
​
9495 /* 转换为字节数组 */96 QByteArray strBytes = str.toUtf8();
​
9798 /* 写入文件 */99 file.write(strBytes, strBytes.length());
​
100101 /* 清空 textEdit 的显示内容 */102 textEdit->clear();
​
103104 /* 关闭文件 */105 file.close();
​
106107 /* 重新设置打开和关闭按钮的属性 */108 openPushButton->setEnabled(true);
​
109 closePushButton->setEnabled(false);
​
110 }
​
111 }

程序运行效果

点击打开。

打开后,文本的内容如下,可以进行修改,修改后点击关闭就会写入到此文件里。本例仅仅用两个按钮和一个文本编辑框完成,内容简洁易懂。但是在实际项目里不是用 QPushButton来做打开文件和关闭文件的,一般设计于在菜单栏里用 QAction 来做。包括添加复制、粘贴、另存为、关闭、等等。可以仿照 Windows 里的记事本,用 Qt 写一个类似的软件完全可以。

QTextStream 读写文本

QTextStream 类为读写文本提供了一个方便的接口,常与 QFile 结合使用。QTextStream 可以在 QIODevice、QByteArray 或 QString 上操作。使用 QTextStream 的流操作符,您可以方便地读写单词、行和数字。为了生成文本,QTextStream 支持字段填充和对齐的格式化选项,以

及数字的格式化。看到 Stream 这个名词就知道,它与流操作有关,那么我们可以使用 C++的操作符“<<”和“>>”(流提取运算符和流插入运算符)进行操作流了。

应用实例

例 qtextstream,文本流读写文本(难度:简单)。QTextStream 的例子与 QFile 的一样,只是在 QFile 的例子里加入了 QTextStream。下面只写出不同部分的代码。详细直接打开项目查看。

在源文件“mainwindow.cpp”具体代码如下。不同的地方已经用红色字体标出。

53 bool MainWindow::openFile()
54 {
55 /* 获取文件的路径 */
56 QString fileName = QFileDialog::getOpenFileName(this);
57
58 /* 指向文件 */
59 file.setFileName(fileName);
60
61 /* 判断文件是否存在 */
62 if (!file.exists())
63 return false;
64
65 /* 以读写的方式打开 */
66 if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
67 return false;
68
69 /* 使用文本流读取文件 */
70 QTextStream stream(&file);
71
72 /* 读取文本到 textEdit */
73 textEdit->setPlainText(stream.readAll());
74
75 /* 设置打开按钮不可用,需要关闭再打开 */
76 openPushButton->setEnabled(false);
77
78 /* 设置关闭按钮为可用属性 */
79 closePushButton->setEnabled(true);
8081 /* 关闭文件 */82 file.close();
​
8384 return true;
​
85 }
​
8687 void MainWindow::closeFile()
​
88 {
​
89 /* 检测打开按钮是否可用,不可用时,说明已经打开了文件 */90 if (!openPushButton->isEnabled()) {
​
9192 /* 以只读的方式打开 */93 if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
​
94 return;
​
9596 /* 用文本流读取文件 */97 QTextStream stream(&file);
​
9899 /* 获取 textEdit 的文本内容,转为字符串 */100 QString str = textEdit->toPlainText();
​
101102 /* 使用流提取运算符,写入文本流 */103 stream<<str;
​
104105 /* 清空 textEdit 的显示内容 */106 textEdit->clear();
​
107108 /* 关闭文件 */109 file.close();
​
110111 /* 重新设置打开和关闭按钮的属性 */112 openPushButton->setEnabled(true);
​
113 closePushButton->setEnabled(false);
​
114 }
​
115 }

程序运行效果

与上一小节一样。使用 QFile 与 QTextStream 感觉例子看上去没区别。主要是 QTextStream 还支持字段填充和对齐的格式化选项,例子没有体现出来而已,等我们用到一些特性时还是有区别的。

文件操作比较简单,就不再过多讲解。