【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中的这一行:
改为:
并在Priority.cpp中的所有include语句后加上:
编译链接成功后会得到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”。
设置完成后编译运行结果如下:
: 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的优先级时,该日志被记录,否则被忽略。系统中默认的优先级等级如下:
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:
Hello log4cpp in a Error Message!
1248337987 WARN :
Hello log4cpp in a Warning Message!
上面的日志格式还可以,但显然不是许多程序员心中理想的格式,许多人理想的格式应该是这样的: