C++临时对象引起的BUG与DEBUG

C++临时对象引起的BUG与DEBUG

背景：最近程序中需要把QString类型转化成char*类型进行使用。在程序运行过程中发现转换的char*字符串和预期的不符。于是开启Debug之旅。

1. 问题代码

/*********************************************************************************************
    *  @Copyright (c) , All rights reserved.
    *  @file:       main.cpp
    *  @version:    ver 1.0
    *  @author:   zbb
    *  @brief:  
    *  @change:
    *  @email: 	binbin_erices@163.com
    *  Date             Version    Changed By      Changes 
    *  2020/4/14 23:00    1.0       zbb             create
**********************************************************************************************/
#include <QCoreApplication>

#include <QString>
#include <QDebug>

void Print(const char *pBuff)
{
    qDebug()<<"---pBuff: "<< pBuff;
}

void TestPrint(const QString& str)
{
    char *ptr = str.toUtf8().data();
    Print(ptr);

    QByteArray byteArray = str.toUtf8();
    Print(byteArray.data());
}

void TestSTDPrint(const QString& str)
{
    const char *ptr = str.toStdString().c_str();
    Print(ptr);

    std::string str_Content = str.toStdString();
    Print(str_Content.c_str());
}

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    TestPrint("Shanghai");
    TestSTDPrint("Shanghai");
    return a.exec();
}

打印输出的现象如下：

---pBuff:
---pBuff:  Shanghai
---pBuff:  D?
---pBuff:  Shanghai

打印的第一行和第三行显示乱码，而第二行和第四行确是正确输出。无疑由QString转化为char*的过程中出现了问题。初步排查是由于使用临时对象中的成员，而临时对象生命周期结束而导致的未定义行为。

2. 验证由于临时对象释放导致的问题

//MyObject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

class MyObject
{
public:
    MyObject(char *ptr);
    ~MyObject();

    char *data()
    {
        return m_pbuff;
    }

private:
    int     m_len;
    char    *m_pbuff;

};

extern MyObject getObject();

#endif // MYOBJECT_H

//MyObject.cpp
#include "MyObject.h"
#include <QDebug>

MyObject::MyObject(char *ptr)
{
    qDebug()<<"construct....";
    m_len = strlen(ptr);
    m_pbuff = new char [m_len +1];
    memset(m_pbuff, 0, m_len +1);
    memcpy(m_pbuff, ptr, m_len);
}

MyObject::~MyObject()
{
    qDebug()<<"destruct....";
    delete [] m_pbuff;
}


MyObject getObject()
{
    MyObject str("ShenZhen");
    return str;
}

进行测试：

int main(int argc, char *argv[])
{
    char *ptr = getObject().data();
    std::cout<< ptr <<std::endl;

    MyObject obj = getObject();
    ptr = obj.data();
    std::cout<< ptr <<std::endl;

    return 0;
}

结果输出：

construct....
destruct....
ShenZhen
construct....
ShenZhen
destruct....

分析：

1. char *ptr = getObject().data()执行后打印了 construct 和 destruct,说明临时对象的生命周期就结束了，后面再打印ptr就会出现未定义的行为。
2. MyObject obj = getObject()用obj对象来接临时对象，临时对象就会转给obj对象，从而不会被析构，但是程序结束后，还是会被析构，打印destruct
3. 上述测试代码是在Qt5.6.3平台下进行测试，在VS2015中调试直接中断，说明VS2015的编译器检查比QT要严格点。也可能是测试代码没有写好，但是已经能够说明问题啦。

3. 结论

在需要从一个对象转成另外一个对象，获取另外一个对象的属性时， 一定不建议连续操作 . 需要先用一个对象来接临时对象，否则很容易就会出现一些未定义的行为。