Qt 5.9 XML文件寫入指南

---

在Qt 5.9中，有多種方法可以編寫XML文件。下面我將介紹三種主要方法，并提供完整的代碼示例和最佳實踐。

三種XML寫入方法對比

方法	優點	缺點	適用場景
QXmlStreamWriter	高效、內存占用低	無樹形結構	大型XML文件
QDomDocument	樹形結構、易操作	內存占用高	小型XML文件、需要頻繁修改
Qt XML Patterns	XQuery支持	復雜、學習曲線陡	需要XQuery/XPath

方法1：使用QXmlStreamWriter（推薦）

這是最高效的方法，特別適合大型XML文件：

#include <QXmlStreamWriter>
#include <QFile>
#include <QDebug>
#include <QDateTime>bool writeXmlWithStreamWriter(const QString &filename)
{// 使用QSaveFile確保原子寫入（防掉電丟失）QSaveFile file(filename);if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {qWarning() << "無法打開文件:" << file.errorString();return false;}QXmlStreamWriter xml(&file);xml.setAutoFormatting(true);  // 自動格式化xml.setAutoFormattingIndent(2); // 縮進2個空格// 開始文檔xml.writeStartDocument();// 根元素xml.writeStartElement("Data");xml.writeAttribute("version", "1.0");xml.writeAttribute("created", QDateTime::currentDateTime().toString(Qt::ISODate));// 寫入注釋xml.writeComment("這是一個使用QXmlStreamWriter生成的XML文件");// 書籍信息xml.writeStartElement("Books");for (int i = 1; i <= 3; ++i) {xml.writeStartElement("Book");xml.writeAttribute("id", QString::number(i));xml.writeTextElement("Title", QString("Qt編程指南 %1").arg(i));xml.writeTextElement("Author", QString("作者 %1").arg(i));xml.writeTextElement("Year", QString::number(2015 + i));xml.writeTextElement("Price", QString::number(35.5 + i));// 添加CDATA部分xml.writeStartElement("Description");xml.writeCDATA(QString("<p>這是第%1本書的描述，包含<strong>特殊字符</strong></p>").arg(i));xml.writeEndElement(); // Descriptionxml.writeEndElement(); // Book}xml.writeEndElement(); // Books// 用戶信息xml.writeStartElement("Users");xml.writeEmptyElement("User"); // 空元素xml.writeAttribute("id", "1001");xml.writeAttribute("name", "張三");xml.writeAttribute("role", "管理員");xml.writeEndElement(); // Users// 結束文檔xml.writeEndElement(); // Dataxml.writeEndDocument();// 提交文件（原子操作）if (!file.commit()) {qCritical() << "文件提交失敗:" << file.errorString();return false;}qDebug() << "XML文件已成功寫入:" << filename;return true;
}

方法2：使用QDomDocument（DOM方式）

適合小型XML文件或需要頻繁修改的場景：

#include <QDomDocument>
#include <QFile>
#include <QDebug>bool writeXmlWithDomDocument(const QString &filename)
{// 創建DOM文檔QDomDocument doc("XML_DOC");// 創建處理指令QDomProcessingInstruction pi = doc.createProcessingInstruction("xml", "version=\"1.0\" encoding=\"UTF-8\"");doc.appendChild(pi);// 創建根元素QDomElement root = doc.createElement("Data");root.setAttribute("version", "1.0");doc.appendChild(root);// 創建注釋QDomComment comment = doc.createComment("這是一個使用QDomDocument生成的XML文件");root.appendChild(comment);// 創建書籍元素QDomElement booksElement = doc.createElement("Books");root.appendChild(booksElement);for (int i = 1; i <= 3; ++i) {QDomElement bookElement = doc.createElement("Book");bookElement.setAttribute("id", i);booksElement.appendChild(bookElement);QDomElement title = doc.createElement("Title");title.appendChild(doc.createTextNode(QString("Qt高級編程 %1").arg(i)));bookElement.appendChild(title);QDomElement author = doc.createElement("Author");author.appendChild(doc.createTextNode(QString("專家 %1").arg(i)));bookElement.appendChild(author);QDomElement year = doc.createElement("Year");year.appendChild(doc.createTextNode(QString::number(2018 + i)));bookElement.appendChild(year);}// 創建用戶元素QDomElement usersElement = doc.createElement("Users");root.appendChild(usersElement);QDomElement userElement = doc.createElement("User");userElement.setAttribute("id", "1002");userElement.setAttribute("name", "李四");userElement.setAttribute("role", "編輯");usersElement.appendChild(userElement);// 寫入文件QSaveFile file(filename);if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {qWarning() << "無法打開文件:" << file.errorString();return false;}// 使用縮進格式輸出QTextStream out(&file);out.setCodec("UTF-8");doc.save(out, 2); // 縮進2個空格if (!file.commit()) {qCritical() << "文件提交失敗:" << file.errorString();return false;}qDebug() << "XML文件已成功寫入:" << filename;return true;
}

方法3：使用Qt XML Patterns（XQuery）

適合需要復雜XML轉換的場景：

#include <QXmlQuery>
#include <QXmlFormatter>
#include <QBuffer>
#include <QFile>
#include <QDebug>bool writeXmlWithXmlPatterns(const QString &filename)
{// 創建XML查詢QXmlQuery query(QXmlQuery::XQuery10);// 定義XQuery生成XMLQString xquery = R"(declare variable $books external;<Data version="1.0"><Books>{for $book in $books/Bookreturn $book}</Books><Users><User id="1003" name="王五" role="讀者"/></Users></Data>)";// 綁定變量QBuffer booksData;booksData.open(QIODevice::ReadWrite);booksData.write(R"(<Books><Book id="4"><Title>Qt多線程編程</Title><Author>趙六</Author><Year>2022</Year></Book><Book id="5"><Title>QML高級技巧</Title><Author>錢七</Author><Year>2023</Year></Book></Books>)");booksData.seek(0);query.bindVariable("books", &booksData);query.setQuery(xquery);if (!query.isValid()) {qWarning() << "無效的XQuery";return false;}// 執行查詢并格式化輸出QBuffer outputBuffer;outputBuffer.open(QIODevice::ReadWrite);QXmlFormatter formatter(query, &outputBuffer);formatter.setIndentationDepth(2);if (!query.evaluateTo(&formatter)) {qWarning() << "XQuery執行失敗";return false;}outputBuffer.seek(0);// 寫入文件QSaveFile file(filename);if (!file.open(QIODevice::WriteOnly)) {qWarning() << "無法打開文件:" << file.errorString();return false;}file.write(outputBuffer.data());if (!file.commit()) {qCritical() << "文件提交失敗:" << file.errorString();return false;}qDebug() << "XML文件已成功寫入:" << filename;return true;
}

使用示例

#include <QCoreApplication>int main(int argc, char *argv[])
{QCoreApplication a(argc, argv);QString filename = "example.xml";// 方法1：使用QXmlStreamWriterif (writeXmlWithStreamWriter("stream_writer.xml")) {qDebug() << "方法1成功";}// 方法2：使用QDomDocumentif (writeXmlWithDomDocument("dom_document.xml")) {qDebug() << "方法2成功";}// 方法3：使用Qt XML Patternsif (writeXmlWithXmlPatterns("xml_patterns.xml")) {qDebug() << "方法3成功";}return a.exec();
}

最佳實踐

1. 文件安全寫入

   • 使用QSaveFile而不是QFile，確保寫入操作的原子性
   • 避免寫入過程中斷電導致文件損壞

2. 編碼處理

   // 確保使用UTF-8編碼
   xml.writeStartDocument("1.0", true); // 第二個參數表示使用UTF-8
   

3. 錯誤處理

   if (xml.hasError()) {qWarning() << "XML寫入錯誤:" << xml.errorString();
   }
   

4. 驗證XML結構

   // 在開發階段驗證XML
   #include <QXmlSchemaValidator>bool validateXml(const QString &filename, const QString &schemaFile) {QXmlSchema schema;if (!schema.load(schemaFile)) return false;QXmlSchemaValidator validator(schema);return validator.validate(filename);
   }
   

5. 性能優化

   • 對于大型文件，使用QXmlStreamWriter
   • 避免在循環中頻繁打開/關閉文件
   • 使用緩存機制批量寫入數據

生成的XML示例

<?xml version="1.0" encoding="UTF-8"?>
<Data version="1.0" created="2023-08-15T14:30:45Z"><!--這是一個使用QXmlStreamWriter生成的XML文件--><Books><Book id="1"><Title>Qt編程指南 1</Title><Author>作者 1</Author><Year>2016</Year><Price>36.5</Price><Description><![CDATA[<p>這是第1本書的描述，包含<strong>特殊字符</strong></p>]]></Description></Book><Book id="2"><Title>Qt編程指南 2</Title><Author>作者 2</Author><Year>2017</Year><Price>37.5</Price><Description><![CDATA[<p>這是第2本書的描述，包含<strong>特殊字符</strong></p>]]></Description></Book><Book id="3"><Title>Qt編程指南 3</Title><Author>作者 3</Author><Year>2018</Year><Price>38.5</Price><Description><![CDATA[<p>這是第3本書的描述，包含<strong>特殊字符</strong></p>]]></Description></Book></Books><Users><User id="1001" name="張三" role="管理員"/></Users>
</Data>

常見問題解決

1. 中文亂碼問題

   // 確保使用UTF-8編碼
   QTextCodec::setCodecForLocale(QTextCodec::codecForName("UTF-8"));
   

2. 文件權限問題

   // 設置正確的文件權限
   file.setPermissions(QFile::ReadOwner | QFile::WriteOwner);
   

3. 特殊字符處理

   • 使用writeCDATA()處理包含特殊字符的內容
   • 或者使用QString::toHtmlEscaped()進行轉義

4. 大文件內存消耗

   • 使用QXmlStreamWriter代替QDomDocument
   • 分塊寫入XML文件

在Qt 5.9中，推薦使用QXmlStreamWriter配合QSaveFile進行XML文件寫入，這種方法高效、安全且內存占用低，適合大多數應用場景。