log4cpp简记（转）

　Log4cpp是一个开源的C++类库，它提供了在C++程序中使用日志和跟踪调试的功能。使用log4cpp，能够非常便利地将日志或者跟踪调试信息写入字符流、内存字符串队列、文件、回滚文件、调试器、Windows日志、本地syslog和远程syslogserver中。

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(文档压缩包)。

　　2.2在VC6中编译Log4cpp

　　进入D:\log4cpp-0.3.5rc3\msvc6文件夹，打开VC6的工作区msvc6.dsw，将当中的project都删除，仅仅保留log4cpp和log4cppDLL两个project。分别编译它们的Debug和Release版本号。

　　在VC6中编译Log4cpp会报错，事实上仅仅有一个错误，即不能在头文件里定义变量，同一时候给变量赋默认值。改动方法例如以下：将头文件Priority.hh中的这一行：

static const int MESSAGE_SIZE = 8;

改为：

staticconst intMESSAGE_SIZE;

并在Priority.cpp中的全部include语句后加上：

constint 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路径中。

3、Log4cpp演示样例

　　让我们从一个简单的样例開始，该样例将两条日志信息写入字符串流，该流会在标准控制台cout上输出，项目的名称是HelloLog4Cpp：

#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 =newlog4cpp::OstreamAppender("osAppender",&cout);

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

 

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

 root.addAppender(osAppender);

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

root.error("Hello log4cpp in aError Message!");

root.warn("Hello log4cpp in aWarning Message!");

log4cpp::Category::shutdown();    

return 0;

}

　　要顺利编译执行还有两个地方须要设置，其一是引入的库中加上log4cppD.lib(debug版dll库的引入文件);其二是将C/C++的CodeGeneration中的Use Runtimelibrary设置为“DebugMultithreaded DLL”。

　　设置完毕后编译执行结果例如以下：

1248337987ERROR : Hello log4cppin a Error Message!
1248337987 WARN : Hello log4cppin a Warning Message!

　　以上两条日志格式非常简陋，要设置合乎心意的日志格式，请參考兴许的PatternLayout章节。

4、Log4cpp概念

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

　　简言之，Category负责向日志中写入信息，Appender负责指定日志的目的地，Layout负责设定日志的格式，Priority被用来指定Category的优先级和日志的优先级， 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上日志的格式。

　　如今重温前面的HelloWorld程序，能够发现其流程例如以下：

　　　　1. 创建一个Appender，并指定其包括的Layout；

2. 从系统中得到Category的根，将Appender加入�到该Category中；

3. 设置Category的优先级；

4. 记录日志；

5. 关闭Category。

5、Log4cpp的自己主动内存管理

 　　8.1 项目的多线程设置

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

　　否则在程序结束时会报错，报错处的调用堆栈为：

log4cpp::BasicLayout::`vector deleting destructor'(unsignedint 1) + 122 bytes

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

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

log4cpp::OstreamAppender::`vector deletingdestructor'(unsigned int 1) + 103 bytes

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

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

log4cpp::HierarchyMaintainer::~HierarchyMaintainer() line36

　　8.2Log4cpp的内存对象管理

　　或许读者已经注意到，在前面的全部代码中，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上，否则也会被释放多次导致程序崩溃;

　8.3log4cpp::Category::shutdown()

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

 

（更多信息请查看原文：https://www.cnblogs.com/hrhguanli/p/3809023.html）