如何简单地序列化复杂的结构并在 Qt 中通过网络发送它们

Question

我正在创建一个客户端服务器应用程序，现在我正在处理一种最简单的方法来序列化一些类，传递到另一端，然后放回我以后可以使用的类中。

我意识到这并不简单，有些人可能会说在 C 或 C++ 等低级语言中不可能，但实际上通过大量编码是可行的。我想知道其他人是否已经为此创建了一个解决方案，该解决方案是便携的并且可以工作，因此我不需要重新发明轮子。

目前我的解决方案（可能有点太复杂了）：

每个要序列化和反序列化的类都继承自Serializable包含 2 个函数的抽象类：

QHash<QString, QVariant> ToHash();
void LoadHash(QHash<QString, QVariant> hash);

第一个函数创建一个包含所有公共和私有变量的 QHash。第二个函数加载这个散列并填充它们所属的值。这样我就可以根据需要将需要序列化的每个结构转换为QHash和返回。

现在棘手的部分是通过网络将其交付给另一方。我决定为此创建一个超级简单的 TCP 协议。

我可以使用QDataStream以将其QHash转换为字节数组，并且（文档说，虽然我担心可能会有一些隐藏的警告）重新QHash使用相同的类。

这意味着，我有一种方法可以将结构序列化为QByteArray's 并且我可以将它们转换回来，现在我需要发送和接收它们。

因为我正在传输二进制数据，所以我决定不对这些“数据块”使用某种分隔符，因为我不想弄乱这些分隔符的复杂转义，而是决定创建一个固定大小的标头（我存储常量中的字节大小称为HEADER_SIZE，目前为 8 个字节）。客户端和服务器上的标头大小必须相同。

我要做的是获取生成的QByteArray（序列化类），获取其大小并从中创建完全长HEADER_SIZE字节的标头，在其中放入实际大小的序列化结构并将其添加到QByteArray. 然后我将这个数组发送到另一边。

另一方面，我正在等待第一个HEADER_SIZE字节，然后获得与标头中描述的一样多的字节，QHash从它形成背面。（我还没有这个代码，它现在只是一个理论算法）。

这是正确的方法吗？没有更简单的方法吗？或者已经为我解决了这个问题的东西？是否有一些我应该注意的警告？

只是为了让它更清楚一点，这是我想要做的这个伪图：

Answer 1

你可以而且应该利用QDataStream这一点。无需从 派生Serializable，只需为每个要序列化的对象实现QDataStream & operator<<(QDataStream &, Type & const)和即可。QDataStream & operator>>(QDataStream &, Type &)Type

然后，您只需将所有数据QByteArray通过a 转储到 a QDataStream。您将传输数组的大小，然后传输其内容。在接收端，您接收大小，然后接收内容，在其上设置数据流，然后将数据拉出。它应该是无缝的。

只要正确实现各个流操作符，就会自动为您处理数据块分离。选择 aQHash作为序列化手段是不必要的限制 - 对于某些类来说它可能是一个不错的选择，但对于其他类来说则不然。

您应该序列化为 a QHash，而不是序列化为 a QDataStream。但其运算符可以是独立的函数，因此您无需为此派生任何特殊的接口类。编译器会提醒您任何缺少的运算符。

这是一个非常简单的例子，通过 UDP 工作。

这是一个更大的示例，显示了面向未来的版本控制的详细信息，并显示了相当复杂的数据结构的序列化 - a QAbstractItemModel.

一般来说，三个对象的序列化a,b,c可能如下所示：

static const QDataStream::Version kDSVersion = QDataStream::Qt_5_5;

void Foo::send() {
  QByteArray buf;
  QDataStream bds(&buf, QIODevice::WriteOnly));
  bds.setVersion(kDSVersion);
  bds << a << b << c;

  QDataStream ds(socket, QIODevice::WriteOnly);
  ds.setVersion(kDSVersion);
  ds << buf; // buffer size followed by data
}

在接收端：

void Foo::readyReadSlot() {
  typedef quint32 QBALength;
  if (socket->bytesAvailable() < sizeof(QBALength)) return;
  auto buf = socket->peek(sizeof(QBALength));
  QDataStream sds(&buf);
  // We use a documented implementation detail:
  // See http://doc.qt.io/qt-5/datastreamformat.html
  // A QByteArray is serialized as a quint32 size followed by raw data.
  QBALength size;
  sds >> size;
  if (size == 0xFFFFFFFF) {
    // null QByteArray, discard
    socket.read(sizeof(QBALength));
    return;
  }
  if (socket->bytesAvailable() < size)  return;
  QByteArray buf;
  QDataStream bds(&socket);
  bds.setVersion(kDSVersion);
  bds >> buf;
  QDataStream ds(&buf);
  ds.setVersion(kDSVersion);
  ds >> a >> b >> c;
}