C++ – single header跨平台高效开源日志库Easylogging++的配置和使用

1 Easylogging++

Easylogging++是一个只有单个头文件的开源跨平台日志库，拥有简单易集成，速度极快，线程安全，高效并可配置可扩展等等优点，现在也是我的主力日志库。

1.1 下载Easylogging++

Github地址：https://github.com/amrayn/easyloggingpp

从Githu下载Easylogging++，下载下来只有两个文件，easylogging++.h和easylogging++.cc。

1.1 在VS中配置Easylogging++

右键项目-属性-C++-常规-附加包含项目，添加easylogging++.h所在目录

将easylogging++.cc添加到项目中。

1.2 使用Easylogging++

(1) 包含头文件

// easylogging++
#define ELPP_THREAD_SAFE
#include "easylogging++.h"

(2) 初始化Easylogging++

INITIALIZE_EASYLOGGINGPP

(3) 设置日志输出配置

static void InitEasyloggingPP()
{
    el::Configurations conf;

    // 启用日志
    conf.setGlobally(el::ConfigurationType::Enabled, "true");

    //设置日志文件目录以及文件名
    conf.setGlobally(el::ConfigurationType::Filename, "log\\log_%datetime{%Y%M%d %H%m%s}.log");

    //设置日志文件最大文件大小
    conf.setGlobally(el::ConfigurationType::MaxLogFileSize, "20971520");

    //是否写入文件
    conf.setGlobally(el::ConfigurationType::ToFile, "true");

    //是否输出控制台
    conf.setGlobally(el::ConfigurationType::ToStandardOutput, "true");

    //设置日志输出格式
    conf.setGlobally(el::ConfigurationType::Format, "[%datetime] [%loc] [%level] : %msg");

    //设置日志文件写入周期，如下每100条刷新到输出流中
    conf.setGlobally(el::ConfigurationType::LogFlushThreshold, "100");

    //设置配置文件
    el::Loggers::reconfigureAllLoggers(conf);
}

(4) 示例程序

// easylogging++
#include "easylogging++.h"

#define ELPP_STL_LOGGING
#define ELPP_THREAD_SAFE

INITIALIZE_EASYLOGGINGPP

static void InitEasyloggingPP()
{
    el::Configurations conf;

    // 启用日志
    conf.setGlobally(el::ConfigurationType::Enabled, "true");

    //设置日志文件目录以及文件名
    conf.setGlobally(el::ConfigurationType::Filename, "log\\log_%datetime{%Y%M%d %H%m%s}.log");

    //设置日志文件最大文件大小
    conf.setGlobally(el::ConfigurationType::MaxLogFileSize, "20971520");

    //是否写入文件
    conf.setGlobally(el::ConfigurationType::ToFile, "true");

    //是否输出控制台
    conf.setGlobally(el::ConfigurationType::ToStandardOutput, "true");

    //设置日志输出格式
    conf.setGlobally(el::ConfigurationType::Format, "[%datetime] [%loc] [%level] : %msg");

    //设置日志文件写入周期，如下每100条刷新到输出流中
    conf.setGlobally(el::ConfigurationType::LogFlushThreshold, "100");

    //设置配置文件
    el::Loggers::reconfigureAllLoggers(conf);
}

int main()
{
    InitEasyloggingPP();

    LOG(INFO) << "Hello World";
}

1.3 禁止生成默认日志文件myeasylog.log

使用上述代码会出现一个问题，就是不管你有没有自定义你的日志文件目录，都会在程序根目录生成一个默认日志文件myeasylog.log，但是有的时候我们是不需要这个日志文件的。

在Easyloging++的官方文档中，提到我们可以使用ELPP_NO_DEFAULT_LOG_FILE来禁止生成默认日志文件myeasylog.log。

不过这里需要注意的是，我们需要在编译期就定义这个宏，比如在Visual Studio的项目属性 - C/C++ - 预处理器中增加ELPP_NO_DEFAULT_LOG_FILE。

或者使用CMake编译项目时，增加以下宏定义

# if (!MSVC)
    add_definitions("-DELPP_NO_DEFAULT_LOG_FILE")
# endif ()

还有一个更加简单的方法是，在easylogging++.cc文件的最开始，也就是包含easylogging++.h头文件之前定义ELPP_NO_DEFAULT_LOG_FILE，比如

#define ELPP_NO_DEFAULT_LOG_FILE
#include "easylogging++.h"