Qt 之 Query Model Example 解析

总体概括

Query Model Example主要演示了怎么使用QSqlQueryModel这个数据库查询模型类。其中包括创建普通的数据库查询模型、可编辑的数据库查询模型和自定义的数据库查询模型。普通（默认）的数据库查询模型是只读的（不可再模型中编辑数据，模型只通过视图展示数据）；可编辑的数据库查询模型重写了QSqlQueryModel的flags()方法和setData()方法；自定义的数据库查询模型其实范围更广，其实可编辑的数据库查询模型就是一种自定义的数据库查询模型，根据不同的需求我们可以自定义符合需求的不同的自定义数据库查询模型（示例中把ID字段的ID前加了个'#'符号，把firstname字段的字体颜色设置为蓝色同时把lastname字段的字符都转为大写）。

代码解析

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    if (!createConnection())
        return 1;

    QSqlQueryModel plainModel;
    EditableSqlModel editableModel;
    CustomSqlModel customModel;

    initializeModel(&plainModel);
    initializeModel(&editableModel);
    initializeModel(&customModel);

    createView(&plainModel, QObject::tr("Plain Query Model"));
    createView(&editableModel, QObject::tr("Editable Query Model"));
    createView(&customModel, QObject::tr("Custom Query Model"));

    return app.exec();
}

主函数做的工作很明确，创建数据库连接，实例化三个数据库模型并将其绑定到视图上。

创建数据库连接请参照 Qt 之 Relational Table Model Example 解析 中提到的，同样为了实时通过工具查看数据库指定连接作用到mytest.db数据库磁盘文件。

数据库查询对象执行的SQL：

    QSqlQuery query;
    query.exec("create table person (id int primary key, "
               "firstname varchar(20), lastname varchar(20))");
    query.exec("insert into person values(101, 'Danny', 'Young')");
    query.exec("insert into person values(102, 'Christine', 'Holand')");
    query.exec("insert into person values(103, 'Lars', 'Gordon')");
    query.exec("insert into person values(104, 'Roberto', 'Robitaille')");
    query.exec("insert into person values(105, 'Maria', 'Papadopoulos')");

查询模型使用的person表内容如下所示：

*默认数据库查询模型代码解析

实例化QSqlQueryModel后调用initializeModel()初始化模型

void initializeModel(QSqlQueryModel *model)
{
    model->setQuery("select * from person");
    model->setHeaderData(0, Qt::Horizontal, QObject::tr("ID"));
    model->setHeaderData(1, Qt::Horizontal, QObject::tr("First name"));
    model->setHeaderData(2, Qt::Horizontal, QObject::tr("Last name"));
}

在默认连接上执行查询并设置模型表头标签以指示数据库各字段显示内容的意义。

创建表格视图用以显示查询模型填充的数据：

QTableView* createView(QSqlQueryModel *model, const QString &title = "")
{
    QTableView *view = new QTableView;
    view->setModel(model);
    static int offset = 0;

    view->setWindowTitle(title);
    view->move(100 + offset, 100 + offset);
    offset += 20;
    view->show();

    return view;
}

因为示例中要创建三个视图所以偏移量offset没创建完一个视图后都会同事往屏幕的x轴方向和y轴方向平移20像素。

创建默认查询数据库视图：

createView(&plainModel, QObject::tr("Plain Query Model"));

运行结果图：

默认的数据库查询模型是只读的，不可编辑。

*可编辑数据库查询模型

可编辑数据查询模型主要重写了QSqlQueryModel的flags()方法和setData()方法。

editablesqlmodel.h

#ifndef EDITABLESQLMODEL_H
#define EDITABLESQLMODEL_H

#include <QSqlQueryModel>

class EditableSqlModel : public QSqlQueryModel
{
    Q_OBJECT

public:
    EditableSqlModel(QObject *parent = 0);

    Qt::ItemFlags flags(const QModelIndex &index) const override;
    bool setData(const QModelIndex &index, const QVariant &value, int role) override;

private:
    bool setFirstName(int personId, const QString &firstName);
    bool setLastName(int personId, const QString &lastName);
    void refresh();
};

#endif

editablesqlmodel.cpp

Qt::ItemFlags EditableSqlModel::flags(
        const QModelIndex &index) const
{
    Qt::ItemFlags flags = QSqlQueryModel::flags(index);
    if (index.column() == 1 || index.column() == 2)
        flags |= Qt::ItemIsEditable;
    return flags;
}

将第一列和第二列（从0算起）设置为可编辑的状态。

bool EditableSqlModel::setData(const QModelIndex &index, const QVariant &value, int /* role */)
{
    if (index.column() < 1 || index.column() > 2)
        return false;

    QModelIndex primaryKeyIndex = QSqlQueryModel::index(index.row(), 0);
    int id = data(primaryKeyIndex).toInt();

    clear();

    bool ok;
    if (index.column() == 1) {
        ok = setFirstName(id, value.toString());
    } else {
        ok = setLastName(id, value.toString());
    }
    refresh();
    return ok;
}

获得当前所在行的id后清除模型的数据，更新修改后的值到数据库中并根据数据库数据刷新模型数据。（column是从0开始算起，所以，第一列和第二列分别是firstname和lastname字段）。

注意：clear()会把模型的表头标签也给清除掉，所以后面的refresh()必须重新设置表头标签！！！

//! [2]
bool EditableSqlModel::setFirstName(int personId, const QString &firstName)
{
    QSqlQuery query;
    query.prepare("update person set firstname = ? where id = ?");
    query.addBindValue(firstName);
    query.addBindValue(personId);
    return query.exec();
}
//! [2]

bool EditableSqlModel::setLastName(int personId, const QString &lastName)
{
    QSqlQuery query;
    query.prepare("update person set lastname = ? where id = ?");
    query.addBindValue(lastName);
    query.addBindValue(personId);
    return query.exec();
}

setFirstName()和setLastName()执行update SQL语句，成功返回true,失败返回false。

void EditableSqlModel::refresh()
{
    setQuery("select * from person");
    setHeaderData(0, Qt::Horizontal, QObject::tr("ID"));
    setHeaderData(1, Qt::Horizontal, QObject::tr("First name"));
    setHeaderData(2, Qt::Horizontal, QObject::tr("Last name"));
}

和initializeModel()一样设置查询和设置模型的表头标签。

运行结果截图：

在模型上不仅可以编辑数据，而且确实实时更新到数据库中。

*自定义数据库查询模型

customsqlmodel.h

#ifndef CUSTOMSQLMODEL_H
#define CUSTOMSQLMODEL_H

#include <QSqlQueryModel>

//! [0]
class CustomSqlModel : public QSqlQueryModel
{
    Q_OBJECT

public:
    CustomSqlModel(QObject *parent = 0);

    QVariant data(const QModelIndex &item, int role) const override;
};
//! [0]

#endif

示例中主要重写了data()接口自定义了模型显示的数据的内容。

customsqlmodel.cpp

QVariant CustomSqlModel::data(const QModelIndex &index, int role) const
{
    QVariant value = QSqlQueryModel::data(index, role);
    if (value.isValid() && role == Qt::DisplayRole) {
        if (index.column() == 0)
            return value.toString().prepend('#');
        else if (index.column() == 2)
            return value.toString().toUpper();
    }
    if (role == Qt::TextColorRole && index.column() == 1)
        return QVariant::fromValue(QColor(Qt::blue));
    return value;
}

对于第0个字段（ID）在ID字符串钱添加‘#’字符，将第二个字段（lastname）的所有字符转为大写，第一个字段（firstname）的字体颜色设置为蓝色（fromValue()行为和setValue()相同）。

运行结果截图：

示例代码可在Qt Creator的欢迎界面的示例中找到~