＆LT;＆LT;运算符在C ++中重载以进行日志记录

Question

我有一个C ++类，我在其中放置了许多std :: cout语句来打印有关此类正在处理的大量信号的信息性文本消息。我的目的是将这些文本消息重定向到名为log的函数。在这个函数中，我有一个名为mVerbose的标志，它定义是否应该打印日志文本。该功能的内容如下：

 void XXXProxy::log(std::stringstream& ss)
 {
   if(mVerbose)
   {
     std::cout << ss;
     ss << "";
   }
 }

然后，此函数的调用者代码片段如下：      std :: stringstream logStr;

 logStr << "SE"
        << getAddr().toString()
        << ": WAITING on epoll..."
        << std::endl;      
 log(logStr);

我想重载＆lt;＆lt;运行在我的XXXProxy中的方式，我可以摆脱创建一个std :: stringstream对象并调用日志函数。我希望能够如下记录短信，并让＆lt;＆lt;运营商将所有内容汇总到：

 << "SE"
 << getAddr().toString()
 << ": WAITING on epoll..."
 << std::endl;      

所以我希望有一个成员＆lt;＆lt;功能看起来像：

 void XXXProxy::operator << (std::stringstream& ss)
 {
   if(mVerbose)
   {
     std::cout << ss;
     ss << "";
   }
 } 

问题

我是一个相对新手的C ++开发人员，在编写上述类似＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;＆lt;运营商。您能否提出一些建议或指导我一些链接，以便我正确实施此＆lt;＆lt;运营商。感谢。

Answer 1

如果您不想直接使用std::cout，您希望拥有自己的Log类，则可以实现一个简单的包装器，提供std::ostream的相同接口：运算符＆lt;＆lt; ; ：

class Log {
private: 
    std::ostream& _out_stream;

    //Constructor: User provides custom output stream, or uses default (std::cout).
    public: Log(std::ostream& stream = std::cout): _out_stream(stream) {} 

    //Implicit conversion to std::ostream
    operator std::ostream() {
        return _out_stream;
    } 

    //Templated operator>> that uses the std::ostream: Everything that has defined 
    //an operator<< for the std::ostream (Everithing "printable" with std::cout 
    //and its colleages) can use this function.    
    template<typename T> 
    Log& operator<< (const T& data) 
    {
        _out_stream << data;
    }
}

因此，如果您为类实现std::ostream& operator>>(std::ostream& os , const YourClass& object)，则可以使用此Log类 这种方法的优点是你使用相同的机制来使std::cout << your_class_object工作，并使类使用Log。

实施例

struct Foo
{
    int x = 0; //You marked your question as C++11, so in class initializers 
               //are allowed. 

    //std::ostream::operator<< overload for Foo:
    friend std::ostream& operator<<(std::ostream& os , const Foo& foo)
    {
        os << foo.x;
    }
};

int main()
{
  Log my_log;
  Foo my_foo;

  my_foo.x = 31415;

  my_log << my_foo << std::endl; //This prints "31415" using std::cout.
}

可能的改进：

• 您可以编写一个extern const类Log，并使该类实现singleton。这允许在程序中的任何位置访问日志。
• 它在日志输出中很常见，有一个标题，如 Log output (17:57): log message 。为此，您可以使用std::endl作为哨兵;并存储一个标志，表示下一个输出是一行的开头（日志消息的开头）。 Ckeckout the next answer以获得完整且有效的实施。

参考：

• std::ostream
• operator<< for std::ostream
• std::enable_if
• std::is_same
• decltype specifier

Answer 2

示例的时间戳只是一个例子：）。

但如果你喜欢，我们可以尝试实现它。值得庆幸的是，对于C ++ 11及其STL的重大改进，我们有一个出色的时间/日期API：std::chrono

std::chrono基于三个方面：

• <强>时钟
• 的持续时间
• 时间点

此外，chrono提供三种类型的时钟，std::system_clock，std::steady_clock和std::high_resolution_clock。在我们的例子中，我们使用std::system_clock（我们希望访问日期时间，而不是确定精确的时间间隔）。
有关std :: chrono的更多信息，请结帐this awsome Bo Qian's youtube tutorial。

因此，如果我们必须为日志标题实现时间戳，我们可以这样做：

编辑：与其他好东西一样，C ++模板在您过度使用之前都是不错的工具。
我们的问题是std::endl是一个模板化的函数，所以我们不能直接传递给它 另一个模板化函数作为参数（在我们的例子中是operator<<），因为编译器不能直接推导出std :: endl模板argumments。那是周期性错误“未解决的重载函数类型”。

但是有一种更简单的方法可以做到这一点：仅对operator<<使用std::endl的显式重载，而对其他所有内容使用其他模板：

class Log
{
private:
    std::ostream& _out_stream;
    bool         _next_is_begin;

    const std::string _log_header;
    using endl_type = decltype( std::endl ); //This is the key: std::endl is a template function, and this is the signature of that function (For std::ostream).

public:
    static const std::string default_log_header;

    //Constructor: User passes a custom log header and output stream, or uses defaults.
    Log(const std::string& log_header = default_log_header , std::ostream& out_stream = std::cout) : _log_header( log_header ) , _out_stream( out_stream ) , _next_is_begin( true ) {}

    //Overload for std::endl only:
    Log& operator<<(endl_type endl)
    {
        _next_is_begin = true;

        _out_stream << endl;

        return *this;
    }

    //Overload for anything else:
    template<typename T>           
    Log& operator<< (const T& data) 
    {
        auto now        = std::chrono::system_clock::now();
        auto now_time_t = std::chrono::system_clock::to_time_t( now ); //Uhhg, C APIs...
        auto now_tm     = std::localtime( &now_time_t ); //More uhhg, C style... 

        if( _next_is_begin )
            _out_stream << _log_header << "(" << now_tm->tm_hour << ":" << now_tm->tm_min << ":" << now_tm->tm_sec << "): " << data;
        else
            _out_stream << data;

        _next_is_begin = false;

        return *this;
    }
};

const std::string Log::default_log_header = "Log entry";

此代码段完美无缺。我推动了完整的实施to my github account。

参考：

• std::chrono
• std::chrono::system_clock
• std::chrono::system_clock::now()
• std::time_t
• std::chrono::system_clock::to_time_t()
• std::tm
• std::localtime()