C/C++编程：log4cpp使用学习

Qter

[color=rgba(0, 0, 0, 0.75)]简介

Log4cpp是一个开源的C++类库，它提供了在C++程序中使用日志和跟踪调试的功能。使用log4cpp，可以很便利地将日志或者跟踪调试信息写入字符流、内存字符串队列、文件、回滚文件、调试器、Windows日志、本地syslog和远程syslog服务器中。

Log4cpp有如下优点：

• 提供了可扩展的多种日志记录方式；
• 提供了NDC(嵌套诊断上下文)，可用于多线程、多场景的跟踪调试；
• 提供了完整的日志动态优先级控制，可随时调整需要记录的日志优先级
• 可通过配置文件完成所有配置并动态加载；
• 性能优秀，内存占用小，经过编译后的log4cpp.dll大小仅有160kb；
• 代码级的平台无关性，Log4cpp源代码经过编译后，适用于大多数主流的操作系统和开发工具；
• 概念清晰，学习和使用方便，熟练程序员一天之内即可很好地应用log4cpp进行开发。
  

Log4cpp的主页为：http://sourceforge.net/projects/log4cpp/

安装

（1）下载:

wget https://nchc.dl.sourceforge.net/project/log4cpp/log4cpp-1.1.x%20%28new%29/log4cpp-1.1/log4cpp-1.1.3.tar.gz

• 1
  

（2）编译安装

tar zxvf log4cpp-1.1.3.tar.gzcd log4cpp./configure --with-pthreads./configuremakemake install

• 1
• 2
• 3
• 4
• 5
• 6
  

（3）添加环境变量

vim /etc/profile.d/log4cpp.sh

• 1
  

在文件中添加:

LD_LIBRARY_PATH=:$LD_LIBRARY_PATH:/usr/local/lib export LD_LIBRARY_PATH

• 1
  

修改文件权限

chmod a+x /etc/profile.d/log4cpp.shldconfig -v

• 1
• 2
  

安装好后, 在编译源码文件时要加上-llog4cpp -lpthread来链接动态库

cmake_minimum_required(VERSION 3.1)project (log4cpptest)# 设置C++标准为 C++ 11set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -W -Wall -Wextra -g")include_directories(/usr/local/include/)link_directories(/usr/local/lib)include_directories(${CMAKE_CURRENT_SOURCE_DIR})# test1add_executable(${PROJECT_NAME}  main.cpp)target_link_libraries(${PROJECT_NAME}  log4cpp pthread)

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
  

使用

log4cpp库中主要分三大类：Category（种类）、Appender（附加目的地）、Layout（布局）

• category类是日志记录的主要执行类，相当于log4j中的Logger，它负责写日志，就是执行debug(Object msg)、info(Object msg)、warn(Object msg)、error(Object msg)等方法。
• appender类用来指明目的地，即日志要写到什么地方去。log4cpp已经实现了多种不同目标的输出方式，可以向文件输出日志、向控制台输出日志、向Socket输出日志等。
• layout类指明日志输出的格式
  

此外还有Priority(优先级)和NDC(嵌套的诊断上下文)等。

• Priority被用来指定Category的优先级和日志的优先级
• NDC则是一种用来区分不同场景中交替出现的日志的手段。
  

log4cpp记录日志的原理如下：

• 每一个Category都有一个优先级，该优先级可以由setPriority方法设置，或者从其父Category中继承而来
• 每条日志也有一个优先级，当Category记录该条日志时，如果日志优先级高于Category的优先级时，该日志被记录，否则被忽略
  

Category、Appender和Layout三者的关系如下：

• 系统中可以有多个Category，它们都是继承自同一个根，每个Category负责记录自己的日志
• 每个Category可以添加多个Appender，每个Appender指定了一个日志的目的地，比如文件、网络、终端
• 当Category记录一条日志时，该复制被写入到所有附加到此Category的Appender
• 每个Appender都包含一个Layout，该Layout定义了这个Appender上日志的格式
  

应用时的大概流程：

• 定义一个logout类对象，确定输出日志信息的格式
• 定义一个appender类对象，确定日志输出到什么地方，然后把layout对象用setlayout方法绑定一下
• 定义一个category对象，与appender类对象绑定
• 调用category对象进行写日志
  

简单示例：

#include "log4cpp/Category.hh"#include "log4cpp/FileAppender.hh"#include "log4cpp/BasicLayout.hh"#include "log4cpp/SimpleLayout.hh"int main() {    log4cpp::Layout *layout = new log4cpp::SimpleLayout();    log4cpp::Appender *appender = new log4cpp::FileAppender("FileAppender", "./log_name.log");    appender->setLayout(layout);    log4cpp::Category& warn_log = log4cpp::Category::getInstance("mywarn");     // 是一个单例工厂    warn_log.setAppender(appender);    warn_log.setPriority(log4cpp::Priority::WARN);    warn_log.info("rogram info which cannot be wirten");    warn_log.debug("This debug message will fail to write");    warn_log.alert("Alert info");    warn_log.log(log4cpp::Priority::WARN, "This will be a logged warning");    log4cpp::Priority::PriorityLevel priority;    bool this_is_critical = true;    if(this_is_critical)    {        priority = log4cpp::Priority::CRIT;    }    else    {        priority = log4cpp::Priority::DEBUG;    }    warn_log.log(priority,"Importance depends on context");    log4cpp::Category::shutdown();    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
  

效果：在当前目录下生成了一个log_name.log，内容如下

layout布局—日志输出格式

layout对象规定了日志输出的内容格式，创建后需要和append对象绑定生效。注意，一个布局仅能绑定一个appender对象。

比较常用的布局有两种：log4cpp::BasicLayout和log4cpp:atternLayout

log4cpp::BasicLayout

log4cpp::BasicLayout是最简单的布局，输出时间戳，消息优先级和消息内容

#include<iostream>#include"log4cpp/Category.hh"#include"log4cpp/OstreamAppender.hh"#include"log4cpp/BasicLayout.hh"#include"log4cpp/Priority.hh"int main() {    log4cpp::Appender *osAppender = new log4cpp::OstreamAppender("OstreamAppender",&std::cout);    osAppender->setLayout(new log4cpp::BasicLayout);    log4cpp::Category& root =log4cpp::Category::getRoot();    root.addAppender(osAppender);    root.setPriority(log4cpp::Priority::DEBUG);    root.error("Hello log4cpp in aError Message!");    root.warn("Hello log4cpp in aWarning Message!");    log4cpp::Category::shutdown();    return 0;}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
  

效果：在终端输出的日志格式如下

log4cpp:atternLayout

log4cpp:atternLayout布局支持通过类似print函数的格式控制符的方式自定义输出的信息和内容。通过如下函数进行设置（ConversionPattern 参数解读，参阅源码 log4cpp-0.3.5rc3\src\PatternLayout.cpp ）：

log4cpp::PatternLayout::setConversionPattern (conststd::string& conversionPattern) ;

• 1
  

该函数接收的参数为格式控制字符串，其中符号含义如下：

%c： 记录日志的category对象名称； %d： 日期；日期可以进一步的设置格式，用花括号包围，例如%d{%H:%M:%S,%l} 或者 %d{%d %m %Y%H:%M:%S,%l}。如果不设置具体日期格式，则如下默认格式被使用“Wed Jan 02 02:03:55 1980”。日期的格式符号与ANSI C函数strftime中的一致。但增加了一个格式符号%l，表示毫秒，占三个十进制位。 %m： 要输出的日志消息字符串； %n 换行符，会根据平台的不同而不同，但对于用户透明； %p 优先级，warn，debug，info等待； %r 自从layout被创建后的毫秒数； %R 从1970年1月1日0时开始到目前为止的秒数； %u 进程开始到目前为止的时钟周期数； %x NDC

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
  

实例代码：

#include <iostream>#include <log4cpp/Category.hh>#include <log4cpp/OstreamAppender.hh>#include <log4cpp/PatternLayout.hh>#include <log4cpp/Priority.hh>using namespace std;using namespace log4cpp;int main(void){    //指定日志输出目的地，只能对应一个Category    OstreamAppender * pOsApender =            new OstreamAppender("osApender", &cout);    //格式化日志信息    PatternLayout * ptnLyt = new PatternLayout();    ptnLyt->setConversionPattern("%d: %p %c %x: %m%n");  // 输出不容的格式    pOsApender->setLayout(ptnLyt);    //负责输出日志,输出目的有Appender决定，可以指定多个Appender    Category & root = Category::getRoot();    Category & infoCat = root.getInstance("infoCat");  //  //获取root下的一个实例，因为系统只有一个根，根下可以有多个Category，不能统一直接对root设置样式，除非所有日志记录都采用一样的样式（是一个单例工厂）    infoCat.addAppender(pOsApender);    infoCat.setPriority(Priority::INFO);    //写日志    infoCat.info("system is running!");    infoCat.warn("system has a warning!");    infoCat.error("system has an error, can't find file!");    infoCat.fatal("system has an fatal error, must be shutdown!");    infoCat.info("system shutdown,you can find information in system log");    //关闭Category    Category::shutdown();    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
  

appender

append对象指定日志输出到什么地方去，创建后需要和category对象绑定才能生效。

一个apender只能和一个category对象绑定，但是一个category对象可以有多个appnder，可以输出到多个位置。常用的appender类如下：

• log4cpp::FileAppender // 输出到文件
• log4cpp::RollingFileAppender // 输出到回卷文件，即当文件到达某个大小后回卷
• log4cpp::OstreamAppender // 输出到一个ostream类
• log4cpp::StringQueueAppender // 输出到内存队列
• log4cpp::SyslogAppender // 本地syslog
• log4cpp::RemoteSyslogAppender // 输出到远程syslog服务器
  

其中SyslogAppender和RemoteSyslogAppender需要与Syslog配合使用（Syslog是类Unix系统的一个核心服务，用来提供日志服务）

log4cpp::OstreamAppender

我们在调试程序时，如果没有好用的调试工具，就在代码中加入printf语句，将调试信息打印出来。 OstreamAppender可以将日志记录一个流，如果该流是cout，那会在标准控制台上输出。使用方法：

log4cpp::OstreamAppender* osAppender = newlog4cpp::OstreamAppender("osAppender", &cout);

• 1
  

第一个参数指定OstreamAppender的名称，第二个参数指定它关联的流的指针。

log4cpp::StringQueueAppender

但是在调试多线程的时候，不能随意使用printf。因为printf会导致IO中断，会使得本线程挂起，其花费的时间比一条普通指令多数千倍；若多个线程同时运行，则严重干扰了线程间的运行方式。所以调试多线程程序时，最好是将所有调试信息按照顺序写入内存中，程序结束时依次打印出来。

StringQueueAppender就可以很方面的做到这一点。它的功能是将日志记录到一个字符串队列中，该字符串队列使用了STL中的两个容器，即字符串容器std::string和队列容器std::queue，具体如下：

std::queue<std::string> _queue;

• 1
  

_queue变量是StringQueueAppender类中用于具体存储日志的内存队列。StringQueueAppender的使用方法与OstreamAppender类似，其创建函数只接收一个参数“名称”，记录完成后需要程序员自己从队列中取出每条日志。示例如下：

// FileName: test_log4cpp1.cpp#include "log4cpp/Category.hh"#include "log4cpp/FileAppender.hh"#include<iostream>#include<log4cpp/Category.hh>#include<log4cpp/OstreamAppender.hh>#include<log4cpp/BasicLayout.hh>#include<log4cpp/Priority.hh>#include<log4cpp/StringQueueAppender.hh>using namespace std;// 编译 g++ -o 2-test_log4cpp 2-test_log4cpp.cpp -llog4cppint main(int argc, char *argv[){    log4cpp::StringQueueAppender *strQAppender = new log4cpp::StringQueueAppender("strQAppender");    strQAppender->setLayout(new log4cpp::BasicLayout());    log4cpp::Category & root = log4cpp::Category::getRoot();    root.addAppender(strQAppender);    root.setPriority(log4cpp::Priority::DEBUG);    root.error("Hello log4cpp in a Error Message!");    root.warn("Hello log4cpp in a WarningMessage!");    cout<<"Get message from MemoryQueue!"<<endl;    cout<<"-------------------------------------------"<<endl;    queue<string>& myStrQ =strQAppender->getQueue();    while (!myStrQ.empty()){        std::cout << myStrQ.front();        myStrQ.pop();    }    log4cpp::Category::shutdown();    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
  

FileAppender和RollingFileAppender

FileAppender和RollingFileAppender是log4cpp中最常用的两个Appender，其功能是将日志写入文件中。它们之间唯一的区别就是前者会一直在文件中记录日志(直到操作系统承受不了为止)，而后者会在文件长度到达指定值时循环记录日志，文件长度不会超过指定值

#include <iostream>#include <log4cpp/Category.hh>#include <log4cpp/Appender.hh>#include <log4cpp/FileAppender.hh>#include <log4cpp/Priority.hh>#include <log4cpp/PatternLayout.hh>#include <log4cpp/RollingFileAppender.hh>using namespace std;// 编译 g++ -o 2-test_log4cpp 2-test_log4cpp.cpp -llog4cppint main(int argc, char *argv[){    log4cpp::PatternLayout* pLayout1 = new log4cpp::PatternLayout();    pLayout1->setConversionPattern("%d: %p %c%x: %m%n");        log4cpp::PatternLayout* pLayout2 = new log4cpp::PatternLayout();    pLayout2->setConversionPattern("%d: %p %c%x: %m%n");    log4cpp::Appender* fileAppender = new log4cpp::FileAppender("fileAppender","wxb.log");    fileAppender->setLayout(pLayout1);    log4cpp::RollingFileAppender* rollfileAppender = new log4cpp::RollingFileAppender(            "rollfileAppender","rollwxb.log",5*1024,1); // 超过5k自动回滚，最大文件数为1    rollfileAppender->setLayout(pLayout2);    log4cpp::Category& root =log4cpp::Category::getRoot().getInstance("RootName");    root.addAppender(fileAppender);    root.addAppender(rollfileAppender);    root.setPriority(log4cpp::Priority::DEBUG);    //开始记录日志;    for (int i = 0; i < 100; i++)    {        string strError;        ostringstream oss;        oss << i << ":Root Error Message!";        strError = oss.str();        root.error(strError);    }    log4cpp::Category::shutdown();    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
  

Category

Log4cpp中有一个总是可用并实例化好的Category，即根Category。使用log4cpp::Category::getRoot()可以得到根Category。在大多数情况下，一个应用程序只需要一个日志种类(Category)，但是有时也会用到多个Category，此时可以使用根Category的getInstance方法来得到子Category。不同的子Category用于不同的场合。一个简单的例子CategoryExam如下所示：

#include <iostream>#include <log4cpp/Category.hh>#include <log4cpp/OstreamAppender.hh>#include <log4cpp/FileAppender.hh>#include <log4cpp/BasicLayout.hh>#include <log4cpp/Priority.hh>using namespace std;int main(int argc, char *argv[){    log4cpp::OstreamAppender *osAppender1 =  new log4cpp::OstreamAppender("osAppender1",&cout);    log4cpp::OstreamAppender*osAppender2 = new log4cpp::OstreamAppender("osAppender2",&cout);    osAppender2->setLayout(new log4cpp::BasicLayout());    log4cpp::Category &root = log4cpp::Category::getRoot();    root.setPriority(log4cpp::Priority::DEBUG);   // root.addAppender(osAppender1);  //  root.error("aaaaa");    log4cpp::Category &sub1 = root.getInstance("sub1");    sub1.addAppender(osAppender1);    sub1.setPriority(log4cpp::Priority::DEBUG);    sub1.error("suberror");    log4cpp::Category& sub2 =root.getInstance("sub2");    sub2.addAppender(osAppender2);    sub2.setPriority(101);    sub2.warn("sub2warning");    sub2.fatal("sub2fatal");    sub2.alert("sub2alert");    sub2.crit("sub2crit");    log4cpp::Category::shutdown();    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
  

这个例子中共有三个Category，分别是根、sub1和sub2，其中sub1记录了一条日志，sub2记录了两条日志。Sub2另外两个日志由于优先级不够未能记录。

层级

Category（可以看成是Logger）的层级是category名字指定的，如x.y 表示两层，x层和y层，x是y的父层级，x.y所在层级是y层级

Category中有一个属性additivity：

• 当值为false时，表示当前logger不需要达到父层级所指定的appender，只需要当前的appender；
• 当值为true时，表示当前logger将打印日志到当前的appender及所有的父层级所指定的appender
  

NDC

NDC是nested DiagnosticContext的缩写，意思是“嵌套的诊断上下文”。NDC是一种用来区分不同源代码中交替出现的日志的手段。当一个服务端程序同时记录好几个并行客户时，输出的日志会混杂在一起难以区分。但如果不同上下文的日志入口拥有一个特定的标识，则可以解决这个问题。NDC就是在这种情况下发挥作用。注意NDC是以线程为基础的，每个线程拥有一个NDC，每个NDC的操作仅对执行该操作的线程有效。

NDC的几个有用的方法是：push、pop、get和clear。注意它们都是静态函数：

• Push可以让当前线程进入一个NDC，如果该NDC不存在，则根据push的参数创建一个NDC并进入;如果再调用一次push，则进入子NDC;
• Pop可以让当前线程从上一级NDC中退出，但是一次只能退出一级。
• Clear可以让当前线程从所有嵌套的NDC中退出。
• Get可以得到当前NDC的名字，如果有嵌套，则不同级别之间的名字用空格隔开。
  

#include<iostream>#include<log4cpp/NDC.hh>#include <log4cpp/Category.hh>using namespace log4cpp;int main(int argc, char *argv[){    std::cout<< "1.empty NDC: " <<NDC::get()<< std::endl;    NDC::push("context1");    std::cout<< "2.push context1: " <<NDC::get()<< std::endl;    NDC::push("context2");    std::cout<< "3.push context2: " <<NDC::get()<< std::endl;    NDC::push("context3");    std::cout<< "4.push context3: " <<NDC::get()<< std::endl;    std::cout<< "5.get depth: " <<NDC::getDepth() <<std::endl;    std::cout<< "6.pop: " << NDC::pop()<< std::endl;    std::cout<< "7.after pop:"<<NDC::get()<<std::endl;    NDC::clear();    std::cout<< "8.clear: " << NDC::get() <<std::endl;    log4cpp::Category::shutdown();    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
  

在记录日志的时候，可以从NDC中得知当前线程的嵌套关系。

Log4cpp 的自动内存管理Log4cpp的内存对象管理

在前面的所有代码中，log4cpp中所有动态分配的对象都没有手动释放。

因为log4cpp使用了一个内部类来管理这些对象。此类的名称是HierarchyMaintainer，它负责管理Category的继承关系，在程序结束时，在程序结束时，HierarchyMaintainer会依次释放所有Category，而Category则会依次释放拥有的有效Appender，Appender则会释放所有附属的Layout。如果程序员手动释放这些对象，则会造成内存报错。

从下面的代码可以看出这个特征：

appender->setLayout(newlog4cpp::BasicLayout());

• 1
  

这个new出来的BasicLayout根本就没有保存其指针，所以它只能被log4cpp的内存管理类HierarchyMaintainer释放。

了解到HierarchyMaintainer的内存管理方法后，程序员在使用log4cpp时应该遵循以下几个使用原则：

• 不要手动释放Category、Appender和Layout;
• 同一个Appender不要加入多个Category，否则它会被释放多次从而导致程序崩溃;
• 同一个Layout不要附着到多个Appender上，否则也会被释放多次导致程序崩溃;
  

下面这个简单的程序PointerErrorExam会造成经典的崩溃：

#include <iostream>#include <log4cpp/Category.hh>#include <log4cpp/OstreamAppender.hh>#include <log4cpp/BasicLayout.hh>#include <log4cpp/Priority.hh>using namespace log4cpp;using namespace std;int main(int argc, char *argv[){    log4cpp::OstreamAppender* osAppender = new log4cpp::OstreamAppender("osAppender", &cout);    osAppender->setLayout(new log4cpp::BasicLayout());    log4cpp::Category& root =log4cpp::Category::getRoot();    root.setPriority(log4cpp::Priority::DEBUG);    log4cpp::Category& sub1 =root.getInstance("sub1");    sub1.addAppender(osAppender);    sub1.error("sub1 error");    log4cpp::Category& sub2 =root.getInstance("sub2");    sub2.addAppender(osAppender);    sub2.warn("sub2 warning");    log4cpp::Category::shutdown();    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
  

log4cpp::Category::shutdown()

在不适用log4cpp时可以调用log4cpp::Category::shutdown()，其功能如同HierarchyMaintainer的内存清理。

如果不手动调用，在程序结束时HierarchyMaintainer会调用Category的析构函数来释放所有Appender。

利用配置文件定制日志

如同log4j一样，log4cpp也可以读取配置文件来定制Category、Appender和Layout对象。其配置文件格式基本类似于log4j。

• log4cpp 的 category 分为 rootCategory 和其它自定义的 category。
• 而每个 category 都可以输出到多个 appender。并且 category 也是有包含关系的。
• 例如 rootCategory 就是所有 category 的根。而自定义的 category 也可以在配置文件中定义其包含关系。
  

先看一个 rootCategory 的配置

log4cpp.rootCategory=DEBUG, console, sample

• 1
  

• 这个定义里，指定了 rootCategory 的 log 优先级是 DEBUG，其 appender 有 2 个，分别是 console 和 sample。
• 即是说，等号右边内容以逗号分隔，第一项是优先级别，接下来的都是 appender 名字，可以有一个或多个
  

现在来看看自定义的 category

log4cpp.category.demo=DEBUG, sample

• 1
  

• 这里定义了一个名字为 demo 的 category，其优先级为 DEBUG，appender 为 sample。
  

再来看看有包含关系的 category 的定义

log4cpp.category.demo.son=DEBUG, son log4cpp.category.demo.daughter=DEBUG, daughter

• 1
• 2
  

• 以上定义了 2 个 category，名字分别为 son 和 daughter，其父 category 为 demo。
• son 产生的 log 会写到 son 和 demo 的 appender 中。同理，daughter 的 log 会写到 daughter 和 demo 的 appender 中。
  

现在来看看 appender 的定义。appender 有很多种，比如：

• ConsoleAppender : 控制台输出，即 std::cout
• Win32DebugAppender : VC IDE 的输出，即 ::OutputDebugString
• FileAppender : 文件输出
• RollingFileAppender : 回滚
  

现在看一个 ConsoleAppender 的例子

log4cpp.appender.console=ConsoleAppender log4cpp.appender.console.layout=PatternLayout log4cpp.appender.console.layout.ConversionPattern=%d [%p - %m%n

• 1
• 2
• 3
  

• 以上信息解释为：一个名为 console 的 appender，其类型为 ConsoleAppender，即 控制台输出 log 输出的布局是 指定的样式
  输出的格式 是 “%d [%p] - %m%n”
  

再看一个 FileAppender 的例子

log4cpp.appender.sample=FileAppender log4cpp.appender.sample.fileName=sample.log log4cpp.appender.sample.layout=PatternLayout log4cpp.appender.sample.layout.ConversionPattern=%d [%p - %m%n

• 1
• 2
• 3
• 4
  

• 以上信息解释为：一个名为 sample 的 appender，其类型为 FileAppender，即 文件输出指定的 log 文件名为 sample.log，输出的布局是 指定的样式，输出的格式 是 “%d [%p] - %m%n”
  

对应 category 和 appender 的配置方式，可以发现

• category 是"log4cpp.category." + “categoryname”
• category 名字可以用"."分隔，以标识包含关系
• appender 是"log4cpp.appender." + “appendername”
• appender 名字 不能用 “.” 分隔，即是说 appender 是没有包含关系的
  

一个完整的配置文件log4cpp.conf例子如下:

#log4cpp配置文件#定义Root category的属性log4cpp.rootCategory=DEBUG,RootLog #定义RootLog属性log4cpp.appender.RootLog=ConsoleAppenderlog4cpp.appender.RootLog.layout=PatternLayoutlog4cpp.appender.RootLog.layout.ConversionPattern=%d [%p -%m%n#定义sample category的属性log4cpp.category.sample=DEBUG,sample#定义sample属性log4cpp.appender.sample=FileAppenderlog4cpp.appender.sample.fileName=sample.loglog4cpp.appender.sample.layout=PatternLayoutlog4cpp.appender.sample.layout.ConversionPattern=%d [%p -%m%n#定义sample.soncategory的属性log4cpp.category.sample.son=DEBUG, son#定义son的属性log4cpp.appender.son=FileAppenderlog4cpp.appender.son.fileName=son.loglog4cpp.appender.son.layout=PatternLayoutlog4cpp.appender.son.layout.ConversionPattern=%d[%p - %m%n#定义sample.daughtercategory的属性log4cpp.category.sample.daughter=DEBUG,daughter#定义daughter属性log4cpp.appender.daughter=FileAppenderlog4cpp.appender.daughter.fileName=daughter.loglog4cpp.appender.daughter.layout=PatternLayoutlog4cpp.appender.daughter.layout.ConversionPattern=%d [%p- %m%n

• 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
  

读取配置文件要依赖PropertyConfigurator和SimpleConfigurator类。

#include<iostream>#include<log4cpp/Category.hh>#include<log4cpp/PropertyConfigurator.hh>using namespace log4cpp;using namespace std;int main(int argc, char *argv[){    // 1 读取解析配置文件    // 读取出错, 完全可以忽略，可以定义一个缺省策略或者使用系统缺省策略    // BasicLayout输出所有优先级日志到ConsoleAppender    try {        log4cpp::PropertyConfigurator::configure("../log4cpp.conf");    } catch (log4cpp::ConfigureFailure & f) {        std::cout<< "Configure Problem "<< f.what()<< std::endl;        return -1;    }    // 2 实例化category对象    // 这些对象即使配置文件没有定义也可以使用，不过其属性继承其父category    // 通常使用引用可能不太方便，可以使用指针，以后做指针使用    // log4cpp::Category* root = &log4cpp::Category::getRoot();    log4cpp::Category & log = log4cpp::Category::getInstance(std::string("sample"));    log.debug("test debug log");    log.info("test info log");// 用 sample.son    log4cpp::Category & log1 = log4cpp::Category::getInstance(std::string("sample.son"));    log1.debug("test debug log of son");    log1.info("test info log of son");// 用 sample.daughter    log4cpp::Category & log2 = log4cpp::Category::getInstance(std::string("sample.daughter"));    log2.debug("test debug log of daughter");    log2.info("test info log of daughter");    log4cpp::Category::shutdown();    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
  

该程序首先读入了配置文件log4cpp.conf，从中得到了所有Category、Appender和Layout的优先级和相互附属关系，然后输出了一些日志，其运行结果如下：

配置文件实例log4cpp.rootCategory=DEBUG,rootAppenderlog4cpp.appender.rootAppender=RollingFileAppenderlog4cpp.appender.rootAppender.fileName=amp.loglog4cpp.appender.rootAppender.maxFileSize=8388608log4cpp.appender.rootAppender.maxBackupIndex=10log4cpp.appender.rootAppender.layout=PatternLayoutlog4cpp.appender.rootAppender.layout.ConversionPattern=%d{%Y-%m-%d %H:%M:%S,%l}: %p %c %x: %m%n

• 1
• 2
• 3
• 4
• 5
• 6
• 7
  

本配置文件完成个功能是：
1、输出DEBUG及以上级别的日志(值越小，优先级越高)
2、将日志输出到回滚日志文件中，主文件大小810241024字节，名字是amp.log，
3、备份文件10个(名字是amp.log.1，amp.log.2，amp.log.3，一直到amp.log.10，每个都是主文件大小+1KB，这是log4cpp规定的)
4、输出格式是：时间: 优先级 category名称 NDC名称: 消息 换行，其中时间是“年-月-日 时:分:秒,毫秒”格式

怎么用

#include <iostream>#include "log4cpp/Category.hh"#include "log4cpp/PropertyConfigurator.hh" using namespace std;int main(int argc, char *argv[){         try{                log4cpp::PropertyConfigurator::configure("./log4cpp.conf");        }catch(log4cpp::ConfigureFailure& f){                cout<<f.what()<<endl;        }         log4cpp::Category &cat=log4cpp::Category::getInstance("rootAppender");         cat.info("system is running");        cat.warn("system has a warning");        cat.error("system has a error, can't find a file");        cat.fatal("system has a fatal error,must be shutdown");        cat.info("system shutdown,you can find some information in system log");         log4cpp::Category::shutdown();                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
  

文章知识点与官方知识档案匹配，可进一步学习相关知识
https://blog.csdn.net/zhizhengguan/article/details/123041727