3.3 Qt Rest 网络数据序列化

        本文是 《基于 Qt 的 REST 网络框架》的其中一节，建议全章阅读。

---

        在处理 Qt 数据序列化时，QJsonSerializer  是一个很好的工具。QJsonSerializer 支持所有基本类型、数组链表、QObject 属性以及 Q_GARGET 属性。

        但是用 QJsonSerializer 完成序列化的工作，可能会遇到一些不容易定位解决的问题。所以有必要了解其设计原理以及部分实现细节。这样遇到问题才能定位分析，解决。

QJsonSerializer 设计思路

        转换器完成 QVariant 与 QJsonValue 之间的相互转换：

        在此基础上，序列化与反序列化的流程为：

        

        转换器反序列化返回的 QVariant 内部数据不一定是目标类型，但是可以用 QVariant::convert 转换为目标类型。

QJsonSerializer 实现细节

• 普通类型

        普通数据序列化主要依赖 QJsonValue::fromVariant 和 QJsonValue::toVariant，没有对应的 QJsonConverter 类。

• 集合类型

        集合类型在 QMetaType 里面也是分别注册的，比如 QVector<int> 与 QVector<long> 是不同的类型，通过类型 id 可以反射出集合的元素类型。比如下面的代码可以获取 Map（Hash）类型的元素类型（子类型）：

int QJsonMapConverter::getSubtype(int mapType) const
{
	int metaType = QMetaType::UnknownType;
	auto match = mapTypeRegex.match(QString::fromUtf8(getCanonicalTypeName(mapType)));
	if(match.hasMatch())
		metaType = QMetaType::type(match.captured(1).toUtf8().trimmed());
	return metaType;
}

        这里用正则表达式的方式从字符串 "QMap<String,T>" 中提取出 “T”，然后借助 QMetaType 从类型名称获取类型 ID。

        集合类型的 Converter 在序列化、反序列化中，会先转换到中间类型，比如 Map（Hash）类型使用 QVariantMap 作为中间类型，然后再与 QJsonObject 相互转换。这么做是因为通用的 QJsonMapConverter 并不能直接使用 QMap<String, T> 泛型类型。

        这就要求针对 QMap<String, T> ，实现其与 QVariantMap 之间的相互转换函数，并注册到 QMetaType 类型系统中。

        库已经提供接口帮助实现并注册这些转换器，比如 QJsonSerializer::registerMapConverters<T>()。另外针对常见的类型 T（包括基本类型），通过自动生成代码完成了注册，下面的代码是自动生成的：

void qtJsonSerializerRegisterTypes() {
	static bool wasCalled = false;
	if(wasCalled)
		return;
	wasCalled = true;
	_qjsonserializer_helpertypes::converter_hooks::register_bool_converters();
	_qjsonserializer_helpertypes::converter_hooks::register_int_converters();
	_qjsonserializer_helpertypes::converter_hooks::register_uint_converters();
	_qjsonserializer_helpertypes::converter_hooks::register_qlonglong_converters();
    ...
}

• QObject* 类型

        因为 QObject 存在继承体系，所以就有“声明类型”，“实际类型”（派生类）的区别。在序列化时可以配置按照实际类型（setPolymorphing）序列化，此时类名作为 @class 存储在 JsonObject 中。反序列化时，也能够按照 @class 指定的类型实例化对象。

        为了序列化 QObject 对象，就必须取到其元数据信息 QMetaObject。有三种方式：

        第一种是直接从QObject 对象获取（用于按照实际类型序列化）：

meta = object->metaObject();

        第二种是从类型 ID 获取（用于按照声明类型序列化、反序列化）：

auto flags = QMetaType::typeFlags(typeId);
if (flags.testFlag(QMetaType::PointerToQObject))
	return QMetaType::metaObjectForType(typeId);

        第三种是从类型名称获取（用于按照实际类型反序列化）：

QByteArray classField = jsonObject[QStringLiteral("@class")].toString().toUtf8() + "*";//add the star
auto typeId = QMetaType::type(classField.constData());
auto nMeta = QMetaType::metaObjectForType(typeId);

        对 QObject 的序列化，就是存储所有属性到 QJsonObject 中。当然，属性值本身也需要序列化。反序列化也是差不多的。

• Gadget 类型

        Gadget 类型是一种轻量的 QObject，只有静态属性，其他元数据都是没有的，非常适合用来描述网络报文结构。

        Gadget 也有对应的 QMetaObject，通过类型 ID 可以获取（同 QObject* 类型的第 2 种方式）。序列化、反序列化的实现与 QObject* 类型也差不多。

Rest Result 封装

        通常 Rest 接口返回数据会包含固定的 code（错误码），msg（错误描述），data（真正的数据，任意类型），对于这样形式的数据，怎么表示，如何序列化、反序列化呢？

        按照正常的思路，我们应该定义一个泛型的 GADGET，像下面这样：

template <typename T>
class QTestResultT
{
    Q_GADGET
public:
    Q_PROPERTY(int result MEMBER result_)
    Q_PROPERTY(QString message MEMBER message_)
    Q_PROPERTY(T data MEMBER data_)
};

         但是 MOC（Qt 元数据编译器）不支持泛型，这样做显然是不可行的。所以需要分两步，先定义一个数据 data 是 QVaraint 类型的基类：

class QTestResult
{
    Q_GADGET
public:
    Q_PROPERTY(int result MEMBER result_)
    Q_PROPERTY(QString message MEMBER message_)
    Q_PROPERTY(QVariant data MEMBER data_)
};

        这样 MOC 是可以工作的，接着定义派生于 QTestResult 的泛型模版类：

template <typename T>
class QTestResultT : public QTestResult
{
public:
    T && data() const
    {
        return std::move(*data_.value<T*>());
    }
};

        但是又有另一个问题，这个泛型类型怎么（在 QMetaType 类型系统）注册呢？不可能为每个模版参数类型注册一次吧。其实 Qt 内部还是有泛型模版的（比如 QVector<T>），它们是用Q_DECLARE_METATYPE_TEMPLATE_1ARG 这样的宏来注册的（建议看一下它的实现）。所以我们也使用它来注册：

Q_DECLARE_METATYPE_TEMPLATE_1ARG(QTestResultT)

        然而，序列化  QJsonGadgetConverter 还是不能识别 data 的类型，反序列化会失败。既然普通的 Gadget Converter 不能用，那么就实现一个新的 Converter 来处理。给它个名字就是：QJsonWrapperConverter。

        QJsonWrapperConverter 与 QJsonGadgetConverter 的实现几乎一模一样。只是遇到名称为 data 的属性时，使用 QJsonMapConverter 中的方式获取子类型来替换 data 的类型。

        最后，将 Converter 注册到 QJsonSerializer 中：

serializer_->addJsonTypeConverter(
            QJsonTypeConverterStandardFactory<QJsonWrapperConverter>().createConverter());

网络数据序列化

        最后，看一下序列化工具怎么使用，我们用 QRestJson 封装了序列化类：

template<typename T>
QByteArray QRestJson::toJson(T const & t)
{
    return serializer_->serializeTo(t);
}

template<typename T>
T QRestJson::fromJson(QByteArray const & json, T *)
{
    return serializer_->deserializeFrom<T>(json);
}

        关于序列化，就讲这么多了。