Qt-操作xml文件

1  简介

参考视频：https://www.bilibili.com/video/BV1XW411x7AB?p=12

xml简介：可扩展标记语言，标准通用标记语言的子集，简称XML。是一种用于标记电子文件使其具有结构性的标记语言。

XML 标签没有被预定义，需要自行定义标签。XML 的设计宗旨是传输数据，而不是显示数据。XML 是独立于软件和硬件的信息传输工具。

2  xml文件格式

头部：xml文件的声明，说明xml版本和编码格式；

标签：标签需要成对出现。从（且包括）开始标签直到（且包括）结束标签的部分叫做XML 元素。

属性组：提供有关元素的额外信息，必须加引号。

xml文档形成的是一种树型结构。

3  测试及说明

下面简单介绍使用Qt创建一个xml文件，并对其进行简单的写入、读取操作。

先给出实现的效果，通过代码创建一个如下格式的xml文件，并通过id来查找到相应的节点信息。

<?xml version='1.0' encoding='utf-8'?>
<root>
    <id id="1">
        <name>xiaoming</name>
        <gender>male</gender>
        <age>19</age>
        <subject>Chinese</subject>
        <score>78</score>
    </id>
    <id id="2">
        <name>xiaohong</name>
        <gender>famale</gender>
        <age>18</age>
        <subject>Math</subject>
        <score>88</score>
    </id>
</root>

代码中的注释已经很详细了，就不再说说明步骤了，直接给出代码。

widget.h文件代码：

#ifndef WIDGET_H
#define WIDGET_H

#include <QWidget>
#include <QDomDocument>

namespace Ui {
class Widget;
}

class Widget : public QWidget
{
    Q_OBJECT

public:
    explicit Widget(QWidget *parent = 0);
    ~Widget();

    //创建xml空文件
    void create_xml(QString file_path);
    //追加xml文件
    void append_xml(QString file_path, int id, QStringList list);
    //写xml文件
    void write_xml(QDomDocument &doc, QDomElement &root, int id, QStringList &list);
    //读xml文件
    void read_xml(QString file_path, int id, QStringList &list);

private:
    Ui::Widget *ui;
};

#endif // WIDGET_H

widget.c文件代码：

#include "widget.h"
#include "ui_widget.h"
#include <QDomComment>
#include <QFile>
#include <QDebug>

Widget::Widget(QWidget *parent) :
    QWidget(parent),
    ui(new Ui::Widget)
{
    ui->setupUi(this);

    QString file_path = "../demo.xml";

    create_xml(file_path);

    QStringList list;
    //姓名 性别 年龄 学课 分数
    list << "xiaoming" << "male" << "19" << "Chinese" << "78";
    append_xml(file_path, 1, list);
    list.clear();
    list << "xiaohong" << "famale" << "18" << "Math" << "88";
    append_xml(file_path, 2, list);
    list.clear();
    read_xml(file_path, 2, list);
    qDebug() << list;
}

Widget::~Widget()
{
    delete ui;
}

/*
* 创建xml文件，空文件，仅包含头部信息和根元素节点
* 参数file_path：文件存放路径
*/
void Widget::create_xml(QString file_path)
{
    QFile file(file_path);  //关联文件名字
    if (true == file.exists()) {  //如果存在不创建
        qDebug() << "文件已经存在";
        return;
    }
    //只写方式打开文件
    bool isOK = file.open(QIODevice::WriteOnly);
    if (false == isOK) {
        qDebug() << "writeOnly error";
        return;
    }
    //创建xml文档对象
    QDomDocument doc;
    //创建xml头部格式：<?xml version='1.0' encoding='utf-8'?>
    QDomProcessingInstruction ins;
    ins = doc.createProcessingInstruction("xml", "version=\'1.0\' encoding=\'utf-8\'");
    //追加元素
    doc.appendChild(ins);
    //创建根节点元素
    QDomElement root = doc.createElement("root");
    doc.appendChild(root);
    //保存
    QTextStream stream(&file);  //文本流关联文件
    doc.save(stream, 4);  //4 缩进字符

    //关闭文件
    file.close();
}

/*
* 向xml文件中追加元素
* 参数file_path：文件存放路径
* 参数id：<id>元素节点的属性
* 参数list：<id>节点元素的子节点元素值
*/
void Widget::append_xml(QString file_path, int id, QStringList list)
{
    QFile file(file_path);  //关联文件名字
    //只读方式打开文件
    bool isOK = file.open(QIODevice::ReadOnly);
    if (false == isOK) {
        qDebug() << "ReadOnly error";
        return;
    }
    //文件file和xml关联
    QDomDocument doc;
    isOK = doc.setContent(&file);
    if (false == isOK) {
        qDebug() << "setContent error";
    }
    //关联成功后，可以关闭文件
    file.close();
    //获取根节点元素
    QDomElement root = doc.documentElement();
    //判断根节点下有没有子节点
    if (root.hasChildNodes()) {  //如果有子节点
        //查找最后一个子节点
        QDomElement last_elem = doc.lastChildElement();
        write_xml(doc, last_elem, id, list);
    } else {  //没有子节点
        //写有效数据
        write_xml(doc, root, id, list);
    }
    //保存文件
    isOK = file.open(QIODevice::WriteOnly);
    if (false == isOK) {
        qDebug() << "writeOnly error";
        return;
    }
    QTextStream stream(&file);
    doc.save(stream, 4);
    file.close();
}

/*
* 给<root>根节点元素添加子节点元素
* 参数doc：xml文件
* 参数root：<root>节点元素
* 参数id：<id>节点元素属性值
* 参数list：<id>节点元素的子节点元素值
*/
void Widget::write_xml(QDomDocument &doc, QDomElement &root, int id, QStringList &list)
{
    //添加<id>节点元素
    QDomElement elem_id = doc.createElement("id");
    QDomAttr attr_id = doc.createAttribute("id");
    QString attr_str = QString::number(id);
    attr_id.setNodeValue(attr_str);
    elem_id.setAttributeNode(attr_id);
    root.appendChild(elem_id);

    //创建<姓名><性别><年龄><学课><分数>节点元素
    QDomText text;
    QDomElement name_elem = doc.createElement("name");
    text = doc.createTextNode(list.at(0));
    name_elem.appendChild(text);
    QDomElement gender_elem = doc.createElement("gender");
    text = doc.createTextNode(list.at(1));
    gender_elem.appendChild(text);
    QDomElement age_elem = doc.createElement("age");
    text = doc.createTextNode(list.at(2));
    age_elem.appendChild(text);
    QDomElement subject_elem = doc.createElement("subject");
    text = doc.createTextNode(list.at(3));
    subject_elem.appendChild(text);
    QDomElement score_elem = doc.createElement("score");
    text = doc.createTextNode(list.at(4));
    score_elem.appendChild(text);
    //追加到<id>节点后面
    elem_id.appendChild(name_elem);
    elem_id.appendChild(gender_elem);
    elem_id.appendChild(age_elem);
    elem_id.appendChild(subject_elem);
    elem_id.appendChild(score_elem);
}

/*
* 通过id查找信息
* 参数file_path：xml文件路径
* 参数id：查找的id
* 参数list：存放查找到的信息
*/
void Widget::read_xml(QString file_path, int id, QStringList &list)
{
    QFile file(file_path);  //关联文件名字
    //只读方式打开文件
    bool isOK = file.open(QIODevice::ReadOnly);
    if (false == isOK) {
        qDebug() << "ReadOnly error";
        return;
    }
    //文件file和xml关联
    QDomDocument doc;
    isOK = doc.setContent(&file);
    if (false == isOK) {
        qDebug() << "setContent error";
    }
    //关联成功后，可以关闭文件
    file.close();
    //获取根节点
    QDomElement root = doc.documentElement();
    if (root.hasChildNodes()) {  //有没有子节点
        QDomNodeList list_nodes = root.childNodes();
        int i;
        for (i = 0; i < list_nodes.size(); i++) {
            if (id != list_nodes.at(i).toElement().attribute("id").toInt()) {
                continue;
            }
            //转换为元素，找到<id>节点下的所有子节点
            QDomNodeList sublist = list_nodes.at(i).toElement().childNodes();
            //name
            QString name = sublist.at(0).toElement().text();
            list.append(name);
            //gender
            QString gender = sublist.at(1).toElement().text();
            list.append(gender);
            //age
            QString age = sublist.at(2).toElement().text();
            list.append(age);
            //subject
            QString subject = sublist.at(3).toElement().text();
            list.append(subject);
            //score
            QString score = sublist.at(4).toElement().text();
            list.append(score);
            break;
        }
        if (i == list_nodes.size()) {
            qDebug() << QString("没有id=%1的学生信息").arg(id);
            return;
        }
    } else {  //没有子节点
        qDebug() << "没有子节点";
        return;
    }
}