c++同步日志打印

在我们日常开发中,有时需要进行调试输出一些日志来查看程序运行的结果,若使用C库函数printf函数,我们要知道对应的变量是何类型,而且printf函数并不能输出c++的类.若我们要使用std::cout,又会显得代码很长,使用起来很不方便,所以我们封装一个简单的同步日志模块

c++11实现Trace

我们使用c++11的可变参数模板来实现,这样就可以很方便的打印多个参数,提高我们的编程效率,再用不用写一堆std::cout<<""<<""<<""<<std::endl了

先定义一个trace函数模板,这里我们用到万能引用和完美转发,对于左值和右值都不会进行拷贝,效率杠杠滴!

template<typename T,typename... Args>
inline void trace(T &&tmp,Args&& ...args)
{
    std::cout << tmp;
    trace(std::forward<Args>(args)...);
}

由于我们使用了可变参数模板,所以我们必须将所有参数展开,可变参的展开也很简单,我们可以利用递归的思想,若果参数大于0,我们就打印输出 ,并且用剩下的参数再次调用trace函数,当参数等于0时,我们就打印换行,此时调用就结束了

利用c++函数重载性质,我们定义一个没有参数的trace函数,来作为递归调用终止的条件

inline void trace()
{
    std::cout <<  std::endl;
}

c++17实现Trace

由于函数的参数个数在编译期就已经确定好了,所以我们可以利用c++17的if constexpr来编写可变参模板,在编译期进行判断.判断的思想是一样的,但是我们无需编写一个没有参数的trace函数来作为递归的终止条件,得益于 if constexpr 我们可以像运行期一样编写if else的代码来进行条件选择。

template<typename T ,typename... Args>
inline void trace(T&& tmp , Args&&... args)
{
    if constexpr(sizeof...(args)  > 0)
    {
        std::cout << tmp;
        trace(std::forward<Args>(args)...);
    }else
    {
        std::cout << tmp <<std::endl;
    }
}

完整代码

我们可以添加一个宏,将打印位置的函数名和行号加进来,这样更利于我们进行DEBUG

#define TRACE(...) trace("[",__FILE__,":",__func__,":",__LINE__,"] :",__VA_ARGS__);

到这我们就大功告成了,但是我们使用了c++11和17编写了两个版本的trace函数,编译时可能会由于选择c++版本不一致而引发编译错误,所以我们使用cplusplus这个宏来进行条件编译,若__cplusplus >= 201703L我们就编译c++17版的trace函数,否则就编译c++11版的trace函数,

完整的代码如下:

#pragma once
#include <iostream>

#define TRACE(...) trace("[",__FILE__,":",__func__,":",__LINE__,"] :",__VA_ARGS__);

#if __cplusplus >= 201703L
template<typename T ,typename... Args>
inline void trace(T&& tmp , Args&&... args)
{
    if constexpr(sizeof...(args)  > 0)
    {
        std::cout << tmp << " ";
        trace(std::forward<Args>(args)...);
    }else
    {
        std::cout << tmp <<std::endl;
    }
}
#elif __cplusplus >= 201103L
inline void trace()
{
    std::cout <<  std::endl;
}

template<typename T,typename... Args>
inline void trace(T &&tmp,Args&& ...args)
{
    std::cout << tmp << " ";
    trace(std::forward<Args>(args)...);
}

#endif

使用案例

当我们想要打印某个函数的参数时,若我们使用std::cout,代码就会很长,写起来也感觉很烦人(本来找不出bug就挺烦了)

#include "Trace.hpp"
void func1(int a,float b,double c,std::string str)
{
    std::cout << " a = " << a << " b = " << b << "c = " << c << " str = " <<str << std::endl;
    
}
int main()
{

    
    func1(1,2,3,"123");
    return 0;
}

但是有了这个小工具,我们可以这样写:

void func1(int a,float b,double c,std::string str)
{
    TRACE("a =",a,"b =", b , "c =",c, "str =",str);
}

运行结果如下:文件名,函数名,行号,结果都一并显示出来,我们就可以快速定位可能出问题的区域