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

Question

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

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

目前我的解决方案(可能有点太复杂):

每个要序列化和反序列化的类都继承自抽象类Serializable，它包含两个函数:

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

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

现在棘手的部分是通过网络将其传送到另一端。我决定为此创建一个 super 简单的 TCP 协议(protocol)。

我可以使用 QDataStream 将这个 QHash 转换成一个字节数组，然后(文档说，虽然我担心可能有一些隐藏的警告)返回使用相同的类进入 QHash。

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

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

我要做的是获取生成的QByteArray(序列化类)，获取它的大小并从中创建正好是HEADER_SIZE 字节的 header ，将实际大小的序列化结构放入其中并将其添加到 QByteArray 之前。然后我将这个数组发送到另一端。

在另一边，我正在等待第一个 HEADER_SIZE 字节，然后得到与 header 中描述的一样多的字节，从中形成 QHash。 (我还没有这个代码，它现在只是一个理论算法)。

这样做正确吗？没有更简单的方法吗？或者已经为我解决了这个问题的东西？有什么我应该注意的注意事项吗？

为了让它更清楚一点，这是我正在尝试做的伪图:

Answer 1

您可以而且应该利用 QDataStream为了那个原因。而不是从 Serializable 派生, 简单地实现 QDataStream & operator<<(QDataStream &, Type & const)和 QDataStream & operator>>(QDataStream &, Type &)对于每个 Type你想序列化。

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

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

而不是序列化为 QHash , 你应该序列化为 QDataStream .但是它的运算符可以是独立的函数，因此您不需要为此派生任何特殊的接口(interface)类。编译器会提醒您任何缺失的运算符。

This is a very simple example , 通过 UDP 工作。

This is a larger example它显示了面向 future 的版本控制的细节，并显示了一个相当复杂的数据结构的序列化 - 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;
}