爱技术 & 爱分享
爱蛋蛋 & 爱生活

StringStream的Clear()和Str()函数

这篇文章专门介绍一下 StringStream 的clear 函数,亲身踩坑…

之前在项目中使用 stringstream 这个类,因为用于格式化字符串,真的超级的方便。不过一次在使用 ostringstream 格式化SQL语句的时候发现的问题出了大问题…

当时的场景是这样子的

ostringstream oss;
string sql;

/*使用 oss 进行 SQL语句的格式化*/
oss<<······;
sql=oss.str();

/*利用sql语句进行数据库更新操作*/

oss.clear();

//此时还有一个查询任务需要在更新之后处理
/*使用 oss 进行 SQL语句的格式化*/
oss<<······;

sql=oss.str();

/*利用sql语句进行数据库查询操作*/
//······

好吧 知道坑的同学们已经猜到有什么悲剧的事情发生了….幸好当时项目中这个sql语句并没有比较重要的操作….

oss.str() 这个操作会返回底层字符串的副本,如果说 oss.clear()是按我们预想中的意思去执行,那么一切肯定都是令人满意的…

太天真······ 你以为

事实上第二次调用 oss.str() 会返回一个有问题的字符串,这个字符串是上一个字符串加本次格式化的字符串…也就是说,clear() 函数并没有发挥想象中的作用。

再看一个简单的 Demo:

#include <iostream>
#include <sstream>
#include <string>

using namespace std;

int main()
{
    stringstream ss;
    int i = 0;
    for(i = 0; i < 5; i++ )
    {
        ss << "hello";
        string s = ss.str();
        cout << s.size() << endl;
        ss.clear();
    }
}

按道理来说 应该一直都会输出 5 才对吧。

可是 运行结果如下:

5
10
15
20
25

再来看另一个Demo:

#include <iostream>
#include <sstream>
#include <string>
using namespace std;
int main()
{
    int size = 100;
    stringstream strStream;
    for (int i = 1; i < size; ++i)
    {
        strStream.clear();
        strStream << i;
        string numStr;
        strStream >> numStr;
        cout<<numStr<<" ";
    }
    cout<<endl;
    printf("size=%d\n", strStream.str().capacity());
    return 0;
}

运行结果如下:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 5
7 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
size=191
请按任意键继续. . .

由此可见 clear()函数并没有按我们所想的去执行。

好吧 带大家好好看一下clear()函数的真面目,clear()函数是继承自 std::basic_ios 的 CppReference 对他的描述是 modifies state flags ,看吧 并没有提到任何字符串缓冲区的任何信息。只是这个函数名 很容易让我们以为他清除了原始字符串缓冲区。

而这个函数的解释是:

Sets the stream error state flags by assigning them the value of state. By default, assigns std::ios_base::goodbit which has the effect of clearing all error state flags.

大意如下:
通过为其分配状态值来设置流错误状态标志。 默认情况下,分配std :: ios_base :: goodbit可以清除所有错误状态标志。

所以大家应该知道这个函数的作用了吧。

那么如果我需要清空字符串缓冲区该怎么做呢?

这就又要用到str()函数了。这个函数有两种重载,分别是:

std::basic_string< CharT,Traits,Allocator> str() const;     //(1)
void str(const std::basic_string< CharT,Traits,Allocator>& new_str);    //(2)

然后关于这个函数的描述如下:

Manages the contents of the underlying string object.

  1. Returns a copy of the underlying string as if by calling rdbuf()->str().
  2. Replaces the contents of the underlying string as if by calling rdbuf()->str(new_str).

所以当不带参数的时候,是返回缓冲区中的字符串,带参数的时候是重新设置缓冲区字符串。利用这一点,我们可以这样使用来清空缓冲区 str("")

所以上面两个Demo 可以改写成如下形式:

#include <iostream>
#include <sstream>
#include <string>

using namespace std;

int main()
{
    stringstream ss;
    int i = 0;
    for(i = 0; i < 5; i++ )
    {
        ss << "hello";
        string s = ss.str();
        cout << s.size() << endl;

        // 如下两部可彻底恢复ss
        ss.clear(); // 恢复状态
        ss.str(""); // 恢复值
    }
}
#include <iostream>
#include <sstream>
#include <string>
using namespace std;
int main()
{
    int size = 100;
    stringstream strStream;
    for (int i = 1; i < size; ++i)
    {
        strStream.clear();
        strStream << i;
        string numStr;
        strStream >> numStr;
        cout<<numStr<<" ";
        strStream.str("");

    }
    cout<<endl;
    printf("size=%d\n", strStream.str().capacity());
    return 0;
}

不过这里还有一点小坑需要注意:stringstream.str()字符串用法的陷阱

首先声明一下,本例的输出结果在不同的机器上很可能是不一样的,在结论中我们会看到解释,我们先来看一下例子:

#include <string>
#include <sstream>
#include <iostream>

using namespace std;

int main()
{
    stringstream ss("012345678901234567890123456789012345678901234567890123456789");
    stringstream t_ss("abcdefghijklmnopqrstuvwxyz");
    string str1(ss.str());

    const char* cstr1 = str1.c_str();
    const char* cstr2 = ss.str().c_str();
    const char* cstr3 = ss.str().c_str();
    const char* cstr4 = ss.str().c_str();
    const char* t_cstr = t_ss.str().c_str(); 

    cout << "------ The results ----------" << endl
         << "cstr1:\t" << cstr1 << endl 
         << "cstr2:\t" << cstr2 << endl
         << "cstr3:\t" << cstr3 << endl
         << "cstr4:\t" << cstr4 << endl
         << "t_cstr:\t" << t_cstr << endl
         << "-----------------------------"  << endl;

    return 0;
}

在看这段代码的输出结果之前,先问大家一个问题,这里cstr1、cstr2、cstr3和cstr4 打印出来结果是一样的么?(相信读者心里会想:结果肯定不一样的嘛,否则不用在这里“故弄玄虚”了。哈哈)

接下来,我们来看一下这段代码的输出结果:

    ------ The results ----------
    cstr1:  012345678901234567890123456789012345678901234567890123456789
    cstr2:  012345678901234567890123456789012345678901234567890123456789
    cstr3:  abcdefghijklmnopqrstuvwxyz
    cstr4:  abcdefghijklmnopqrstuvwxyz
    t_cstr: abcdefghijklmnopqrstuvwxyz
    -----------------------------

这里,我们惊奇地发现cstr3和cstr4竟然不是ss所表示的数字字符串,而是t_ss所表示的字母字符串,这也太诡异了吧,但我们相信“真相只有一个”。

下面我们通过再加几行代码来看看,为什么会出现这个“诡异”的现象。

#include <string>
#include <sstream>
#include <iostream>

using namespace std;

#define PRINT_CSTR(no) printf("cstr" #no " addr:\t%p\n",cstr##no)
#define PRINT_T_CSTR(no) printf("t_cstr" #no " addr:\t%p\n",t_cstr##no)

int main()
{
    stringstream ss("012345678901234567890123456789012345678901234567890123456789");
    stringstream t_ss("abcdefghijklmnopqrstuvwxyz");
    string str1(ss.str());

    const char* cstr1 = str1.c_str();
    const char* cstr2 = ss.str().c_str();
    const char* cstr3 = ss.str().c_str();
    const char* cstr4 = ss.str().c_str();
    const char* t_cstr = t_ss.str().c_str(); 

    cout << "------ The results ----------" << endl
         << "cstr1:\t" << cstr1 << endl 
         << "cstr2:\t" << cstr2 << endl
         << "cstr3:\t" << cstr3 << endl
         << "cstr4:\t" << cstr4 << endl
         << "t_cstr:\t" << t_cstr << endl
         << "-----------------------------"  << endl;
    printf("\n------ Char pointers ----------\n");
    PRINT_CSTR(1);
    PRINT_CSTR(2);
    PRINT_CSTR(3);
    PRINT_CSTR(4);
    PRINT_T_CSTR();

    return 0;
}

在上述代码中,我们把那几个字符串对应的地址打印出来,其输出结果为:

     ------ The results ----------
    cstr1:  012345678901234567890123456789012345678901234567890123456789
    cstr2:  012345678901234567890123456789012345678901234567890123456789
    cstr3:  abcdefghijklmnopqrstuvwxyz
    cstr4:  abcdefghijklmnopqrstuvwxyz
    t_cstr: abcdefghijklmnopqrstuvwxyz
    -----------------------------

    ------ Char pointers ----------
    cstr1 addr:     0x100200e4
    cstr2 addr:     0x10020134
    cstr3 addr:     0x10020014
    cstr4 addr:     0x10020014
    t_cstr addr:    0x10020014

从上面的输出,我们发现cstr3和cstr4字串符的地址跟t_cstr是一样,因此,cstr3、cstr4和t_cstr的打印结果是一样的。按照我们通常的理解,当第17-19行调用ss.str()时,将会产生三个string对象,其对应的字符串也将会是不同的地址。

而打印的结果告诉我们,真实情况不是这样的。其实,streamstring在调用str()时,会返回临时的string对象。

而因为是临时的对象,所以它在整个表达式结束后将会被析构。

由于紧接着调用的c_str()函数将得到的是这些临时string对象对应的C string,而它们在这个表达式结束后是不被引用的,进而这块内存将被回收而可能被别的内容所覆盖,因此我们将无法得到我们想要的结果。

虽然有些情况下,这块内存并没有被别的内容所覆盖,于是我们仍然能够读到我们期望的字符串,(这点在这个例子中,可以通过将第20行删除来体现)。

但我们要强调的是,这种行为的正确性将是不被保证的。

通过上述分析,我们将代码修改如下:

#include <string>
#include <sstream>
#include <iostream>

using namespace std;

#define PRINT_CSTR(no) printf("cstr" #no " addr:\t%p\n",cstr##no)
#define PRINT_T_CSTR(no) printf("t_cstr" #no " addr:\t%p\n",t_cstr##no)

int main()
{
    stringstream ss("012345678901234567890123456789012345678901234567890123456789");
    stringstream t_ss("abcdefghijklmnopqrstuvwxyz");
    string str1(ss.str());

    const char* cstr1 = str1.c_str();
    const string& str2 = ss.str();
    const char* cstr2 = str2.c_str();
    const string& str3 = ss.str();
    const char* cstr3 = str3.c_str();
    const string& str4 = ss.str();
    const char* cstr4 = str4.c_str();
    const char* t_cstr = t_ss.str().c_str(); 

    cout << "------ The results ----------" << endl
         << "cstr1:\t" << cstr1 << endl 
         << "cstr2:\t" << cstr2 << endl
         << "cstr3:\t" << cstr3 << endl
         << "cstr4:\t" << cstr4 << endl
         << "t_cstr:\t" << t_cstr << endl
         << "-----------------------------"  << endl;
    printf("\n------ Char pointers ----------\n");
    PRINT_CSTR(1);
    PRINT_CSTR(2);
    PRINT_CSTR(3);
    PRINT_CSTR(4);
    PRINT_T_CSTR();

    return 0;
}

现在我们将获得我们所期望的输出结果了:

    ------ The results ----------
    cstr1:  012345678901234567890123456789012345678901234567890123456789
    cstr2:  012345678901234567890123456789012345678901234567890123456789
    cstr3:  012345678901234567890123456789012345678901234567890123456789
    cstr4:  012345678901234567890123456789012345678901234567890123456789
    t_cstr: abcdefghijklmnopqrstuvwxyz
    -----------------------------

    ------ Char pointers ----------
    cstr1 addr:     0x100200e4
    cstr2 addr:     0x10020134
    cstr3 addr:     0x10020184
    cstr4 addr:     0x100201d4
    t_cstr addr:    0x10020014

现在我们知道stringstream.str()方法将返回一个临时的string对象,而它的生命周期将在本表达式结束后完结。当我们需要对这个string对象进行进一步操作(例如获得对应的C string)时,我们需要注意这个可能会导致非预期结果的“陷阱”。:)

最后,我们想强调一下:由于临时对象占用内存空间被重新使用的不确定性,这个陷阱不一定会明显暴露出来。但不暴露出来不代表行为的正确性,为了避免“诡异”问题的发生,请尽量采用能保证正确的写法。

赞(0) 打赏 传送门
本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。ShadowInk » StringStream的Clear()和Str()函数
分享到: 更多 (0)

游戏 && 后端

传送门传送门

觉得文章写的还行就打赏一下呗~~~

支付宝扫一扫打赏

微信扫一扫打赏