QT QXmlStreamReader

蔚落 2022-10-18 15:58 24阅读 0赞

### 概述 ###

QXmlStreamReader类提供了一个快速解析器，用于通过一个简单的流API读取格式良好的XML。  
      
    QXmlStreamReader是Qt自己的SAX解析器的更快、更方便的替代品(参见QXmlSimpleReader)。在某些情况下，对于使用DOM树的应用程序(请参阅QDomDocument)，它可能是一种更快、更方便的替代方法。QXmlStreamReader从QIODevice(参见setDevice())读取数据，或从原始QByteArray(参见addData())读取数据。  
      
    Qt提供QXmlStreamWriter用于编写XML。  
      
    流读取器的基本概念是将XML文档报告为标记流，类似于SAX。QXmlStreamReader和SAX之间的主要区别是如何报告这些XML标记。使用SAX，应用程序必须提供处理程序(回调函数)，以便在解析器方便的情况下从解析器接收所谓的XML事件。使用QXmlStreamReader，应用程序代码本身驱动循环，并在需要时从阅读器中一个接一个地提取令牌。这是通过调用readNext()来完成的，读取器从输入流中读取，直到完成下一个标记，此时返回tokenType()。然后可以使用一组方便的函数，包括isStartElement()和text()来检查令牌，以获得关于已读取内容的信息。这种提取方法的最大优点是可以使用它构建递归下降解析器，这意味着您可以轻松地将XML解析代码拆分为不同的方法或类。这使得在解析XML时很容易跟踪应用程序自己的状态。  
      
    QXmlStreamReader的典型循环是这样的:

QXmlStreamReader xml;
        ...
        while (!xml.atEnd()) {
              xml.readNext();
              ... // do processing
        }
        if (xml.hasError()) {
              ... // do error handling
        }

QXmlStreamReader是一个格式良好的XML 1.0解析器，它不包括外部解析实体。因此，只要没有发生错误，应用程序代码就可以确保流阅读器提供的数据满足W3C关于格式良好的XML的标准。例如，您可以确定所有标记确实是正确嵌套和关闭的，对内部实体的引用已经被正确的替换文本替换，属性已经根据DTD的内部子集被规范化或添加。

如果解析时发生错误，atEnd()和hasError()返回true, error()返回发生的错误。函数errorString()、lineNumber()、columnNumber()和characterOffset()用于构造适当的错误或警告消息。为了简化应用程序代码，QXmlStreamReader包含一个raiseError()机制，该机制允许您引发自定义错误，从而触发所描述的相同错误处理。  
      
    QXmlStream Bookmarks Example演示了如何使用递归下降技术使用流阅读器读取XML书签文件(XBEL)。

### 命名空间 ###

QXmlStream理解并解析XML名称空间。例如，对于StartElement, namespaceUri()返回元素所在的命名空间，而name()返回元素的本地名称。namespaceUri和name的组合唯一地标识一个元素。如果在阅读器解析的XML实体中没有声明名称空间前缀，则namespaceUri为空。  
      
    如果解析的XML数据没有根据XML规范使用名称空间，或者根本不使用名称空间，则可以使用元素的qualifiedName()。限定名是元素的前缀()，后跟冒号，再后跟元素的本地名()——与原始XML数据中出现的元素完全相同。因为namespaceUri到前缀的映射既不是唯一的，也不是通用的，所以对于符合名称空间的XML数据应该避免qualifiedName()。  
      
    为了解析使用未声明的名称空间前缀的独立文档，可以使用namespaceProcessing属性完全关闭名称空间处理。

### 增量的解析 ###

QXmlStreamReader是一个增量解析器。它可以处理文档不能一次性解析的情况，因为它是以块的形式到达的(例如，从多个文件，或通过网络连接)。当阅读器在完整的文档被解析之前用完数据时，它会报告一个PrematureEndOfDocumentError。当有更多数据到达时，无论是调用addData()还是通过网络设备()有更多数据可用，读取器将从PrematureEndOfDocumentError错误中恢复，并在下一次调用readNext()时继续解析新数据。  
      
    例如，如果您的应用程序使用网络访问管理器从网络读取数据，那么您将向该管理器发出网络请求并接收网络回复。由于QNetworkReply是一个QIODevice，您可以将它的readyRead()信号连接到一个自定义槽，例如，QNetworkAccessManager讨论中的代码片段中的slotReadyRead()。在这个槽中，使用readAll()读取所有可用数据，并使用addData()将其传递给XML流读取器。然后调用自定义解析函数，该函数从阅读器中读取XML事件。

### 性能和内存消耗 ###

QXmlStreamReader在设计上是内存保守的，因为它没有在内存中存储整个XML文档树，而只存储报告时的当前标记。此外，QXmlStreamReader避免了将XML文档映射到方便的Qt-ish API通常需要的许多小字符串分配。它通过将所有字符串数据报告为QStringRef而不是真正的QString对象来做到这一点。QStringRef是QString子字符串的一个薄包装器，它提供了一个没有内存分配和引用计数开销的QString API子集。在这些对象中调用toString()将返回一个等效的实际QString对象。