std::stringstream 作为参数

Question

我对 C++ 语言有点陌生。我正在编写一个用于记录到文件的实用程序类。它工作得很好，只是现在我想通过使其更方便使用来增强它（例如，将字符串流传递给日志函数）。

这就是我一直在尝试的方法，但没有成功。

定义：

void LogStream( std::stringstream i_Log ){ m_FileHandle << i_Log << std::endl; }

调用：

m_LogObject->LogStream( "MKLBSearchEngine::Search( " << x << ", " << i_Filter << " ) - 未找到结果” );

Answer 1

您的解决方案存在几个问题。第一个是你是
按值传递stringstream，并且不支持复制。你需要
通过参考。第二个是在调用站点，返回值
operator<< 重载是 ostream&，而不是 stringstream，并且因为
stringstream 不是 ostream& 的基类（这是另一种方式
round），您无法初始化 stringstream （或 stringstream&）
与它。最后，没有 operator<< 需要一个
stringstream 作为右侧参数，因此语句中
LogStream 功能无法工作。最后，这将有点
无论如何对于用户来说都很尴尬。日志operator<<都是非会员，
使用 ostream& 非常量引用作为第一个参数，所以你不能
使用临时参数作为左参数来调用它们。 （在您的示例调用中，
当然，无论如何，您忘记创建 std::ostringstream ；它
不会编译，因为没有重载 << ，它需要一个 char
const[] 或 char const* 作为其左侧操作数。）

几乎所有这些问题都有解决方法。某物
like：

void LogStream( std::ostream& text )
{
    std::ostringstream& s = dynamic_cast<std::ostringstream&>(text);
    m_FileHandle << s.str() << std::endl;
}

处理除最后一个之外的所有问题；最后必须处理
由客户端执行，类似于：（

m_LogObject->LogStream( std::ostringstream().flush() << "..." << x );

对 std::ostream::flush() 的调用返回一个非常量引用
流，可用于进一步初始化 std::ostream&。
虽然您无法使用临时变量初始化非常量引用，
您可以在其上调用非常量成员函数。）

对于客户端代码来说，这种尴尬使我通常更喜欢
更复杂的解决方案。我定义了一个特殊的 LogStreamer 类，
类似于：

class LogStreamer
{
    boost::shared_ptr< std::ostream > m_collector;
    std::ostream* m_dest;

public:
    LogStreamer( std::ostream& dest )
        , m_collector( new std::ostringstream )
        , m_dest( &dest )
    {
    }
    ~LogStreamer()
    {
        if ( m_collector.unique() ) {
            *m_dest << m_collector->str() << std::endl;
        }
    }
    template <typename T>
    LogStreamer& operator<<( T const& value )
    {
        *m_collector << value;
        return *this;
    }
};

然后

LogStreamer LogStream() { return LogStreamer( m_FileHandle ); }

客户端代码可以编写：

m_LogObject->LogStream() << "..." << x;

在我自己的代码中：日志对象始终是单例，调用是
通过宏，将 __FILE__ 和 __LINE__ 传递给 LogStream()
函数，最终目标ostream是一个特殊的streambuf，带有
特殊函数，由 LogStream() 调用，它接受一个文件名和一个
行号，在开始时输出它们以及时间戳
下一行输出，并缩进所有其他行。一个过滤
Streambuf 类似于：（

class LogFilter : public std::streambuf
{
    std::streambuf* m_finalDest;
    std::string m_currentHeader;
    bool m_isAtStartOfLine;
protected:
    virtual int overflow( int ch )
    {
        if ( m_isAtStartOfLine ) {
            m_finalDest->sputn( m_currentHeader.data(), m_currentHeader.size() );
            m_currentHeader = "    ";
        }
        m_isAtStartOfLine = (ch == '\n');
        return m_finalDest->sputc( ch );
    }
    virtual int sync()
    {
        return m_finalDest->sync();
    }

public:
    LogFilter( std::streambuf* dest )
        : m_finalDest( dest )
        , m_currentHeader( "" )
        , m_isAtStartOfLine( true )
    {
    }
    void startEntry( char const* filename, int lineNumber )
    {
        std::ostringstream header;
        header << now() << ": " << filename << " (" << lineNumber << "): ";
        m_currentHeader = header.str();
    }
};

函数 now() 当然，返回一个 std::string ，其中
时间戳。或者一个 struct tm，并且您已经为 tm 编写了一个 <<。）

Answer 2

你的设计有问题。您不想接受流作为参数，要么接受字符串，要么让您的类表现为流（或两者）。

如果您使对象表现为流，则执行以下操作：

m_LogObject << "what to log" << etc;

为此，只需重写 << 运算符即可。

Answer 3

您的调用应该如下所示，

m_LogObject->LogStream( stringstream() << "MKLBSearchEngine::Search( " << x
 << ", " << i_Filter << " ) - No Results Found" );

因为您需要创建要传递给函数的 stringstream 对象。

此调用意味着您已经有了所需的输出流，因此我还建议您更改类设计以使用 operator<< 进行日志记录，除非它已经过载。

Answer 4

您的函数调用将不起作用，因为 "MKLBSearchEngine::Search( " 的类型为 const char* 并且 << 运算符没有重载。它也不适用于 std::string("MKLBSearchEngine::Search( ") ，因为 std::string 也没有这样的运算符。可以做的是调用它std::stringstream("MKLBSearchEngine::Search( ")，它将第一个参数转换为流，以便以下运算符在此流上工作。但正如其他人指出的那样，您必须将函数参数设置为 const 引用，因为流不可复制（即使这样，效率也会很低）。此外，仅将 std::stringstream 写入文件也不会执行您想要的操作（如果）。无论如何它都有效），相反你必须获取其内容（底层 std::string ）。因此，您的所有代码应该如下所示：

void LogStream( const std::stringstream &i_Log ){ m_FileHandle << i_Log.str() << std::endl; }
...
m_LogObject->LogStream( std::stringstream("MKLBSearchEngine::Search( ") << x << ", " << i_Filter << " ) - No Results Found" );

但您也可以只使用 LogString(const std::string &)< /code> 并让该函数的用户自己调用 stream.str() 。

Answer 5

您无法按值传递流对象（因为它们不可复制），因此您需要传递（并存储）引用：

void LogStream(std::stringstream& i_Log){
    m_FileHandle << i_Log << std::endl;
}

这可能不会达到您所期望的效果（它可能会打印 i_Log 的地址，出于相当模糊的原因）。

如果您的目的是从字符串流中取出内容，这可能会满足您的要求：

i_Log.get( *m_FileHandle.rdbuf() );

Answer 6

您正在按值传递 std::stringstream 实例。您希望避免复制并通过引用（或指针）传递它。例如：

void LogStream ( std::stringstream & i_Log ){ m_FileHandle << i_Log << std::endl; }

阅读有关 C++ 参考的更多信息。