qDebug 没有打印包含二进制数据的完整 QByteArray

Question

我有一个QByteArray 来存储从 GPS 接收到的数据，该数据部分是二进制，部分是 ASCII。我想知道调试建议知道收到了什么，所以我写了一个qDebug 像这样：

//QByteArray buffer;
//...
qDebug() << "GNSS msg (" << buffer.size() << "): " << buffer;

我在控制台收到这样的消息：

GNSS msg ( 1774 ): "ygnnsdgk...(many data)..PR085hlHJGOLH
(more data into a new line, which is OK because it is a new GNSS sentence and
probably has a \n at the end of each one) blablabla...

但突然间我得到了一个新的打印迭代。数据还没有被删除，它已经被附加了。所以新的消息大小例如 3204，明显比以前的打印大。但它的打印结果完全相同（但括号中的新尺寸为 3204）。没有新的数据被打印出来，和之前的消息一样：

GNSS msg ( 3204 ): "ygnnsdgk...(many data)..PR085hlHJGOLH
(more data into a new line, which is OK because it is a new GNSS sentence and
probably has a \n at the end of each one) blablabla...

我猜qDebug 停止打印是因为它有一个限制，或者因为它到达了一个终止字符或类似的东西，但我只是猜测。

对这种行为有任何帮助或解释吗？

Answer 1

解决方案/解决方法：

确实，QByteArray 的 qDebug() 输出在 '\0' 字符处被截断。这与 QByteArray 无关；你甚至不能使用 qDebug() 输出一个 '\0' 字符。解释见下文。

QByteArray buffer;
buffer.append("hello");
buffer.append('\0');
buffer.append("world");

qDebug() << "GNSS msg (" << buffer.size() << "): " << buffer;

输出：

GNSS msg ( 11 ):  "hello

甚至以下任何参数都被忽略：

qDebug() << "hello" << '\0' << "world";

输出：

hello

您可以通过在调试之前替换字节数组中的特殊字符来解决这个“问题”：

QByteArray dbg = buffer;   // create a copy to not alter the buffer itself
dbg.replace('\\', "\\\\"); // escape the backslash itself
dbg.replace('\0', "\\0");  // get rid of 0 characters
dbg.replace('"', "\\\"");  // more special characters as you like

qDebug() << "GNSS msg (" << buffer.size() << "): " << dbg; // not dbg.size()!

输出：

GNSS msg ( 11 ):  "hello\0world" 

---

那么为什么会这样呢？为什么我不能使用 qDebug() 输出 '\0'？

让我们深入了解 Qt 内部代码以了解 qDebug() 的作用。 以下代码sn-ps来自Qt 4.8.0源代码。

这个方法在你做qDebug() << buffer时调用：

inline QDebug &operator<<(const QByteArray & t) {
    stream->ts  << '\"' << t << '\"'; return maybeSpace();
}

上面的stream->ts 是QTextStream 类型，它转换 将QByteArray 转换为QString：

QTextStream &QTextStream::operator<<(const QByteArray &array)
{
    Q_D(QTextStream);
    CHECK_VALID_STREAM(*this);
    // Here, Qt constructs a QString from the binary data. Until now,
    // the '\0' and following data is still captured.
    d->putString(QString::fromAscii(array.constData(), array.length()));
    return *this;
}

如您所见，d->putString(QString) 被调用（d 的类型是文本流的内部私有类），它在对等宽字段进行一些填充后调用write(QString)。我跳过putString(QString)的代码，直接跳转到d->write(QString)，它的定义是这样的：

inline void QTextStreamPrivate::write(const QString &data)
{
    if (string) {
        string->append(data);
    } else {
        writeBuffer += data;
        if (writeBuffer.size() > QTEXTSTREAM_BUFFERSIZE)
            flushWriteBuffer();
    }
}

如您所见，QTextStreamPrivate 有一个缓冲区。此缓冲区的类型为QString。那么当缓冲区最终打印在终端上时会发生什么？为此，我们必须找出当您的qDebug() 语句完成并将缓冲区传递给消息处理程序时会发生什么，默认情况下，该处理程序会在终端上打印缓冲区。这发生在QDebug 类的析构函数中，其定义如下：

inline ~QDebug() {
   if (!--stream->ref) {
      if(stream->message_output) {
         QT_TRY {
            qt_message_output(stream->type, stream->buffer.toLocal8Bit().data());
         } QT_CATCH(std::bad_alloc&) { /* We're out of memory - give up. */ }
      }
      delete stream;
   }
}

所以这里是非二进制安全部分。 Qt 获取文本缓冲区，将其转换为“本地 8 位”二进制表示（直到现在，AFAIK 我们应该仍然拥有我们想要调试的二进制数据）。

但随后将其传递给消息处理程序无需额外指定二进制数据的长度。正如您应该知道的，不可能找出也应该能够容纳'\0' 字符的C 字符串的长度。 （这就是为什么上面代码中的QString::fromAscii() 需要额外的长度参数来保证二进制安全。）

因此，如果您想处理'\0' 字符，即使编写自己的消息处理程序也无法解决问题，因为您无法知道长度。悲伤，但真实。