【IT168 专稿】Log4cpp是一个开源的C++类库，它提供了在C++程序中使用日志和跟踪调试的功能。使用log4cpp，可以很便利地将日志或者跟踪调试信息写入字符流、内存字符串队列、文件、回滚文件、调试器、Windows日志、syslog和远程syslog服务器中。
1、Log4cpp简介
Log4cpp是个基于LGPL的开源项目，移植自Java的日志处理跟踪项目log4j，并保持了API上的一致。其类似的支持库还包括Java(log4j)，C++(log4cpp、log4cplus)，C(log4c)，python(log4p)等。
Log4cpp有如下优点：
• 提供了可扩展的多种日志记录方式；
• 提供了NDC(嵌套诊断上下文)，可用于多线程、多场景的跟踪调试；
• 提供了完整的日志动态优先级控制，可随时调整需要记录的日志优先级；
• 可通过配置文件完成所有配置并动态加载；
• 性能优秀，内存占用小，经过编译后的log4cpp.dll大小仅有160kb；
• 代码级的平台无关性，Log4cpp源代码经过编译后，适用于大多数主流的操作系统和开发工具；
• 概念清晰，学习和使用方便，熟练程序员一天之内即可很好地应用log4cpp进行开发。
2、下载和安装
2.1 下载
Log4cpp的主页为：http://sourceforge.net/projects/log4cpp/
下载版本0.3.5rc3，这个版本目前是最稳定的，版本1.0在VC中表现不稳定。下载后的包名字为：log4cpp-0.3.5rc3.tar.gz(源代码包)和log4cpp-docs-0.3.5rc3.tar.gz(文档压缩包)。将它们解压后放入D盘。
2.2 在VC6中编译Log4cpp
进入D:\log4cpp-0.3.5rc3\msvc6目录，打开VC6的工作区msvc6.dsw，将其中的工程都删除，只保留log4cpp和log4cppDLL两个工程。分别编译它们的Debug和Release版本。
在VC6中编译Log4cpp会报错，其实只有一个错误，即不能在头文件中定义变量，同时给变量赋默认值。修改方法如下：将头文件Priority.hh中的这一行：
#div_code img{border:0px;}
static const int MESSAGE_SIZE = 8; 改为：
#div_code img{border:0px;}
static const int MESSAGE_SIZE; 并在Priority.cpp中的所有include语句后加上：
#div_code img{border:0px;}
const int log4cpp::Priority::MESSAGE_SIZE = 8; 编译链接成功后会得到log4cppD.dll、log4cppD.lib(Debug版的dll和lib文件)和log4cpp.dll、log4cpp.lib(Release版的dll和lib文件)。新建目录D:\log4cpp-0.3.5rc3\lib，将以上四个文件拷贝到该目录下。
在VC中添加设置lib和include路径。
将D:\log4cpp-0.3.5rc3\lib加入系统的Path路径中。
2.3 例子程序
本文包含了大量的例子程序，这些程序被组织为多个工程，并放入了一个名为WxbLogDsw的VC工作区。所有代码被打包为一个名为WxbLogDsw.rar的压缩文件，解压后可在VC6以上版本中打开此工程并进行编译运行。
3、Log4cpp的HelloWorld
让我们从一个简单的例子开始，该例子将两条日志信息写入字符串流，该流会在标准控制台cout上输出，项目的名称是HelloLog4Cpp：
#div_code img{border:0px;}
#include <iostream>
#include "log4cpp/Category.hh"
#include "log4cpp/OstreamAppender.hh"
#include "log4cpp/BasicLayout.hh"
#include "log4cpp/Priority.hh"
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.addAppender(osAppender);
root.setPriority(log4cpp::Priority::DEBUG);
root.error("Hello log4cpp in a Error Message!");
root.warn("Hello log4cpp in a Warning Message!");
log4cpp::Category::shutdown();
return 0;
}
要顺利编译运行还有两个地方需要设置，其一是引入的库中加上log4cppD.lib(debug版dll库的引入文件);其二是将C/C++的Code Generation中的Use Runtime library设置为“Debug Multithreaded DLL”。
设置完成后编译运行结果如下：
#div_code img{border:0px;}
1248337987 ERROR : Hello log4cpp in a Error Message!
1248337987 WARN : Hello log4cpp in a Warning Message! 以上两条日志格式很简陋，要设置合乎心意的日志格式，请参考后续的PatternLayout章节。
4、概念
Log4cpp中的概念继承自log4j，最重要的是Category(种类)、Appender(附加目的地)和Layout(布局)三个概念，此外还有Priority(优先级)和NDC(嵌套的诊断上下文)等。
简言之，Category负责向日志中写入信息，Appender负责指定日志的目的地，Layout负责设定日志的格式，Priority被用来指定Category的优先级和日志的优先级， NDC则是一种用来区分不同场景中交替出现的日志的手段。
Log4cpp记录日志的原理如下：每个Category都有一个优先级，该优先级可以由setPriority方法设置，或者从其父Category中继承而来。每条日志也有一个优先级，当Category记录该条日志时，若日志优先级高于Category的优先级时，该日志被记录，否则被忽略。系统中默认的优先级等级如下：
注意：取值越小，优先级越高。例如一个Category的优先级为101，则所有EMERG、FATAL、ALERT日志都可以记录下来，而其他则不能。
Category、Appender和Layout三者的关系如下：系统中可以有多个Category，它们都是继承自同一个根，每个Category负责记录自己的日志;每个Category可以添加多个Appender，每个Appender指定了一个日志的目的地，例如文件、字符流或者Windows日志，当Category记录一条日志时，该日志被写入所有附加到此Category的Appender;每个Append都包含一个Layout，该Layout定义了这个Appender上日志的格式。
现在重温前面的HelloWorld程序，可以发现其流程如下：
1. 创建一个Appender，并指定其包含的Layout；
2. 从系统中得到Category的根，将Appender添加到该Category中；
3. 设置Category的优先级；
4. 记录日志；
5. 关闭Category。
下面，我们按照Layout、Appender、Category、NDC的顺序来依次介绍这些概念并给出例子。
5、Layout(布局)
首先回顾一下HelloWorld的日志格式，它使用了最简单的BasicLayout：
#div_code img{border:0px;}
1248337987 ERROR : Hello log4cpp in a Error Message!
1248337987 WARN : Hello log4cpp in a Warning Message! 上面的日志格式还可以，但显然不是许多程序员心中理想的格式，许多人理想的格式应该是这样的：
要获得上面的格式，必须使用比BasicLayout复杂的PatternLayout，而且要花一个小时来熟悉一下PatternLayout的格式定义方式，如果你认为值得的话。
5.1 PatternLayout
在介绍PatternLayout以前，首先来看看log4cpp中所有的Layout子类(Layout本身是个虚类)，一共三个：BasicLayout、PatternLayout和SimpleLayout，其中SimapleLayout并不建议使用，而BaiscLayout过于简单，因此如果程序员不自己扩展Layout的话，就只能使用PatternLayout了，值得庆幸的是，PatternLayout还是比较好用的。
PatternLayout使用setConversionPattern函数来设置日志的输出格式。该函数的声明如下：
#div_code img{border:0px;}
void log4cpp::PatternLayout::setConversionPattern ( const std::string & conversionPattern ) throw (ConfigureFailure) [virtual] 其中参数类型为std::string，类似于C语言中的printf，使用格式化字符串来描述输出格式，其具体含义如下：
因此，要得到上述的理想格式，可以将setConversionPattern的参数设置为“%d: %p %c %x: %m%n”，其具体含义是“时间: 优先级 Category NDC: 消息 换行”。使用PatternLayout的例子程序如下，项目名称是LayoutExam：
其运行结果即如下所示：
6、Appender
笔者认为Appender是log4cpp中最精彩的一个部分。我仔细阅读了大部分Appender的源代码并对设计者感到非常敬仰。
Log4cpp中所有可直接使用的Appender列表如下：
其中SyslogAppender和RemoteSyslogAppender需要与Syslog配合使用，因此这里不介绍。顺便提一句，Syslog是类Unix系统的一个核心服务，用来提供日志服务，在Windows系统中并没有直接提供支持，当然可以用相关工具提供Windows系统中的syslog服务。
IdsaAppender的功能是将日志写入Idsa服务，这里也不介绍。因此主要介绍以下Appender：
6.1 OstreamAppender
在我刚刚学习C/C++编程时，一位老师告诉我，如果没有好用的调试工具，就在代码中加入printf语句，将调试信息打印出来(当时在linux下面，确实没有什么易用的c++调试工具)。现在有了OstreamAppender，一切都好办了，它可以将日志记入一个流，如果该流恰好是cout，则会在标准控制台上输出。比printf优越的是，除了输出消息外，还可以轻松的输出时间、时钟数、优先级等大量有用信息。
OstreamAppender的使用非常简单，在前面的HelloWorld程序中已经见过，创建一个OstreamAppender的具体方法如下：
#div_code img{border:0px;}
log4cpp::OstreamAppender* osAppender = new log4cpp::OstreamAppender("osAppender", &cout); 第一个参数指定OstreamAppender的名称，第二个参数指定它关联的流的指针。
6.2 StringQueueAppender
后来一位高手又告诉我“在调试多线程程序时，不能随意使用printf”。因为printf导致IO中断，会使得本线程挂起，其花费的时间比一条普通指令多数千倍，若多个线程同时运行，则严重干扰了线程间的运行方式。所以调试多线程程序时，最好是将所有调试信息按顺序记入内存中，程序结束时依次打印出来。为此当时我们还写了一个小工具，没想到时隔多年，我碰上了StringQueueAppender。
我很怀疑StringQueueAppender被设计出来就是用于记录多线程程序或者实时程序的日志，虽然log4cpp的文档中并没有明确指出这一点。StringQueueAppender的功能是将日志记录到一个字符串队列中，该字符串队列使用了STL中的两个容器，即字符串容器std::string和队列容器std::queue，具体如下：
#div_code img{border:0px;}
std::queue<std::string> _queue; _queue变量是StringQueueAppender类中用于具体存储日志的内存队列。StringQueueAppender的使用方法与OstreamAppender类似，其创建函数只接收一个参数“名称”，记录完成后需要程序员自己从队列中取出每条日志，例子程序StringQueueAppenderExam如下：
程序输出为：
6.3 FileAppender和RollingFileAppender
FileAppender和RollingFileAppender是log4cpp中最常用的两个Appender，其功能是将日志写入文件中。它们之间唯一的区别就是前者会一直在文件中记录日志(直到操作系统承受不了为止)，而后者会在文件长度到达指定值时循环记录日志，文件长度不会超过指定值(默认的指定值是10M byte)。
FileAppender的创建函数如下：
一般仅使用前两个参数，即“名称”和“日志文件名”。第三个参数指示是否在日志文件后继续记入日志，还是清空原日志文件再记录。第四个参数说明文件的打开方式。
RollingFileAppender的创建函数如下：
它与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如下：
程序运行后会产生两个日志文件wxb.log和rollwxb.log，以及一个备份文件rollwxb.log.1。wxb.log的大小为7kb，记录了所有100条日志;rollwxb.log大小为2kb，记录了最新的22条日志;rollwxb.log.1大小为6kb，记录了旧的78条日志。
6.4 Win32DebugAppender
Win32DebugAppender是一个用于调试的Appender，其功能是向Windows的调试器中写入日志，目前支持MSVC和Borland中的调试器。创建Win32DebugAppender仅需要一个参数“名称”，其使用非常简单，下面是例子代码DebugAppenderExam：
在VC6中调试该代码会得到如下图所示的调试信息，注意最下方的两行调试信息：
6.5 NTEventLogAppender
该Appender可以将日志发送到windows的日志，在运行程序后可以打开windows的计算机管理?系统工具?事件查看器?应用程序，可以看到下图，注意图中第一行和第二行的两个日志。
例子程序NTAppenderExam如下：
7、Category
Log4cpp中有一个总是可用并实例化好的Category，即根Category。使用log4cpp::Category::getRoot()可以得到根Category。在大多数情况下，一个应用程序只需要一个日志种类(Category)，但是有时也会用到多个Category，此时可以使用根Category的getInstance方法来得到子Category。不同的子Category用于不同的场合。一个简单的例子CategoryExam如下所示：
运行结果如下：
这个例子中共有三个Category，分别是根、sub1和sub2，其中sub1记录了一条日志，sub2记录了两条日志。Sub2另外两个日志由于优先级不够未能记录。
8、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如下：
该例子来自log4cpp的例子程序，我做了简单的修改。在记录日志的时候，可以从NDC中得知当前线程的嵌套关系。
9、Log4cpp的自动内存管理
9.1 项目的多线程设置
VC中必须将项目设置为Debug MultiThreaded DLL，总之这个设置必须与你使用的Log4cpp库一致。如果你使用的是Release版本的log4cpp.dll，则应该设置为MultiThreaded DLL。
否则在程序结束时会报错，报错处的调用堆栈为：
9.2 Log4cpp的内存对象管理
也许读者已经注意到，在前面的所有代码中，log4cpp中所有动态分配的对象都没有手动释放。
Log4cpp中new出来的Category、Appender和Layout都不需要手动释放，因为Log4cpp使用了一个内部类来管理这些对象。此类的名称是HierarchyMaintainer，它负责管理Category的继承关系，在程序结束时，HierarchyMaintainer会依次释放所有Category，而Category则会依次释放拥有的有效Appender，Appender则会释放所有附属的Layout。如果程序员手动释放这些对象，则会造成内存报错。
从下面的代码可以看出这个特征：
#div_code img{border:0px;}
appender->setLayout(new log4cpp::BasicLayout()); 这个new出来的BasicLayout根本就没有保存其指针，所以它只能被log4cpp的内存管理类HierarchyMaintainer释放。
了解到HierarchyMaintainer的内存管理方法后，程序员在使用log4cpp时应该遵循以下几个使用原则：
1. 不要手动释放Category、Appender和Layout;
2. 同一个Appender不要加入多个Category，否则它会被释放多次从而导致程序崩溃;
3. 同一个Layout不要附着到多个Appender上，否则也会被释放多次导致程序崩溃;
下面这个简单的程序PointerErrorExam会造成经典的崩溃：
运行后出现对话框：
#div_code img{border:0px;}
PointerErrorExam.exe 遇到问题需要关闭。我们对此引起的不便表示抱歉。 其原因就是osAppender被同时加入了sub1和sub2这两个Category。
9.3 log4cpp::Category::shutdown()
在不使用log4cpp时可调用log4cpp::Category::shutdown()，其功能如同HierarchyMaintainer的内存清理。但如果不手动调用，在程序结束时HierarchyMaintainer会调用Category的析构函数来释放所有Appender。
10、利用配置文件定制日志
如同log4j一样，log4cpp也可以读取配置文件来定制Category、Appender和Layout对象。其配置文件格式基本类似于log4j，一个简单的配置文件log4cpp.conf例子如下(来自log4cpp的API手册)：
这是一个标准的java属性文件。读取配置文件要依赖PropertyConfigurator和SimpleConfigurator类。这里仅介绍PropertyConfigurator，其使用方法代码ConfigFileExam所示(该代码来自《便利的开发工具-log4cpp快速使用指南》一文)：
该程序首先读入了配置文件log4cpp.conf，从中得到了所有Category、Appender和Layout的优先级和相互附属关系，然后输出了一些日志，其运行结果如下：
11、DLL的版本问题
若在VC6中使用Log4cpp的DLL，则必须使用VC6编译链接生成的DLL，不能使用MSVS2008中生成的DLL，反之也是一样。否则会在运行时报错。
为此专门提供了两个版本的DLL，供大家使用。
12、小结
Log4cpp是一个小巧的c++库，易于上手，使用方便，不依赖其他库，具有跨平台性，并可与log4j、log4c、log4p等语言族共享其概念与使用方法。实在是进行日志记录、程序调试的利器。