C++如何通过Qt反射机制实现数据类序列化

 更新时间:2025年04月23日 08:37:05   作者:永不停转  
在 C++ 工程中经常需要使用数据类,并对数据类进行存储、打印、调试等操作,所以本文就来聊聊C++如何通过Qt反射机制实现数据类序列化吧

在 C++ 工程中经常需要使用数据类,并对数据类进行存储、打印、调试等操作。由于数据类中有大量数据字段,每次都编写存储或输出数据内容,工作重复量太大。C++ 不支持用户自定义的注解,所以没办法使用类似 java 中类似 Lombok 的插件。但是 QT 的属性系统和 moc 编译系统,为简化数据类的序列化提供了可能性。

设计预期

  • 保持数据类的简洁,最好通过类似 Lombok 的注解语法,只让声明序列化的数据字段支持序列化;
  • 自动生成 getter 和 setter 方法;
  • 支持数据流输入/输出;
  • 支持 QDebug 直接输出对象内容;
  • 能自动解包 QPoint、QRect、QVariant 等结构化数据。

设计思路

使用宏代理注解完成 getter 和 setter 方法的自动生成;

使用反射系统结合宏定义记录需要序列化的字段信息;

使用基类完成序列化的模板代码,让数据类继承序列化基类即可完成数据的序列化。

代码实现

以下代码中 Serializable 是数据类的基类,在其 cpp 文件中内置了许多模板代码用于支持处理数据流及 QDebug 操作。宏 SERIALIZE(className) 用于指定需要序列化的类,宏JSONFIELD(field, alias, ...) 用于指定需要序列化的字段。为了保证数据类的轻量化,此处没有使用 QObject 类,而是使用了轻量化的 Q_GADGET,这样在预编译时不会产生太多的代码。

// serializable.h
#ifndef SERIALIZABLE_H
#define SERIALIZABLE_H

#include "qjsonobject.h"

#include <QObject>
#include <QMetaObject>
#include <QMetaProperty>
#include <QDebug>
#include <QFile>

#include <QtWidgets/QMessageBox>

// SERIALIZE 宏内不能包含 Q_GADGET ,必须在子类中单独使用 Q_GADGET,
// 因为 moc 时不引入其它头文件,此处定义Q_GADGET对子类无效,子类不会生成moc文件
//const_cast<className&>(explicit
#define SERIALIZE(className) \
Q_CLASSINFO("base", "Serializable") \
public: \
className(const className &other){ \
    copy(other, *this); \
} \
inline const QMetaObject* getMetaInfo() const override{ \
    return &staticMetaObject; \
}

#ifndef Q_MOC_RUN
// define the tag text as empty, so the compiler doesn't see it
#  define JSON_FLAG
#endif
#define VAR_TYPE(var) decltype(var)

#ifdef CHAIN
#define SETTER(field, alias) \
inline auto set##alias(const __type_##field &value) { \
    field = value; \
return this; \
}
#else
#define SETTER(field, alias) \
inline void set##alias(const __type_##field &value) { \
    field = const_cast<__type_##field>(value); \
}
#endif

#define JSONFIELD(field, alias, ...) \
using __type_##field = decltype(field) ;\
Q_PROPERTY(__type_##field field READ get##alias WRITE set##alias) \
    public: \
    Q_INVOKABLE JSON_FLAG inline QMap<QString, QString> __get##alias##Info__(){ \
        QMap<QString, QString> info; \
        info["name"] = #field; \
        info["alias"] = #alias; \
        info["args"] = QString(#__VA_ARGS__); \
        return info; \
    } \
    inline __type_##field get##alias() const { return field; } \
    inline void set##alias(const __type_##field &value) { \
            field = value; \
    }

class Serializable
{
public:
    Serializable();
    virtual ~Serializable();
    static bool isSubClass(QMetaType type);
    virtual const QMetaObject* getMetaInfo() const = 0;
    void copy(const Serializable &from, Serializable &to);
    void copy(const Serializable &from);
    virtual QString hashCode();
    virtual bool equals(Serializable &obj);
    virtual bool operator==(Serializable &obj);
    virtual QString toString();
    template<typename T>
    T invokeMethod(const QMetaObject *metaInfo, int index);
    virtual QVariant getValue(QString fieldName);
    virtual void setValue(QString fieldName, QVariant value);

    friend QDataStream &operator<<(QDataStream &stream, const Serializable &data);
    friend QDataStream &operator>>(QDataStream &stream, Serializable &data);
    friend QDebug operator<<(QDebug dbg, const Serializable &data);

private:
    QString id;
};

Q_DECLARE_METATYPE(Serializable)

#endif // SERIALIZABLE_H

由于 cpp 文件的代码太多,此处不再贴出来,需要的请到项目 https://github.com/lsyeei/dashboard 的源码目录 /common/ 中查看 serializable.cpp

使用方法

  • 子类继承 Serializable
  • 子类中须使用宏 Q_GADGET
  • 子类中使用宏 SERIALIZE(className) 开启序列化功能
  • 子类中使用 JSONFIELD(field, alias, ...) 指定哪些字段需要序列化
  • 使用Q_DECLARE_METATYPE(className)注册元数据类型

说明:

  • 使用 SERIALIZE 会自动生成拷贝构造函数
  • 使用 JSONFIELD 指定的字段会自动生成 get和set函数,不必单独声明
    举例:
class Student : public Serializable
{
 Q_GADGET
 SERIALIZE(Student)
 public:
     Student();
     ~Student();
 private:
     QString name;
     int age;

     JSONFIELD(name, Name)
     JSONFIELD(age, Age)
};
Q_DECLARE_METATYPE(Cunstom)

Student的使用方法:

Student student;
student.setName("li");
student.setAge(15);
qDebug() << student;
QByteArray array;
QDataStream stream(&array, QIODeviceBase::WriteOnly);
stream << student;

项目 Compelling Data Designer 用于数据的可视化设计,软件采用可扩展架构,支持扩展图形插件、数据接口。项目仍在开发中,目前已设计完成基本图形、多属性配置、动画等功能。结合 Serializable 类,项目中还提供了 JSON 序列化的实现方式。具体介绍见: QT 实现 C++ 数据类与 json 的转换

以上就是C++如何通过Qt反射机制实现数据类序列化的详细内容,更多关于C++数据类序列化的资料请关注脚本之家其它相关文章!

相关文章

  • C++验证LeetCode包围区域的DFS方法

    C++验证LeetCode包围区域的DFS方法

    这篇文章主要介绍了C++验证LeetCode包围区域的DFS方法,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-07-07
  • C语言利用数组和文件实现登录注册功能

    C语言利用数组和文件实现登录注册功能

    这篇文章主要为大家详细介绍了C语言利用数组和文件实现登录注册功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-12-12
  • C++模拟实现string的方法详解

    C++模拟实现string的方法详解

    标准库类型string表示可变长的字符序列,使用string类型必须首先包含string的头文件。本文将利用C++模拟实现string,需要的可以参考一下
    2022-11-11
  • C++实现循环队列

    C++实现循环队列

    这篇文章主要为大家详细介绍了C++实现循环队列,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-01-01
  • Qt实现部件透明阴影效果与不规则窗体详解

    Qt实现部件透明阴影效果与不规则窗体详解

    这篇文章主要为大家详细介绍了Qt实现部件透明阴影效果与不规则窗体的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2023-01-01
  • 共用体的定义与应用详细解析

    共用体的定义与应用详细解析

    共同体的定义类似结构体,不过共同体的所有成员都在同一段内存中存放,起始地址一样,并且同一时刻只能使用其中的一个成员变量
    2013-08-08
  • 详解如何用alpine镜像做一个最小的镜像并运行c++程序

    详解如何用alpine镜像做一个最小的镜像并运行c++程序

    这篇文章主要介绍了详解如何用alpine镜像做一个最小的镜像并运行c++程序,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • C++中函数重载与引用的操作方法

    C++中函数重载与引用的操作方法

    C++中函数重载允许同名函数根据参数列表的不同而执行不同的功能,这依赖于名字修饰或名字改编(Name Mangling)机制,而引用则是为变量创建一个别名,不会开辟新的内存空间,本文介绍了C++中函数重载与引用的操作,感兴趣的朋友一起看看吧
    2024-10-10
  • 冒泡算法的改进具体实现

    冒泡算法的改进具体实现

    这篇文章主要介绍了冒泡算法的改进具体实现,有需要的朋友可以参考一下
    2013-12-12
  • MATLAB中subplot函数的语法与使用实例

    MATLAB中subplot函数的语法与使用实例

    subplot()是将多个图画到一个平面上的工具,下面这篇文章主要给大家介绍了关于MATLAB中subplot函数的语法与使用的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-08-08

最新评论