Log4cpp学习笔记

Log4cpp学习笔记

1 Log4cpp简介

Log4cpp是个基于LGPL的开源项目，移植自Java的日志处理跟踪项目log4j，并保持了API上的一致。其类似的支持库还包括Java(log4j)，C++(log4cpp、log4cplus)，C(log4c)，python(log4p)等。

Log4cpp有如下优点：

1. 提供了可扩展的多种日志记录方式；

2. 提供了NDC(嵌套诊断上下文)，可用于多线程、多场景的跟踪调试；

3. 提供了完整的日志动态优先级控制，可随时调整需要记录的日志优先级；

4. 可通过配置文件完成所有配置并动态加载；

5. 性能优秀，内存占用小，经过编译后的log4cpp.dll大小仅有160kb；

6. 代码级的平台无关性，Log4cpp源代码经过编译后，适用于大多数主流的操作系统和开发工具；

7. 概念清晰，学习和使用方便，熟练程序员一天之内即可很好地应用log4cpp 进行开发。

2 Log4cpp组成

Log4cpp中的概念继承自log4j，最重要的是Category(种类)、Appender(附加目的地)和Layout(布局)三个概念，此外还有Priority(优先级)和NDC(嵌套的诊断上下文)等。

layout类控制输出信息的格式和样式。你可以使你的类基于layout，来指定你想要的输出数据的风格。log4cpp自带两个layout类。分别是SimpleLayout和BasicLayout。

appender类用来输出信息到设备上。这些信息已经被layout对象格式化过了。设备可以是标准输出，一个文件或者一个string buffer。你可以得到你自己的appender类如果你想要在一个socket,共享内存缓冲区或者其他一些写延迟设备。loc4cpp自带了3个非常有用的appender类。分别是FileAppender,OstreamAppender,和StringQueueAppender。

category类，Apender 和它的优先级是category的重要组成部分。优先级控制那些可以被特定类记录的日志消息。当category对象被创建时，它会构造一个默认的标准输出的appender,和一个默认的优先级。可以在记录日志的目标列表中添加更多的appender。可以通过NOTSET,DEBUG,INFO,NOTICE,WARN,ERROR,CRIT,ALERT或者FATAL/EMERG，按照递增顺序或者重要等级来设置日志信息。每条信息都被记录到category对象。而消息本身也有一个优先级。如果消息的优先级更高或者与category的优先级相同，记录日志就会发生，否则这条消息会被忽略。category

的优先级顺序如下：NOTSET < DEBUG < INFO < NOTICE < WARN < ERROR < CRIT < ALERT < FATAL = EMERG。

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

Log4cpp记录日志的原理如下：每个Category都有一个优先级，该优先级可以由setPriority方法设置，或者从其父Category中继承而来。每条日志也有一个优先级，当Category记录该条日志时，若日志优先级高于Category的优先级时，该日志被记录，否则被忽略。系统中默认的优先级等级如下：

typedef enum ...{EMERG = 0,

FATAL = 0,

ALERT = 100,

CRIT = 200,

ERROR = 300,

WARN = 400,

NOTICE = 500,

INFO = 600,

DEBUG = 700,

NOTSET = 800

} PriorityLevel;

注意：取值越小，优先级越高。例如一个Category的优先级为101，则所有EMERG、FATAL、ALERT日志都可以记录下来，而其他则不能。

Category、Appender和Layout三者的关系如下：系统中可以有多个Category，它们都是继承自同一个根，每个Category负责记录自己的日志;每个Category可以添加多个Appender，每个Appender指定了一个日志的目的地，例如文件、字符流或者Windows日志，当Category记录一条日志时，该日志被写入所有附加到此Category的Appender;每个Append都包含一个Layout，该Layout定义了这个Appender上日志的格式。

Log4cpp日志记录原理图

3 一个日志记录应用程序的流程

手动使用log4cpp的基本步骤如下：

1.实例化一个layout 对象；

2.初始化一个appender 对象；

3.把layout对象附着在appender对象上；

4.调用log4cpp::Category::getInstance("name"). 实例化一个category

对象；

5.把appender对象附到category上（根据additivity的值取代其他

appender或者附加在其他appender后）。

6.设置category的优先级；

7.记录日志；

8.关闭Category.

9.// FileName: test_log4cpp1.cpp

// Test log4cpp by manual operation.

// Announce: use as your own risk.

// Compile : g++ -otest1 -llog4cpp test_log4cpp1.cpp

// Run : ./test1

// Tested : RedHat 7.2 log4cpp0.3.4b

// Author : liqun (liqun@https://www.360docs.net/doc/4d14827201.html,)

// Data : 2003-6-27

#include "log4cpp/Category.hh"

#include "log4cpp/FileAppender.hh"

#include "log4cpp/BasicLayout.hh"

int main(int argc, char* argv[])

{

// 1实例化一个layout 对象

log4cpp::Layout* layout =

new log4cpp::BasicLayout();

// 2. 初始化一个appender 对象

log4cpp::Appender* appender = new

log4cpp::FileAppender("FileAppender",

"./test_log4cpp1.log");

// 3. 把layout对象附着在appender对象上

appender->setLayout(layout);

// 4. 实例化一个category对象

log4cpp::Category& warn_log =

log4cpp::Category::getInstance("mywarn");

// 5. 设置additivity为false，替换已有的appender

warn_log.setAdditivity(false);

// 5. 把appender对象附到category上

warn_log.setAppender(appender);

// 6. 设置category的优先级，低于此优先级的日志不被记录

warn_log.setPriority(log4cpp::Priority::WARN);

// 记录一些日志

warn_https://www.360docs.net/doc/4d14827201.html,("Program 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");

warn_log.critStream() << "This will show up << as "

<< 1 << " critical message"

<< log4cpp::CategoryStream::ENDLINE;

//关闭Category.

log4cpp::Category::shutdown();

return 0;

}

4 Layout(布局)

首先回顾一下HelloWorld的日志格式，它使用了最简单的BasicLayout：1248337987 ERROR : Hello log4cpp in a Error Message!

1248337987 WARN : Hello log4cpp in a Warning Message!

上面的日志格式还可以，但显然不是许多程序员心中理想的格式，许多人理想的格式应该是这样的：

2009-07-24 15:59:55,703: INFO infoCategory : system is running

2009-07-24 15:59:55,703: WARN infoCategory : system has a warning

2009-07-24 15:59:55,703: ERROR infoCategory : system has a error, cant find a file 2009-07-24 15:59:55,718: FATAL infoCategory : system has a fatal error, must be shutdown

2009-07-24 15:59:55,718: INFO infoCategory : system shutdown, you can find some information in system log

要获得上面的格式，必须使用比BasicLayout复杂的PatternLayout，而且要花一个小时来熟悉一下PatternLayout的格式定义方式，如果你认为值得的话

4.1 PatternLayout

在介绍PatternLayout以前，首先来看看log4cpp中所有的Layout子类(Layout 本身是个虚类)，一共三个：BasicLayout、PatternLayout和SimpleLayout，其中SimapleLayout并不建议使用，而BaiscLayout过于简单，因此如果程序员不自己扩展Layout的话，就只能使用PatternLayout了，值得庆幸的是，PatternLayout 还是比较好用的。

PatternLayout使用setConversionPattern函数来设置日志的输出格式。该函数的声明如下：

void log4cpp::PatternLayout::setConversionPattern ( const std::string & conversionPattern ) throw (ConfigureFailure) [virtual]

其中参数类型为std::string，类似于C语言中的printf，使用格式化字符串来描述输出格式，其具体含义如下：

%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 优先级；

%r 自从layout被创建后的毫秒数；

%R 从1970年1月1日0时开始到目前为止的秒数；

%u 进程开始到目前为止的时钟周期数；

%x NDC。

因此，要得到上述的理想格式，可以将setConversionPattern的参数设置为“%d: %p %c %x: %m%n”，其具体含义是“时间: 优先级Category NDC: 消息换行”。

因此，要得到上述的理想格式，可以将setConversionPattern的参数设置为“%d: %p %c %x: %m%n”，其具体含义是“时间: 优先级Category NDC: 消息换行”。使用PatternLayout的例子程序如下，项目名称是LayoutExam：#include

#include log4cpp/Category.hh>

#include log4cpp/OstreamAppender.hh>

#include log4cpp/Priority.hh>

#include log4cpp/PatternLayout.hh>

using namespace std;

int main(int argc, char* argv[])

...{

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

log4cpp::PatternLayout* pLayout = new log4cpp::PatternLayout();

pLayout->setConversionPattern("%d: %p %c %x: %m%n");

osAppender->setLayout(pLayout);

log4cpp::Category& root = log4cpp::Category::getRoot();

log4cpp::Category& infoCategory = root.getInstance("infoCategory");

infoCategory.addAppender(osAppender);

infoCategory.setPriority(log4cpp::Priority::INFO);

https://www.360docs.net/doc/4d14827201.html,("system is running");

infoCategory.warn("system has a warning");

infoCategory.error("system has a error, can"t find a file");

infoCategory.fatal("system has a fatal error,must be shutdown");

https://www.360docs.net/doc/4d14827201.html,("system shutdown,you can find some information in system log");

log4cpp::Category::shutdown();

return 0;

}

其运行结果即如下所示：

2009-07-24 15:59:55,703: INFO infoCategory : system is running

2009-07-24 15:59:55,703: WARN infoCategory : system has a warning

2009-07-24 15:59:55,718: FATAL infoCategory : system has a fatal error, must be shutdown

2009-07-24 15:59:55,718: INFO infoCategory : system shutdown, you can find some information in system log

5 Appender

笔者认为Appender是log4cpp中最精彩的一个部分。我仔细阅读了大部分Appender的源代码并对设计者感到非常敬仰。Log4cpp中所有可直接使用的Appender列表如下：

log4cpp::IdsaAppender // 发送到IDS或者

log4cpp::FileAppender // 输出到文件

log4cpp::RollingFileAppender // 输出到回卷文件，即当文件到达某个大小后回卷

log4cpp::OstreamAppender // 输出到一个ostream类

log4cpp::RemoteSyslogAppender // 输出到远程syslog服务器

log4cpp::StringQueueAppender // 内存队列

log4cpp::SyslogAppender // 本地syslog

log4cpp::Win32DebugAppender // 发送到缺省系统调试器

log4cpp::NTEventLogAppender // 发送到win 事件日志

其中SyslogAppender和RemoteSyslogAppender需要与Syslog配合使用，因此这里不介绍。顺便提一句，Syslog是类Unix系统的一个核心服务，用来提供日志服务，在Windows系统中并没有直接提供支持，当然可以用相关工具提供Windows系统中的syslog服务。

IdsaAppender的功能是将日志写入Idsa服务，这里也不介绍。因此主要介绍以下Appender：

log4cpp::FileAppender // 输出到文件

log4cpp::RollingFileAppender // 输出到回卷文件，即当文件到达某个大小后回卷

log4cpp::OstreamAppender // 输出到一个ostream类

log4cpp::StringQueueAppender // 内存队列

log4cpp::Win32DebugAppender // 发送到缺省系统调

log4cpp::NTEventLogAppender // 发送到win 事件日志

5.1 OstreamAppender

在我刚刚学习C/C++编程时，一位老师告诉我，如果没有好用的调试工具，就在代码中加入printf语句，将调试信息打印出来(当时在linux下面，确实没有什么易用的c++调试工具)。现在有了OstreamAppender，一切都好办了，它可以将日志记入一个流，如果该流恰好是cout，则会在标准控制台上输出。比printf 优越的是，除了输出消息外，还可以轻松的输出时间、时钟数、优先级等大量有用信息。

OstreamAppender的使用非常简单，在前面的HelloWorld程序中已经见过，创建一个OstreamAppender的具体方法如下：

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

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

5.2 StringQueueAppender

后来一位高手又告诉我“在调试多线程程序时，不能随意使用printf”。因为printf导致IO中断，会使得本线程挂起，其花费的时间比一条普通指令多数千倍，若多个线程同时运行，则严重干扰了线程间的运行方式。所以调试多线程程序时，最好是将所有调试信息按顺序记入内存中，程序结束时依次打印出来。为此当时我们还写了一个小工具，没想到时隔多年，我碰上了StringQueueAppender。

我很怀疑StringQueueAppender被设计出来就是用于记录多线程程序或者实时程序的日志，虽然log4cpp的文档中并没有明确指出这一点。StringQueueAppender的功能是将日志记录到一个字符串队列中，该字符串队列使用了STL中的两个容器，即字符串容器std::string和队列容器std::queue，具体如下：

std::queuestd::string> _queue;

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

#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;

int 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 Warning Message!");

coutmessage from Memory Queue!" cout queue>& myStrQ = strQAppender->getQueue();

while(!myStrQ.empty())

{

cout.front();

myStrQ.pop();

}

log4cpp::Category::shutdown();

return 0;

}

程序输出为：

Get message from Memory Queue!

1248839389 ERROR : Hello log4cpp in a Error Message!

1248839389 W ARN : Hello log4cpp in a Warning Message!

5.3 FileAppender和RollingFileAppender

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

FileAppender的创建函数如下：

/**

Constructs a FileAppender.

@param name the name of the Appender.

@param fileName the name of the file to which the Appender has

to log.

@param append whether the Appender has to truncate the file or

just append to it if it already exists. Defaults to "true".

@param mode file mode to open the logfile with. Defaults to 00644.

**/

FileAppender(const std::string& name, const std::string& fileName,

bool append = true, mode_t mode = 00644);

一般仅使用前两个参数，即“名称”和“日志文件名”。第三个参数指示是否在日志文件后继续记入日志，还是清空原日志文件再记录。第四个参数说明文件的打开方式。

RollingFileAppender的创建函数如下：

RollingFileAppender(const std::string& name,

const std::string& fileName,

size_t maxFileSize = 10*1024*1024,

unsigned int maxBackupIndex = 1,

bool append = true,

mode_t mode = 00644);

它与FileAppender的创建函数很类似，但是多了两个参数：maxFileSize指出了回滚文件的最大值;maxBackupIndex指出了回滚文件所用的备份文件的最大个数。所谓备份文件，是用来保存回滚文件中因为空间不足未能记录的日志，备份文件的大小仅比回滚文件的最大值大1kb。所以如果maxBackupIndex取值为3，则回滚文件(假设其名称是rollwxb.log，大小为100kb)会有三个备份文件，其名称分别是rollwxb.log.1，rollwxb.log.2和rollwxb.log.3，大小为101kb。另外要注意：如果maxBackupIndex取值为0或者小于0，则回滚文件功能会失效，其表现如同FileAppender一样，不会有大小的限制。这也许是一个bug。

例子程序FileAppenderExam如下：

#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;

int 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);

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 strError = oss.str();

root.error(strError);

}

log4cpp::Category::shutdown();

return 0;

}

程序运行后会产生两个日志文件wxb.log和rollwxb.log，以及一个备份文件rollwxb.log.1。wxb.log的大小为7kb，记录了所有100条日志;rollwxb.log大小为2kb，记录了最新的22条日志;rollwxb.log.1大小为6kb，记录了旧的78条日志。

5.4 Win32DebugAppender

Win32DebugAppender是一个用于调试的Appender，其功能是向Windows的调试器中写入日志，目前支持MSVC和Borland中的调试器。创建Win32DebugAppender仅需要一个参数“名称”，其使用非常简单，下面是例子代码DebugAppenderExam：

#include iostream>

#include log4cpp/Category.hh>

#include log4cpp/Appender.hh>

#include log4cpp/Win32DebugAppender.hh>

#include log4cpp/Priority.hh>

#include log4cpp/PatternLayout.hh>

using namespace std;

int main(int argc, char* argv[])

{

log4cpp::PatternLayout* pLayout1 = new log4cpp::PatternLayout();

pLayout1->setConversionPattern("%d: %p %c %x: %m%n");

log4cpp::Appender* debugAppender = new log4cpp::Win32DebugAppender("debugAppender");

debugAppender->setLayout(pLayout1);

log4cpp::Category& root = log4cpp::Category::getRoot().getInstance("RootName");

root.addAppender(debugAppender);

root.setPriority(log4cpp::Priority::DEBUG);

root.error("Root Error Message!");

root.warn("Root Warning Message!");

log4cpp::Category::shutdown();

return 0;

}

5.5 NTEventLogAppender

该Appender可以将日志发送到windows的日志，在运行程序后可以打开windows 的计算机管理?系统工具?事件查看器?应用程序，可以看到下图，注意图中第一行和第二行的两个日志。

例子程序NTAppenderExam如下：

#include

#include log4cpp/Category.hh>

#include log4cpp/Appender.hh>

#include log4cpp/NTEventLogAppender.hh>

#include log4cpp/Priority.hh>

#include log4cpp/PatternLayout.hh>

using namespace std;

int main(int argc, char* argv[])

{

log4cpp::PatternLayout* pLayout1 = new log4cpp::PatternLayout();

pLayout1->setConversionPattern("%d: %p %c %x: %m%n");

log4cpp::Appender* ntAppender = new log4cpp::NTEventLogAppender("debugAppender","wxb_ntlog");

ntAppender->setLayout(pLayout1);

log4cpp::Category& root = log4cpp::Category::getRoot().getInstance("RootName");

root.addAppender(ntAppender);

root.setPriority(log4cpp::Priority::DEBUG);

root.error("Root Error Message!");

root.warn("Root Warning Message!");

log4cpp::Category::shutdown();

return 0;

}

6 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);

osAppender1->setLayout(new log4cpp::BasicLayout());

log4cpp::OstreamAppender* osAppender2 = new

log4cpp::OstreamAppender("osAppender2", &cout);

osAppender2->setLayout(new log4cpp::BasicLayout());

log4cpp::Category& root = log4cpp::Category::getRoot();

root.setPriority(log4cpp::Priority::DEBUG);

log4cpp::Category& sub1 = root.getInstance("sub1");

sub1.addAppender(osAppender1);

sub1.setPriority(log4cpp::Priority::DEBUG);

sub1.error("sub error");

log4cpp::Category& sub2 = root.getInstance("sub2");

sub2.addAppender(osAppender2);

sub2.setPriority(101);

sub2.warn("sub2 warning");

sub2.fatal("sub2 fatal");

sub2.alert("sub2 alert");

sub2.crit("sub2 crit");

log4cpp::Category::shutdown();

return 0;

}

运行结果如下：

1248869982 ERROR sub1 : sub error

1248869982 FATAL sub2 : sub2 fatal

1248869982 ALERT sub2 : sub2 alert

这个例子中共有三个Category，分别是根、sub1和sub2，其中sub1记录了一条日志，

sub2记录了两条日志。Sub2另外两个日志由于优先级不够未能记录。

7 NDC

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

NDC的几个有用的方法是：push、pop、get和clear。注意它们都是静态函数：Push可以让当前线程进入一个NDC，如果该NDC不存在，则根据push的参数创建一个NDC并进入;如果再调用一次push，则进入子NDC;Pop可以让当前线程从上一级NDC中退出，但是一次只能退出一级。Clear可以让当前线程从所有嵌套的NDC中退出。Get可以得到当前NDC的名字，如果有嵌套，则不同级别之间的名字用空格隔开。

一个简单的例子NDCExam如下：

#include iostream>

#include log4cpp/NDC.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;

return 0;

}

该例子来自log4cpp的例子程序，我做了简单的修改。在记录日志的时候，可以从NDC中得知当前线程的嵌套关系。

8 Log4cpp的自动内存管理

8.1 项目的多线程设置

VC中必须将项目设置为Debug MultiThreaded DLL，总之这个设置必须与你使用的Log4cpp库一致。如果你使用的是Release版本的log4cpp.dll，则应该设置为MultiThreaded DLL。否则在程序结束时会报错，报错处的调用堆栈为：

log4cpp::BasicLayout::`vector deleting destructor"(unsigned int 1) + 122 bytes

log4cpp::LayoutAppender::~LayoutAppender() line 21 + 35 bytes

log4cpp::OstreamAppender::~OstreamAppender() line 28 + 15 bytes

log4cpp::OstreamAppender::`vector deleting destructor"(unsigned int 1) + 103 bytes

log4cpp::Category::removeAllAppenders() line 159 + 39 bytes

log4cpp::HierarchyMaintainer::shutdown() line 101 + 27 bytes

log4cpp::HierarchyMaintainer::~HierarchyMaintainer() line 36

8.2 Log4cpp的内存对象管理

也许读者已经注意到，在前面的所有代码中，log4cpp中所有动态分配的对象都没有手动释放。

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

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

appender->setLayout(new log4cpp::BasicLayout());

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

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

1. 不要手动释放Category、Appender和Layout;

2. 同一个Appender不要加入多个Category，否则它会被释放多次从而导致程序崩溃;

3. 同一个Layout不要附着到多个Appender上，否则也会被释放多次导致程序崩溃;

8.3 log4cpp::Category::shutdown()

在不使用log4cpp时可调用log4cpp::Category::shutdown()，其功能如同HierarchyMaintainer的内存清理。但如果不手动调用，在程序结束时HierarchyMaintainer会调用Category的析构函数来释放所有Appender。

9 利用配置文件定制日志

如同log4j一样，log4cpp也可以读取配置文件来定制Category、Appender 和Layout对象。其配置文件格式基本类似于log4j，一个简单的配置文件log4cpp.conf例子如下(来自log4cpp的API手册)：

# a simple test config

log4j.rootCategory=DEBUG, rootAppender

log4j.category.sub1=A1

log4j.category.sub2=INFO

log4j.category.sub1.sub2=ERROR, A2

log4j.appender.rootAppender=org.apache.log4j.ConsoleAppender

https://www.360docs.net/doc/4d14827201.html,yout=org.apache.log4j.BasicLayout

log4j.appender.A1=org.apache.log4j.FileAppender

log4j.appender.A1.fileName=A1.log

https://www.360docs.net/doc/4d14827201.html,yout=org.apache.log4j.BasicLayout

log4j.appender.A2=org.apache.log4j.ConsoleAppender

https://www.360docs.net/doc/4d14827201.html,yout=org.apache.log4j.PatternLayout

https://www.360docs.net/doc/4d14827201.html,yout.ConversionPattern=The message %m at time %d%n

这是一个标准的java属性文件。读取配置文件要依赖PropertyConfigurator 和SimpleConfigurator类。这里仅介绍PropertyConfigurator，其使用方法代码ConfigFileExam所示(该代码来自《便利的开发工具-log4cpp快速使用指南》一文)：

#include iostream>

#include log4cpp/Category.hh>

#include log4cpp/PropertyConfigurator.hh>

int main(int argc, char* argv[])

...{

try

...{

log4cpp::PropertyConfigurator::configure("./log4cpp.conf");

}

catch(log4cpp::ConfigureFailure& f)