【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中的这一行：
static const int MESSAGE_SIZE = 8;改为：
static const int MESSAGE_SIZE;并在Priority.cpp中的所有include语句后加上：
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：
#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”。
设置完成后编译运行结果如下：
1248337987 ERROR : Hello log4cpp in aError Message!
1248337987 WARN : Hello log4cpp in aWarning Message!
以上两条日志格式很简陋，要设置合乎心意的日志格式，请参考后续的PatternLayout章节。
4、概念
Log4cpp中的概念继承自log4j，最重要的是Category(种类)、Appender(附加目的地)和Layout(布局)三个概念，此外还有Priority(优先级)和NDC(嵌套的诊断上下文)等。
简言之，Category负责向日志中写入信息，Appender负责指定日志的目的地，Layout负责设定日志的格式，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上日志的格式。
现在重温前面的HelloWorld程序，可以发现其流程如下：
1. 创建一个Appender，并指定其包含的Layout；
2. 从系统中得到Category的根，将Appender添加到该Category中；
3. 设置Category的优先级；
4. 记录日志；
5. 关闭Category。
下面，我们按照Layout、Appender、Category、NDC的顺序来依次介绍这些概念并给出例子。
5、Layout(布局)
首先回顾一下HelloWorld的日志格式，它使用了最简单的BasicLayout：
1248337987 ERROR : Hello log4cpp in aError Message!
1248337987 WARN : Hello log4cpp in aWarning 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, can't 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的格式定义方式，如果你认为值得的话。
5.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:551980”。日期的格式符号与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: 消息 换行”。使用PatternLayout的例子程序如下，项目名称是LayoutExam：
#include <iostream>#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); infoCategory.info("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 fatalerror,must be shutdown");
infoCategory.info("system shutdown,youcan find some information in system log");
log4cpp::Category::shutdown(); return 0;}其运行结果即如下所示：
2009-07-24 15:59:55,703: INFO infoCategory : system is running2009-07-24 15:59:55,703: WARN infoCategory : system has a warning2009-07-24 15:59:55,703: ERROR infoCategory : system has a error, can't find a file2009-07-24 15:59:55,718: FATAL infoCategory : system has a fatal error, must be shutdown2009-07-24 15:59:55,718: INFO infoCategory : system shutdown, you can find some information in system log
6、Appender
笔者认为Appender是log4cpp中最精彩的一个部分。我仔细阅读了大部分Appender的源代码并对设计者感到非常敬仰。
Log4cpp中所有可直接使用的Appender列表如下：
log4cpp::IdsaAppender // 发送到IDS或者log4cpp::FileAppender // 输出到文件log4cpp::RollingFileAppender // 输出到回卷文件，即当文件到达某个大小后回卷log4cpp::OstreamAppender // 输出到一个ostream类log4cpp::RemoteSyslogAppender // 输出到远程syslog服务器log4cpp::StringQueueAppender // 内存队列log4cpp::SyslogAppender // 本地sysloglog4cpp::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 事件日志6.1 OstreamAppender
在我刚刚学习C/C++编程时，一位老师告诉我，如果没有好用的调试工具，就在代码中加入printf语句，将调试信息打印出来(当时在linux下面，确实没有什么易用的c++调试工具)。现在有了OstreamAppender，一切都好办了，它可以将日志记入一个流，如果该流恰好是cout，则会在标准控制台上输出。比printf优越的是，除了输出消息外，还可以轻松的输出时间、时钟数、优先级等大量有用信息。
OstreamAppender的使用非常简单，在前面的HelloWorld程序中已经见过，创建一个OstreamAppender的具体方法如下：
log4cpp::OstreamAppender* osAppender = new log4cpp::OstreamAppender("osAppender", &cout);第一个参数指定OstreamAppender的名称，第二个参数指定它关联的流的指针。
6.2 StringQueueAppender
后来一位高手又告诉我“在调试多线程程序时，不能随意使用printf”。因为printf导致IO中断，会使得本线程挂起，其花费的时间比一条普通指令多数千倍，若多个线程同时运行，则严重干扰了线程间的运行方式。所以调试多线程程序时，最好是将所有调试信息按顺序记入内存中，程序结束时依次打印出来。为此当时我们还写了一个小工具，没想到时隔多年，我碰上了StringQueueAppender。
我很怀疑StringQueueAppender被设计出来就是用于记录多线程程序或者实时程序的日志，虽然log4cpp的文档中并没有明确指出这一点。StringQueueAppender的功能是将日志记录到一个字符串队列中，该字符串队列使用了STL中的两个容器，即字符串容器std::string和队列容器std::queue，具体如下：
std::queue<std::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!"); cout<<"Get messagefrom Memory Queue!"<<endl;
cout<<"-------------------------------------------"<<endl; queue<string>& myStrQ = strQAppender->getQueue(); while(!myStrQ.empty()) { cout<<myStrQ.front(); myStrQ.pop(); } log4cpp::Category::shutdown(); return 0;}程序输出为：
Get message from Memory Queue!-------------------------------------------1248839389 ERROR : Hello log4cpp in a Error Message!1248839389 WARN : Hello log4cpp in a Warning Message!6.3 FileAppender和RollingFileAppender
FileAppender和RollingFileAppender是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,