Qt之QDomDocument操作xml文件-模擬ini文件存儲

一、背景

　　不得不說Qt是一個很強大的類庫，不管是做項目還是做產品，Qt自身封裝的東西就已經非常全面了，我們今天的這篇文章就是模擬了Qt讀寫ini文件的一個操作，當然是由於一些外力原因，我們決定自己來完善下這個功能。好的，那么現在就讓我們隆重的請出今天的主角--QSettings。這個類能干嘛呢？ 答案就是：讀寫注冊表或者讀寫ini文件，這對於我們做應用程序時記錄一些可持久化數據非常有用。

二、QSettings訪問ini文件

　　QSettings訪問ini文件相對來說比較簡單，我們只需要構造一個QSettings對象，傳入文件名稱和文件存儲格式即可，如圖1所示。但同時QSettings也有一些局限，如下：
1、QSettings的編碼問題(QTBUG15543、QTBUG19552)
2、QSettings的key不能為中文
3、當在一個嵌套作用域多次構造QSettings時並設置了編碼，此時訪問文件設置的編碼會失效
　　由於QSettings有一些限制，也就引出了我們這篇文章的內容，使用xml模擬ini文件，下面我們主要分析下怎么使用xml文件模擬ini文件，需要的接口並不多，讀、寫、新增和刪除。

圖1 QSettings讀寫ini

三、xml文件讀寫

　　讀寫xml文件的方式有很多，Qt提供了2種比較常用的方式：DOM和SAX，詳情可以參看：Qt學習之XML讀寫操作小結。初次之外C++還提供了幾種庫用於操作xml文件，比如：libxml2、tinyXml等。
此處我們模擬的是QSettings讀寫ini文件，因此使用Qt自帶的DOM方式讀寫xml，操作起來相對容易。

　　如圖2所示，是我們xml文件操作類的幾個重要接口和成員，前邊4個公有接口分別對應。讀、寫、新增和刪除；成員變量m_filePath表示加載的xml文件路徑，m_mItemMap表示2級的ini文件結構

圖2 xml文件操作頭文件

1、讀xml文件

void xmlOperate::readXml( const QString & filePath )
{
    if(filePath.isEmpty())
        return;

    QFile file(filePath);
    if(file.open(QFile::ReadOnly | QFile::Text) == false)
        return;

    QDomDocument domDocument;
    QString error;
    int row = 0, column = 0;
    if(domDocument.setContent(&file, false, &error, &row, &column) == false)
        return file.close();

    if(domDocument.isNull()) 
        return file.close();

    m_mItemMap.clear();

    QDomElement rootElement = domDocument.documentElement();
    QDomNodeList groupList = rootElement.childNodes();
    for(int i = 0; i < groupList.count(); ++i)
    {
        QDomNode groupNode = groupList.item(i);
        QDomElement groupElement = groupNode.toElement();
        QString groupName = groupElement.attribute("name");

        QMap<QString, QString> items;
        QDomNodeList itemList = groupElement.childNodes();
        for (int j = 0; j < itemList.count(); ++j)
        {
            QDomNode itemNode = itemList.item(j);
            QDomElement itemElement = itemNode.toElement();
            QString itemName = itemElement.attribute("name");
            QString itemText = itemElement.text();

            if (itemName.isEmpty())
            {
                items[QString::number(j)] = itemText;
            }
            else
            {
                items[itemName] = itemText;
            }
        }
        m_mItemMap[groupName] = items;
    }

    file.close();

    qDebug() << m_mItemMap;
}

2、保存xml文件

void xmlOperate::writeXml(const QString & filePath)
{
    QDomDocument domDocument;
    QString strHeader( "version=\"1.0\" encoding=\"UTF-8\"" );
    domDocument.appendChild( domDocument.createProcessingInstruction("xml", strHeader) );

    QDomElement root = domDocument.createElement("groups");
    domDocument.appendChild(root);

    for(auto iter = m_mItemMap.begin(); iter != m_mItemMap.end(); ++iter)
    {
        QDomElement groupNode = domDocument.createElement("group");
        groupNode.setAttribute("name", iter.key());

        QMap<QString, QString> items = iter.value();
        for (auto iter2 = items.begin(); iter2 != items.end(); ++iter2)
        {
            QString key = iter2.key();
            QString value = iter2.value();

            QDomElement itemNode = domDocument.createElement("item");
            itemNode.setAttribute("name", key);

            QDomText textNode = domDocument.createTextNode(value);
            itemNode.appendChild(textNode);

            groupNode.appendChild(itemNode);
        }
        root.appendChild(groupNode);
    }

    QFile file(filePath);
    if(file.open(QFile::WriteOnly | QFile::Text))
    {
        QTextStream out(&file);
        domDocument.save(out, 4);
        file.close();
    }
    qDebug() << m_mItemMap;
}

3、插入項

bool xmlOperate::addItem( const QString & value, const QString & group, const QString & key )
{
    if (value.isEmpty() || group.isEmpty())
    {
        return false;
    }

    if (key.isEmpty())
    {
        int count = m_mItemMap[group].size();
        m_mItemMap[group][QString::number(count)] = value;
    }
    else
    {
        m_mItemMap[group][key] = value;
    }

    writeXml(m_filePath);

    return true;
}

4、刪除項

bool xmlOperate::removeItem( const QString & value, const QString & group, const QString & key /*= ""*/ )
{
    if (value.isEmpty() || group.isEmpty())
    {
        return false;
    }

    if (key.isEmpty())
    {
        int count = m_mItemMap[group].size();
        if (count == 0)
        {
            return false;
        }
        
        auto iter = m_mItemMap[group].begin();
        while (iter != m_mItemMap[group].end())
        {
            if (iter.value() == value)
            {
                iter = m_mItemMap[group].erase(iter);
            }
            else
            {
                ++iter; 
            }
        }
    }
    else
    {
        m_mItemMap[group].remove(key);
    }

    writeXml(m_filePath);

    return true;
}

四、示例程序下載

如圖3是測試代碼生成的測試結果，group相當於ini文件中的一個分組，item表示分組中的一項

圖3 測試程序結果

xml讀寫-xml模擬ini存儲