Log4cplus选型和使用指南
前言
之前接触的java项目中，日志操作基本上都是用的log4j，以前的c项目中也用过zlog。但是最近参与C++的一个项目，自己网上做了一些选型，所以自己记录一下。
选型比较：
log4cxx：Apache的产品，属于apache的子项目之一，由log4j移植过来的。移植过来的东西多数都有一个特点，那就是要依赖各种碗糕。log4cxx就需要依赖apr-utils，编译起来没那么直接，因此我放弃了它。 log4cpp：感觉上log4cpp和log4cplus大同小异，支持的功能也类似。上上一次更新是在2007年，不过在时隔五年之后的去年年底（2012年），它突然又更新了， 从1.0版提升到了1.1版，有点不容易，感觉诈尸了。另外，它也是由log4j移植过来的。 log4cplus：log4cplus究竟和log4cpp区别在哪，如果一定要作对比似乎log4cplus比log4cpp复杂了那么一点点。log4cplus的功能比log4cpp支持的功能更加全面，支持线程安全（log4cpp的代码里也做了一些对线程安全的保证，但官方没有介绍它支持线程安全，但是我自己在centos 6.2上面编译log4cpp后发现其不支持多线程，详情：http://sourceforge.net/p/log4cpp/feature-requests/34/。反而log4cplus宣称自己是线程安全的），另外log4plus更新非常频繁，对于一个有版本洁癖的人来说，这也是我选择它的原因，新版本提供了vc10的解决方案，还支持可选编译Unicode和非Unicode版本。 glog：这个就不介绍了，全称Google Glog, Google的东西一直比较让人放心。它比log4系列的库都要简单，不过它不支持用配置文件控制日志行为，这对我来说是个遗憾。 zlog: 使用C编写，支持window和linux，但是Linux下有些问题，所以放弃了。
log4系列的库前身都是log4j，log4j真是深藏功与名。以下通过log4plus来介绍一下它的基本用法和魅力。
Log4cplus使用指南
1 Log4cplus简介
log4cplus是C++编写的开源的日志系统，前身是java编写的log4j系统，受Apache Software License保护，作者是Tad E. Smith。
log4cplus具有线程安全、灵活、以及多粒度控制的特点，通过将日志划分优先级使其可以面向程序调试、运行、测试、和维护等全生命周期。你可以选择将日志输出到屏幕、文件、NT event log、甚至是远程服务器；通过指定策略对日志进行定期备份等等。
2 安装方法
1- 解压: gzip -cd log4cplus-x.x.x.tar.gz | tar -xf -
2- 进入log4cplus根目录: cd log4cplus-x.x.x
3- 产生Makefile: ./configure --prefix=/where/to/install –enable-threads=no
如果需要指定安装路径可使用--prefix参数, 否则将缺省安装到/usr/local目录下。另外，如果需要单线程版本可通过参数-enable-threads=no指定, 否则默认将安装多线程版本。
对于HP-UNIX平台用户, 由于aCC编译器选项兼容性问题，请另外加入参数CXXFLAGS=”-AA -w”(单线程版本)或CXXFLAGS=”-AA –mt -w”(多线程版本)。
4- 创建: make
对于HP-UNIX用户，由于aCC编译器不包含-Wall选项来显示所有警告，创建时将导致无效的-W参数错误，请修改/log4cplus-x.x.x/src目录下的Makefile，将AM_CPPFLAGS = -Wall 行的-Wall选项删除或注释掉。
此外，某些HP-UNIX平台的套接字连接接受函数accept()第三个参数要求为int*，而在socket-unix.cxx源文件153行实现中实际传入的是socklen_t*类型，平台并不支持，也将导致编译错误。解决方法是将源代码该行中的传入参数强制转换为int*类型即可。
注意AIX和Linux平台目前并没有上述两处创建错误。
对于AIX平台用户请保证创建时使用的编译器是xlC而不是g++，否则将导致log4cplus脚本配置功能运行时产生段异常，生成core文件。有鉴于此，也请保证HP-UNIX用户尽量使用aCC编译器进行创建。
5- 创建/log4cplus/tests目录下的测试用例: make check
6- 安装: make install
安装成功后将在/usr/local目录或指定的目录下创建include和lib两个子目录及相应文件。其中include目录包含头文件，lib目录包含最终打包生成的静态和动态库。在动态连接log4cplus库时请使用-llog4cplus选项。
3 主要类说明
类名 说明
Filter 过滤器，过滤输出消息。
Layout 布局器，控制输出消息的格式。
Appender 挂接器，与布局器和过滤器紧密配合，将特定格式的消息过滤后输出到所挂接的设备终端如屏幕，文件等等)。
Logger 记录器，保存并跟踪对象日志信息变更的实体，当你需要对一个对象进行记录时，就需要生成一个logger。
Hierarchy 分类器，层次化的树型结构，用于对被记录信息的分类，层次中每一个节点维护一个logger的所有信息。
LogLevel 优先权，包括TRACE, DEBUG, INFO, WARNING, ERROR, FATAL。
4 基本使用
4.1 基本步骤
使用log4cplus有六个基本步骤：
实例化一个封装了输出介质的appender对象；
实例化一个封装了输出格式的layout对象；
将layout对象绑定(attach)到appender对象；
如省略此步骤，简单布局器SimpleLayout(参见5.1小节)对象会绑定到logger。
实例化一个封装了日志输出logger对象,并调用其静态函数getInstance()获得实
例，log4cplus::Logger::getInstance("logger_name")；
将appender对象绑定(attach)到logger对象；
设置logger的优先级，如省略此步骤，各种有限级的日志都将被输出。
4.2 使用示例
下面通过一些例子来了解log4cplus的基本使用。
4.2.1 例1-标准使用
/*
*标准使用，严格实现步骤1-6。
*/
#include <log4cplus/logger.h>
#include <log4cplus/consoleappender.h>
#include <log4cplus/layout.h>
using namespace log4cplus;
using namespace log4cplus::helpers;
int main()
{
/* step 1: Instantiate an appender object */
SharedObjectPtr<Appender> _append (new ConsoleAppender());
_append->setName("append for test");
/* step 2: Instantiate a layout object */
std::string pattern = "%d{%m/%d/%y %H:%M:%S} - %m [%l]%n";
std::auto_ptr<Layout> _layout(new PatternLayout(pattern));
/* step 3: Attach the layout object to the appender */
_append->setLayout( _layout );
/* step 4: Instantiate a logger object */
Logger _logger = Logger::getInstance("test");
/* step 5: Attach the appender object to the logger */
_logger.addAppender(_append);
/* step 6: Set a priority for the logger */
_logger.setLogLevel(ALL_LOG_LEVEL);
/* log activity */
LOG4CPLUS_DEBUG(_logger, "This is the FIRST log message...")
sleep(1);
LOG4CPLUS_WARN(_logger, "This is the SECOND log message...")
return 0;
}
输出结果：
10/14/04 09:06:24 - This is the FIRST log message... [main.cpp:31]
10/14/04 09:06:25 - This is the SECOND log message... [main.cpp:33]
4.2.2 例2-简洁使用
/*
*简洁使用，仅实现步骤1、4、5。
*/
#include <log4cplus/logger.h>
#include <log4cplus/consoleappender.h>
using namespace log4cplus;
using namespace log4cplus::helpers;
int main()
{
/* step 1: Instantiate an appender object */
SharedAppenderPtr _append(newConsoleAppender());
_append->setName("append test");
/* step 4: Instantiate a logger object */
Logger _logger = Logger::getInstance("test");
/* step 5: Attach the appender object to the logger */
_logger.addAppender(_append);
/* log activity */
LOG4CPLUS_DEBUG(_logger, "This is the FIRST log message...")
sleep(1);
LOG4CPLUS_WARN(_logger, "This is the SECOND log message...")
return 0;
}
输出结果：
DEBUG - This is the FIRST log message...
WARN - This is the SECOND log message...
4.2.3 例3-输出日志到控制台
/*
* iostream模式，appender输出到控制台。
*/
#include <log4cplus/logger.h>
#include <log4cplus/consoleappender.h>
#include <iomanip>
using namespace log4cplus;
int main()
{
/* step 1: Instantiate an appender object */
SharedAppenderPtr _append(newConsoleAppender());
_append->setName("append test");
/* step 4: Instantiate a logger object */
Logger _logger = Logger::getInstance("test");
/* step 5: Attach the appender object to the logger */
_logger.addAppender(_append);
/* log activity */
LOG4CPLUS_TRACE(_logger, "This is" << " just a t" << "est." << std::endl)
LOG4CPLUS_DEBUG(_logger, "This is a bool: " << true)
LOG4CPLUS_INFO(_logger, "This is a char: " << 'x')
LOG4CPLUS_WARN(_logger, "This is a int: " << 1000)
LOG4CPLUS_ERROR(_logger, "This is a long(hex): " << std::hex << 100000000)
LOG4CPLUS_FATAL(_logger, "This is a double: " << std::setprecision(15) << 1.2345234234)
return 0;
}
输出结果：
DEBUG - This is a bool: 1
INFO - This is a char: x
WARN - This is a int: 1000
ERROR - This is a long(hex): 5f5e100
FATAL - This is a double: 1.2345234234
4.2.4 例4-输出日志到文件
/*
*文件模式，appender输出到文件。
*/
#include <log4cplus/logger.h>
#include <log4cplus/fileappender.h>
using namespace log4cplus;
int main()
{
/* step 1: Instantiate an appender object */
SharedAppenderPtr _append(newFileAppender("Test.log"));
_append->setName("file log test");
/* step 4: Instantiate a logger object */
Logger _logger = Logger::getInstance("test.subtestof_filelog");
/* step 5: Attach the appender object to the logger */
_logger.addAppender(_append);
/* log activity */
int i;
for( i = 0; i < 5; ++i )
{
LOG4CPLUS_DEBUG(_logger, "Entering loop #" << i << "End line #")
}
return 0;
}
输出结果（Test.log文件）：
DEBUG - Entering loop #0End line #
DEBUG - Entering loop #1End line #
DEBUG - Entering loop #2End line #
DEBUG - Entering loop #3End line #
DEBUG - Entering loop #4End line #
4.2.5 例5-使用loglog输出日志
LogLog类实现了debug, warn, error 函数用于logcplus运行时显示log4cplus自身的调试、警告或错误信息，是对标准输出的简单封装，它也可以用来进行简单的日志输出。LogLog 同时提供了两个方法来进一步控制所输出的信息，其中setInternalDebugging()方法用来控制是否屏蔽输出信息中的调试信息，当输入参数为false则屏蔽，缺省设置为false。setQuietMode()方法用来控制是否屏蔽所有输出信息，当输入参数为true则屏蔽，缺省设置为false。
/*
通过loglog来控制输出调试、警告或错误信息，appender输出到屏幕。
*/
#include <iostream>
#include <log4cplus/helpers/loglog.h>
using namespace log4cplus::helpers;
void printMsgs(void)
{
std::cout << "Entering printMsgs()..." << std::endl;
LogLog::getLogLog()->debug("This is a Debug statement...");
LogLog::getLogLog()->warn("This is a Warning...");
LogLog::getLogLog()->error("This is a Error...");
std::cout << "Exiting printMsgs()..." << std::endl << std::endl;
}
int main()
{
printMsgs();
std::cout << "Turning on debug..." << std::endl;
LogLog::getLogLog()->setInternalDebugging(true);
printMsgs();
std::cout << "Turning on quiet mode..." << std::endl;
LogLog::getLogLog()->setQuietMode(true);
printMsgs();
return 0;
}
输出结果：
Entering printMsgs()...
log4cplus:WARN This is a Warning...
log4cplus:ERROR This is a Error...
Exiting printMsgs()...
Turning on debug...
Entering printMsgs()...
log4cplus: This is a Debug statement...
log4cplus:WARN This is a Warning...
log4cplus:ERROR This is a Error...
Exiting printMsgs()...
Turning on quiet mode...
Entering printMsgs()...
Exiting printMsgs()...
注意输出信息中总是包含"log4cplus:"前缀，如果需要定制使其使用其他的前缀请参见9.2小节。
4.3 日志输出宏
log4cplus在头文件loggingmacros.h中提供了以下的日志输出宏：
LOG4CPLUS_TRACE_METHOD(logger, logEvent)
LOG4CPLUS_TRACE(logger, logEvent)
LOG4CPLUS_TRACE_STR(logger, logEvent)
LOG4CPLUS_DEBUG(logger, logEvent)
LOG4CPLUS_DEBUG_STR(logger, logEvent)
LOG4CPLUS_INFO(logger, logEvent)
LOG4CPLUS_INFO_STR(logger, logEvent)
LOG4CPLUS_WARN(logger, logEvent)
LOG4CPLUS_WARN_STR(logger, logEvent)
LOG4CPLUS_ERROR(logger, logEvent)
LOG4CPLUS_ERROR_STR(logger, logEvent)
LOG4CPLUS_FATAL(logger, logEvent)
LOG4CPLUS_FATAL_STR(logger, logEvent)
其中logger 为Logger实例名称，logEvent为日志内容。由于log4cplus选用C++的流机制进行日志输出，因此为了区分包含<<运算符和不包含<<运算符的日志内容，分别提供了LOG4CPLUS_XXXX和LOG4CPLUS_XXXX_STR两种日志输出宏。 另外，日志输出宏LOG4CPLUS_TRACE_METHOD主要用来跟踪方法的调用轨迹。
5 输出格式控制