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

解决方案/解决方法:

实际上,qDebug()输出QByteArray被截断为一个'\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" 

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

让我们深入了解Qt内部代码,了解qDebug()它的作用.以下代码片段来自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'字符,即使编写自己的消息处理程序也无法解决问题,因为您无法知道长度.悲伤,但是真的.