扔掉sql语句，用 QxOrm 让你的数据库操作从来没有这么简单过！

置顶 q2nAmor

已于 2023-12-07 17:23:37 修改

阅读量1k

点赞数 19

分类专栏： QT C++ 文章标签：数据库 sql qt orm c++

于 2023-12-07 11:12:32 首次发布

本文链接：https://blog.csdn.net/u012534831/article/details/134850338

版权

QT 同时被 2 个专栏收录

9 篇文章 0 订阅

订阅专栏

C++

6 篇文章 0 订阅

订阅专栏

在这里插入图片描述

ORM简介：

ORM 全称是 Object Relational Mapping（对象关系映射），是一种程序设计技术，用于实现面向对象编程语言里不同类型系统的数据之间的转换。从效果上说，它其实是创建了一个可在编程语言里使用的“虚拟对象数据库”。

面向对象是从软件工程基本原则（如耦合、聚合、封装）的基础上发展起来的，而关系数据库则是从数学理论发展而来的，两套理论存在显著的区别。为了解决这个不匹配的现象，对象关系映射技术应运而生。

简单理解，ORM 就是在数据库和对象之间作了一个映射：

数据库的表（table） –> 类（class）
字段（field）–> 对象的属性（attribute）

关于QxOrm

http://www.qxorm.com/qxorm_en/manual.html

这是QxOrm的官方手册，如果要使用QxOrm，需要重点阅读下。

QxOrm 是一个 C++ 库，旨在为 C++ 用户提供对象关系映射（ORM）功能。
QxOrm 由 Lionel Marty 开发，他自 2003 年以来一直担任软件开发工程师。

基于每个类的简单 C++ 设置函数（如 Java 中的 Hibernate XML 映射文件），QxOrm 库提供以下功能：

主页：http://www.qxorm.com/qxorm_en/home.html
下载：http://www.qxorm.com/qxorm_en/download.html
手册：http://www.qxorm.com/qxorm_en/manual.html
在线类文档：http://www.qxorm.com/doxygen/html/index.html
GitHub：https://github.com/QxOrm/QxOrm

其主要特性包括：
持久性：支持最常见的数据库，如 SQLite、MySQL、PostgreSQL、Oracle、MS SQL Server、MongoDB（具有 1-1、1-n、n-1 和 n-n 关系）。

序列化：JSON、二进制和 XML 格式。

反射（或内省）：动态访问类定义、检索属性和调用类方法。

HTTP Web Server：独立的多线程 HTTP 1.1 web 服务器（支持 SSL/TLS、持久连接、cookie、会话、分块响应、URL 分发器/路由）。

JSON API：与 C++/Qt 以外的其他技术的互操作性（REST web 服务、QML 应用程序、脚本语言）。

默认情况下，QxOrm 库只依赖 QtCore 和 QtSql 模块。如果启用 QxOrm HTTP web server 特性，那么还将依赖于 QtNetwork 模块。除此之外，有些特性还需要依赖 boost（默认禁用）

QxOrm 库是多平台的，可以安装在所有环境中：Windows、Linux、Mac OS X、Android、iOS、Windows Phone、Raspberry Pi 等…

依赖

Qt的 GUI（QtGui，可选）、网络（QtNetwork，可选）、XML（QtXml，可选）、数据库（QtSql）…
QxOrm 兼容许多 Qt 对象：QObject、QString、QDate、QTime、QDateTime、QList、QHash、QSharedPointer、QScopedPointer…

注意：默认情况下，QxOrm 库仅依赖于 QtCore 和 QtSql 二进制文件。可以在 QxOrm.pri（或 QxOrm.cmake）配置文件中启用额外的功能：某些功能可以向 QxOrm 库添加依赖项。

构建和使用

1、下载

http://www.qxorm.com/qxorm_en/download.html

上面的链接下载源码包，或者下面的链接下载我编译好的windows版本的64位和32位的dll和lib和头文件。

https://download.csdn.net/download/u012534831/88606094

2、构建

使用cmake-gui.exe 或者 qtcreator 工具或者visual studiio 都可以，源码包下提供了 cmakelist.txt文件和pro文件和sln文件，直接可以构建，无需修改cmake。

在这里插入图片描述

如果使用cmake构建，构建时这些参数可选，默认情况下它们都是禁用的：

_QX_ENABLE_BOOST：添加一个依赖项来提升头文件（*.hpp），支持一些类，如：boost：：shared_ptr、boost：：optional、boost：：container等…;
_QX_ENABLE_BOOST_SERIALIZATION：启用boost：：serialization engine。此选项需要构建boost：：serialization二进制文件，并向QxOrm库添加依赖项;
_QX_ENABLE_QT_GUI：支持QtGui类型的序列化：QBrush、QColor、QFont、QImage、QMatrix、QPicture、QPixmap、QRegion。此选项将依赖项添加到 QxOrm 库（QtGui) ;
_QX_ENABLE_QT_NETWORK：启用 QxService 模块以通过网络（客户端/服务器应用程序）传输持久数据层。此选项将依赖项添加到 QxOrm 库（QtNetwork) ;
_QX_NO_PRECOMPILED_HEADER ：禁用预编译头文件（用于减少项目的编译时间）：最新版本的 MinGW 需要此选项（由于已知的编译器错误），对于所有其他编译器，建议使用预编译头文件 ;
_QX_NO_RTTI：在没有RTTI C++类型信息的情况下构建QxOrm库（以及所有依赖于QxOrm的项目） ;
_QX_STATIC_BUILD：在静态模式下构建 QxOrm 库（但建议将 QxOrm 构建为共享库）。
_QX_UNITY_BUILD：使用 Unity 构建概念减少 QxOrm 库编译时间：只需编译一个全.cpp源文件。建议使用 CMake 启用此选项（因为不支持本机预编译标头）;
_QX_ENABLE_MONGODB：支持MongoDB数据库，QxOrm库成为ODM（对象文档映射器）。

我构建的时候只打开了 _QX_UNITY_BUILD 一个选项，也没有用boost。

3、使用

这是构建后的源码目录：
在这里插入图片描述

构建好后，像下面这样，将构建的库放到测试程序下。
在这里插入图片描述

编写pro文件：

QT  += core gui sql

greaterThan(QT_MAJOR_VERSION, 4): QT += widgets

CONFIG += c++17

HEADERS += \
    oemconfig.h\
    mainwindow.h

SOURCES += \
    main.cpp \
    oemconfig.cpp\
    mainwindow.cpp

FORMS += \
    mainwindow.ui

INCLUDEPATH += $$PWD/include/
LIBS += -L"$$PWD/lib"
LIBS += -l"QxOrm"

我们新建model类进行测试：

#ifndef OemConfigModel_H
#define OemConfigModel_H

#include <QString>
#include <QxOrm.h>

class  OemConfigModel
{
public:
    OemConfigModel() : id(0) { }
    virtual ~OemConfigModel() { }

    long id;
    QString name;
    int age;
};
QX_REGISTER_HPP_EXPORT_DLL(OemConfigModel, qx::trait::no_base_class_defined, 0)

#endif // OemConfigModel_H

此处需要注意的是，官方文档和网上的文章都是让使用 QX_REGISTER_HPP 来进行对象注册，经过测试发现是不可行的，无法通过编译。查看issue发现有人使用 QX_REGISTER_HPP_EXPORT_DLL 进行注册，经过验证后是可以的。下面的cpp文件同理，需要使用 QX_REGISTER_CPP_EXPORT_DLL 而不是 QX_REGISTER_CPP。
~~在这里插入图片描述~~

#include "oemconfig.h"

QX_REGISTER_CPP_EXPORT_DLL(OemConfigModel)

namespace qx
{
template <> void register_class(QxClass<OemConfigModel>& t)
{
    t.setName("t_OemConfigModel");

    // 注册 User::id <=> 数据库中的主键
    t.id(&OemConfigModel::id, "id");

    // 注册 User::name 属性，使用的 key 是 name，version 是 1。
    t.data(&OemConfigModel::name, "name");

    // 注册 User::age 属性，使用的 key 是 age。
    t.data(&OemConfigModel::age, "age");
}
}

#include "mainwindow.h"
#include <QApplication>
#include "oemconfig.h"


int main(int argc, char* argv[])
{
    QApplication a(argc, argv);
    MainWindow w;
    w.show();
    QFile::remove("./Users.db");
    // 初始化参数，用于和数据库交互
    qx::QxSqlDatabase::getSingleton()->setDriverName("QSQLITE");
    qx::QxSqlDatabase::getSingleton()->setDatabaseName("./Users.db");
    qx::QxSqlDatabase::getSingleton()->setHostName("localhost");
    qx::QxSqlDatabase::getSingleton()->setUserName("root");
    qx::QxSqlDatabase::getSingleton()->setPassword("");

    // 在数据库中创建 User 表
    QSqlError daoError;
    daoError = qx::dao::create_table<OemConfigModel>();
//    qDebug() << daoError.text();
    // 创建 3 个用户
    // 可以使用 std 和 Qt 智能指针：std::shared_ptr、QSharedPointer 等...
    typedef  QSharedPointer<OemConfigModel> UserPtr;
    UserPtr u1;
    u1.reset(new OemConfigModel());
    u1->id = 1;
    u1->name = "Jack Ma";
    u1->age = 30;

    UserPtr u2;
    u2.reset(new OemConfigModel());
    u2->id = 2;
    u2->name = "Pony";
    u2->age = 25;

    UserPtr u3;
    u3.reset(new OemConfigModel());
    u3->id = 3;
    u3->name = "Waleon";
    u3->age = 18;

    // 将所有用户插入容器中
    // 可以使用 std、boost、Qt 和 qx::QxCollection<Key，Value> 中的许多容器
    typedef QVector<UserPtr> VectorUser;
    VectorUser users;
    users.push_back(u1);
    users.push_back(u2);
    users.push_back(u3);

    // 将容器中的所有用户插入到数据库中
    // p1、p2、p3 的 id 属性会自动更新
    daoError = qx::dao::insert(users);
    qDebug() << daoError.text();
    // 修改第二个用户的信息，并更新到数据库中
    u2->age = 38;
    daoError = qx::dao::update(u2);

    // 从数据库中删除第一个用户
    u1.reset(new OemConfigModel());
    u1->name = "Jack Ma";
    daoError = qx::dao::delete_by_id(u1);

    // 计算用户的数量
    long userCount = qx::dao::count<OemConfigModel>();
    qDebug() << "User Count: " << userCount;

    // 将 id 为 3 的用户取出，并传给一个新变量
    UserPtr userTmp;
    userTmp.reset(new OemConfigModel());
    userTmp->name = "qht";
    daoError = qx::dao::fetch_by_id(userTmp);
    qDebug() << "User Tmp: " << userTmp->id << userTmp->name << userTmp->age;
    return a.exec();
}

运行程序，会打印一系列sql执行的输出信息，QxOrm 不会隐藏 SQL 查询（默认情况下，所有的语句都会显示），所以在控制台中可以看到执行过程，如果想要关闭，可以使用官方建议的下面的方法，但是我测试了没有用，因此我用QT的自定义日志拦截器对包含 QxOrm的日志进行了过滤。

 qx::QxSqlDatabase::getSingleton()->setFormatSqlQueryBeforeLogging(false);
    qx::QxSqlDatabase::getSingleton()->setVerifyOffsetRelation(false);
    qx::QxSqlDatabase::getSingleton()->setTraceSqlQuery(false);
    qx::QxSqlDatabase::getSingleton()->setTraceSqlBoundValuesOnError(false);
    qx::QxSqlDatabase::getSingleton()->setTraceSqlRecord(false);
    qx::QxSqlDatabase::getSingleton()->setTraceSqlBoundValues(false);
    qx::QxSqlDatabase::getSingleton()->setTraceSqlBoundValuesOnError(false);

You can install your own message handler (using qInstallMessageHandler), and filter all messages which start with [QxOrm] :
https://doc.qt.io/qt-5/qtglobal.html#qInstallMessageHandler

好了，今天这篇文章介绍了QxOrm的使用，后面还会介绍比如非ID主键、复合主键等其他使用方法。

在这里插入图片描述
关注公众号 QTShared，带你探索更多QT相关知识。

q2nAmor

关注

19
点赞
踩
26

收藏

觉得还不错? 一键收藏
打赏
0
评论
扔掉sql语句，用 QxOrm 让你的数据库操作从来没有这么简单过！

扔掉sql语句，用 QxOrm 让你的数据库操作从来没有这么简单过！ORM 全称是 Object Relational Mapping（对象关系映射），是一种程序设计技术，用于实现面向对象编程语言里不同类型系统的数据之间的转换。从效果上说，它其实是创建了一个可在编程语言里使用的“虚拟对象数据库”。面向对象是从软件工程基本原则（如耦合、聚合、封装）的基础上发展起来的，而关系数据库则是从数学理论发展而来的，两套理论存在显著的区别。为了解决这个不匹配的现象，对象关系映射技术应运而生。
复制链接

扫一扫