第29篇 Qt5之XML（三）Qt中的SAX

yafeilinux

Qt中的SAX

版权声明

---

该文章原创于Qt开源社区（www.qter.org），作者yafeilinux，转载请注明出处！

导语

---

我们前面讲述了用DOM的方法对XML文档进行操作，DOM使用起来很灵活，但是这样也就使得编程变得复杂了些，而且前面也提到过，DOM需要预先把整个XML文档都读入内存，这样就使得它不适合处理较大的文件。下面我们讲述另一种读取XML文档的方法，即SAX 。是的，如果你只想读取并显示整个XML文档，那么SAX是很好的选择，因为它提供了比DOM更简单的接口，并且它不需要将整个XML文档一次性读入内存，这样便可以用来读取较大的文件。我们对SAX不再进行过多的介绍，因为不需要任何基础，你就可以掌握我们下面要讲的内容。如果大家对SAX有兴趣，可以到网上查阅相关资料。

环境：Windows 7 + Qt 5.8.0（包含Qt Creator 4.2.1）

目录

---

一、解析器解析流程

二、使用SAX读取文档

正文

---

一、解析器解析流程

       在Qt的QtXml模块中提供了一个QXmlSimpleReader的类，它便是基于SAX的XML解析器。这个解析器是基于事件的，但这些事件由它们自身进行关联，我们并不需要进行设置。我们只需知道，当解析器解析一个XML的元素时，就会执行相应的事件，我们只要重写这些事件处理函数，就能让它按照我们的想法进行解析。

比如要解析下面的元素：

1. <title>Qt</title>

复制代码

解析器会依次调用如下事件处理函数：startElement()，characters()，endElement()。我们可以在startElement()中获得元素名（如“title”）和属性，在characters()中获得元素中的文本（如“Qt”），在endElement()中进行一些结束读取该元素时想要进行的操作。而所有的这些事件处理函数我们都可以通过继承QXmlDefaultHandler类来重写。

二、使用SAX读取文档

1.新建其他项目分类中的空的Qt项目Empty qmakeProject，项目名称为mySAX。

2.完成后向项目中添加新的C++类，类名为MySAX，基类填写QXmlDefaultHandler。

3.然后再添加一个main.cpp文件。

4.先打开mySAX.pro文件，添加一行代码：QT+= xml widgets，然后保存该文件。

5.打开mysax.h文件，将其内容更改为：

1. #ifndef MYSAX_H
   
2. #define MYSAX_H
   
3. 
   
4. #include <QXmlDefaultHandler>
   
5. class QListWidget;
   
6. 
   
7. class MySAX : public QXmlDefaultHandler
   
8. {
   
9. public:
   
10.     MySAX();
    
11.     ~MySAX();
    
12.     bool readFile(const QString &fileName);
    
13. protected:
    
14. bool startElement(const QString &namespaceURI,
    
15. const QString &localName,
    
16.                           const QString &qName,
    
17. const QXmlAttributes &atts);
    
18. bool endElement(const QString &namespaceURI,
    
19. const QString &localName,
    
20.                     const QString &qName);
    
21.     bool characters(const QString &ch);
    
22.     bool fatalError(const QXmlParseException &exception);
    
23. private:
    
24.     QListWidget *list;
    
25.     QString currentText;
    
26. };
    
27. 
    
28. #endif // MYSAX_H

复制代码

     这里主要是重新声明了QXmlDefaultHandler类的startElement()、endElement()、characters()和fatalError()几个函数，readFile()函数用来读入XML文件，QListWidget部件用来显示解析后的XML文档内容，currentText字符串变量用于暂存字符数据。

6.打开mysax.cpp文件，将其内容修改如下：

1. #include "mysax.h"
   
2. #include <QtXml>
   
3. #include <QListWidget>
   
4. 
   
5. MySAX::MySAX()
   
6. {
   
7.     list = new QListWidget;
   
8.     list->show();
   
9. }
   
10. 
    
11. MySAX::~MySAX()
    
12. {
    
13.     delete list;
    
14. }
    
15. 
    
16. bool MySAX::readFile(const QString &fileName)
    
17. {
    
18.     QFile file(fileName);
    
19.    
    
20.     // 读取文件内容
    
21.     QXmlInputSource inputSource(&file);
    
22.    
    
23.     // 建立QXmlSimpleReader对象
    
24.     QXmlSimpleReader reader;
    
25.    
    
26.     // 设置内容处理器
    
27.     reader.setContentHandler(this);
    
28.    
    
29.     // 设置错误处理器
    
30.     reader.setErrorHandler(this);
    
31.    
    
32.     // 解析文件
    
33.     return reader.parse(inputSource);
    
34. }
    
35. 
    
36. // 已经解析完一个元素的起始标签
    
37. bool MySAX::startElement(const QString &namespaceURI,
    
38. const QString &localName,
    
39.                          const QString &qName,
    
40. const QXmlAttributes &atts)
    
41. {
    
42.     if (qName == "library")
    
43.         list->addItem(qName);
    
44.     else if (qName == "book")
    
45.         list->addItem("    " + qName + atts.value("id"));
    
46.     return true;
    
47. }
    
48. 
    
49. // 已经解析完一块字符数据
    
50. bool MySAX::characters(const QString &ch)
    
51. {
    
52.     currentText = ch;
    
53.     return true;
    
54. }
    
55. 
    
56. // 已经解析完一个元素的结束标签
    
57. bool MySAX::endElement(const QString &namespaceURI,
    
58. const QString &localName,
    
59.                        const QString &qName)
    
60. {
    
61.     if (qName == "title" || qName == "author")
    
62.         list->addItem("        " + qName + " : " + currentText);
    
63.     return true;
    
64. }
    
65. 
    
66. // 错误处理
    
67. bool MySAX::fatalError(const QXmlParseException &exception)
    
68. {
    
69.     qDebug() << exception.message();
    
70.     return false;
    
71. }

复制代码

这里添加了几个函数的定义。在readFile()函数中，我们设置了文件的解析过程。Qt中提供了一个简单的XML解析器QXmlSimpleReader，它是基于SAX的。该解析器需要QXmlInputSource为其提供数据，QXmlInputSource会使用相应的编码来读取XML文档的数据。在进行解析之前，还需要使用setContentHandler()来设置事件处理器，使用setErrorHandler()来设置错误处理器，它们的参数使用了this，表明使用本类作为处理器，也就是在解析过程中出现的各种事件都会使用本类的startElement()等事件处理函数来进行处理，而出现错误时会使用本类的fatalError()函数来处理。最后，调用了parse()函数来进行解析，该函数会在解析成功时返回true，否则返回false。在后面的几个事件处理函数中，就是简单的将数据显示在QListWidget中。

7.最后打开main.cpp文件，添加如下内容：

1. #include "mysax.h"
   
2. #include <QApplication>
   
3. 
   
4. int main(int argc, char* argv[])
   
5. {
   
6.     QApplication app(argc, argv);
   
7.     MySAX sax;
   
8.     sax.readFile("../mySAX/my.xml");
   
9.     return app.exec();
   
10. }

复制代码

8.将前面第27篇建立的“my.xml”文件复制到我们的源码目录中，然后运行程序，效果如下图所示。

结语

---

可以看到使用SAX方法来解析XML文档比使用DOM方法要清晰很多，更重要的是它的效率要高很多，不过SAX方法只适用于读取XML文档。

源码下载：

返回主目录