Log4Cpp的使用(转)

本文介绍如何使用Log4CPP。

Log4Cpp介绍

Log4Cpp的Api接口可以在http://log4cpp.sourceforge.net/api/index.html中查询得到。

Log4Cpp中最主要的几个概念是：Category、Appender、Layout以及Priority和NDC(嵌套的诊断上下文)。Category负责向日志中写入信息，Appender负责制定日志的目的地，Layout负责设定日志中的格式，NDC则是用来区分不同场景中交替出现日志的手段。

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

typedefenum {

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之前，我们先看一下Log4Cpp中的继承关系:

(可在官网http://log4cpp.sourceforge.net/api/inherits.html查到)

布局（Layout）

布局类主要控制输出日志消息的显示样式，从上图中我们可以看到，布局类主要包括三个：

BasicLayout输出格式为：时间戳优先级 category名字：消息内容

如这样1522761362 ERROR sub1 : sub1 error

SimpleLayout输出格式为：优先级：消息内容

如这样 ERROR : Streamed sub1 error

PatternLayout，如果你想实现复杂的格式，就不想去自己继承BasicLayout类自定义一个类，那使用这个布局也许就够了。

PatternLayout使用setConversionPattern函数设置log的格式。函数原型如下：

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，表示毫秒，占三个十进制位。

补充关于strftime函数中的格式符号

%a 缩写的星期几名称 Sun

%A 完整的星期几名称 Sunday

%b 缩写的月份名称 Mar

%B 完整的月份名称 March

%c 日期和时间表示法 Sun Aug 19 02:56:02 2012

%d 一月中的第几天（01-31） 19

%H 24 小时格式的小时（00-23） 14

%I 12 小时格式的小时（01-12） 05

%j 一年中的第几天（001-366） 231

%m 十进制数表示的月份（01-12） 08

%M 分（00-59） 55

%p AM 或 PM 名称 PM

%S 秒（00-61） 02

%U 一年中的第几周，以第一个星期日作为第一周的第一天（00-53） 33

%w 十进制数表示的星期几，星期日表示为 0（0-6） 4

%W 一年中的第几周，以第一个星期一作为第一周的第一天（00-53） 34

%x 日期表示法 08/19/12

%X 时间表示法 02:50:06

%y 年份，最后两个数字（00-99） 01

%Y 年份 2012

%Z 时区的名称或缩写 CDT

%% 一个 % 符号 %

%m 消息；

%n 换行符，会根据平台的不同而不同，但对于用户透明；

%p 优先级；

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

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

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

%x NDC

具体使用如下：

log4cpp::Appender *appender1 = new log4cpp::FileAppender("default", "patternLayout.log");

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

p->setConversionPattern("%d{%H:%M:%S,%l} : %c %m%n");

appender1->setLayout(p);

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

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

root.addAppender(appender1);

root.error("root error");

root << log4cpp::Priority::ERROR << "Streamed root error";

log的输出结果如下：

22:31:23,945 : root error

22:31:23,973 : Another streamed error

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 // 发送到缺省系统调试器

OstreamAppender

　　它可以将日志记入一个流，如果该流恰好是cout，则会在标准控制台上输出。比printf优越的是，除了输出消息外，还可以轻松的输出时间、时钟数、优先级等大量有用信息。OstreamAppender的使用非常简单,创建一个OstreamAppender的具体方法如下：

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

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

StringQueueAppender

StringQueueAppender的功能是将日志记录到一个字符串队列中，该字符串队列使用了STL中的两个容器，即字符串容器std::string和队列容器std::queue，具体如下：

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

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

FileAppender和RollingFileAppender

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

　　FileAppender的创建函数如下：

FileAppender(conststd::string& name, conststd::string& fileName, bool append = true, mode_tmode = 00644);

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

　　RollingFileAppender的创建函数如下：

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

size_tmaxFileSize =10*1024*1024, unsigned intmaxBackupIndex = 1，

boolappend = 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。

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 = newlog4cpp::PatternLayout();

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

log4cpp::Appender* debugAppender = newlog4cpp::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;

}

会在VS的debug调试信息中打印出来。

NDC

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

Log4cpp的自动内存管理

项目的多线程设置

　　VC中必须将项目设置为Debug MultiThreaded DLL，总之这个设置必须与你使用的Log4cpp库一致。如果你使用的是Release版本的log4cpp.dll，则应该设置为MultiThreaded DLL。

Log4cpp的内存对象管理

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

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

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

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

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

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

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

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

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

log4cpp::Category::shutdown()

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

利用配置文件定制日志

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

#log4cpp配置文件

#定义Root category的属性

log4cpp.rootCategory=DEBUG, RootLog

#定义RootLog属性

log4cpp.appender.RootLog=ConsoleAppender

log4cpp.appender.RootLog.layout=PatternLayout

log4cpp.appender.RootLog.layout.ConversionPattern=%d [%p] -%m%n

#定义sample category的属性

log4cpp.category.sample=DEBUG, sample

#定义sample属性

log4cpp.appender.sample=FileAppender

log4cpp.appender.sample.fileName=sample.log

log4cpp.appender.sample.layout=PatternLayout

log4cpp.appender.sample.layout.ConversionPattern=%d [%p] -%m%n

#定义sample.soncategory的属性

log4cpp.category.sample.son=DEBUG, son

#定义son的属性

log4cpp.appender.son=FileAppender

log4cpp.appender.son.fileName=son.log

log4cpp.appender.son.layout=PatternLayout

log4cpp.appender.son.layout.ConversionPattern=%d[%p] - %m%n

#定义sample.daughtercategory的属性

log4cpp.category.sample.daughter=DEBUG,daughter

#定义daughter属性

log4cpp.appender.daughter=FileAppender

log4cpp.appender.daughter.fileName=daughter.log

log4cpp.appender.daughter.layout=PatternLayout

log4cpp.appender.daughter.layout.ConversionPattern=%d [%p]- %m%n

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

category 是"log4cpp.category." + "categoryname"

category 名字可以用"."分隔，以标识包含关系

appender 是"log4cpp.appender." + "appendername"

appender 名字不能用 "." 分隔，即是说 appender 是没有包含关系的

读取配置文件要依赖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)

{

std::cout<< "Configure Problem "<< f.what()<< std::endl;

return -1;

}

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

log4cpp::Category& sub1 =log4cpp::Category::getInstance(std::string("sub1"));

log4cpp::Category& sub3 =log4cpp::Category::getInstance(std::string("sub1.sub2"));

sub1.info("This is someinfo");

sub1.alert("Awarning");

// sub3 only have A2 appender.

sub3.debug("This debug messagewill fail to write");

sub3.alert("All hands abandonship");

sub3.critStream() <<"This will show up<< as "<< 1 <<" critical message"<<log4cpp::CategoryStream::ENDLINE;

sub3<<log4cpp::Priority::ERROR<<"And this will be anerror" <<log4cpp::CategoryStream::ENDLINE;

sub3.log(log4cpp::Priority::WARN, "This will be a logged warning");

return0;

}

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

1248875649 INFO sub1 : This is some info

1248875649 ALERT sub1 : A warning

The message All hands abandon ship at time 2009-07-2921:54:09,515

1248875649 ALERT sub1.sub2 : All hands abandonship

The message This will show up<< as 1 critical message at time2009-07-29 21:54:09,531

1248875649 CRIT sub1.sub2 : This will show up<< as 1 critical message

The message And this will be an error at time 2009-07-2921:54:09,531

1248875649 ERROR sub1.sub2 : And this will be anerror

转载自https://blog.csdn.net/kingskyleader/article/details/7320826。