一、简介

几乎每个大型应用都包含其自己的logging或者tracing API。在代码中插入日志语句是一种低技术的debgging方法。但也可能是唯一的方法,因为debuggers并不总是好用。

Apache log4cxx是一个继Apache log4j之后用于C++的日志框架。Apache log4cxx使用Apache Portable Runtime作为大部分的平台相关代码,可以用于任何支持APR的平台。

官网: http://logging.apache.org/log4cxx/


二、安装

log4cxx依赖于Apache的另外两个库:Apache Portable Runtime(APR) 和 Apache Portable Runtime Utility(APR-Util),所以要先安装这2个库。


1. 下载所需的源码包

[root@oracle ~]# wget -c -t 0 http://apache.dataguru.cn/logging/log4cxx/0.10.0/apache-log4cxx-0.10.0.tar.gz
[root@oracle ~]# wget -c -t 0 http://apache.fayea.com/apr/apr-1.5.2.tar.bz2
[root@oracle ~]# wget -c -t 0 http://apache.fayea.com/apr/apr-util-1.5.4.tar.bz2


2. 安装APR

[root@oracle ~]# tar xvf apr-1.5.2.tar.bz2
[root@oracle apr-1.5.2]# ./configure --prefix=/usr/local/apr
[root@oracle apr-1.5.2]# make && make install


3. 安装APR-Util

[root@oracle ~]# tar xvf apr-util-1.5.4.tar.bz2
[root@oracle apr-util-1.5.4]# ./configure --prefix=/usr/local/apr-util --with-apr=/usr/local/apr/
[root@oracle apr-util-1.5.4]# make && make install


4.安装log4cxx

[root@oracle ~]# tar xvf apache-log4cxx-0.10.0.tar.gz
[root@oracle apache-log4cxx-0.10.0]# ./configure --prefix=/usr/local/log4cxx \
--with-apr=/usr/local/apr/ \
--with-apr-util=/usr/local/apr-util/ \
--with-charset=utf-8 \
--with-logchar=utf-8    #设置成utf-8解决中文乱码问题
[root@oracle apache-log4cxx-0.10.0]# make
inputstreamreader.cpp:66: error: 'memmove' was not declared in this scope
#这里由于源代码没有包含对应的头文件报错了,在源代码文件里添加一些头文件就好了

[root@oracle apache-log4cxx-0.10.0]# vim src/main/cpp/inputstreamreader.cpp 
#include <cstring>
[root@oracle apache-log4cxx-0.10.0]# vim src/main/cpp/socketoutputstream.cpp 
#include <cstring>
[root@oracle apache-log4cxx-0.10.0]# vim src/examples/cpp/console.cpp
#include <cstring>
#include <cstdio>

#这里重新开始编译
[root@oracle apache-log4cxx-0.10.0]# make
[root@oracle apache-log4cxx-0.10.0]# make install


三、完善安装

在安装目录下有3个目录

[root@oracle ~]# ls /usr/local/log4cxx/
include   #头文件
lib       #库文件
share     #帮助文件
#让系统可以找到log4cxx的库文件
[root@oracle ~]# vim /etc/ld.so.conf.d/log4cxx.conf
/usr/local/log4cxx/lib
[root@oracle ~]# ldconfig -v | grep log4cxx
/usr/local/log4cxx/lib:
	liblog4cxx.so.10 -> liblog4cxx.so.10.0.0

#让系统可以找到log4cxx的头文件
[root@oracle ~]# ln -sv /usr/local/log4cxx/include /usr/include/log4cxx
`/usr/include/log4cxx' -> `/usr/local/log4cxx/include'

#启动httpd服务即可以访问帮助页面了
[root@oracle ~]# cp -a /usr/local/log4cxx/share/log4cxx/html/* /var/www/html/


帮助文件是个网站,这个帮助文件相当有用

wKioL1WTLgjQaSJ8AAWe27-30uw336.jpg



四、log4cxx中常用类及继承关系

1. Layouts

这个类是用来格式化日志的输出格式的,可以在Appenders的后面附加Layouts来完成这个功能。

wKioL1Wm8saSTzitAADKqchbF0E651.jpg

格式化符号说明:

%p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。

%d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。

%r:输出自应用程序启动到输出该log信息耗费的毫秒数。

%t:输出产生该日志事件的线程名。

%l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。

%c:输出日志信息所属的类目,通常就是所在类的全名。

%M:输出产生日志信息的方法名。

%F:输出日志消息产生时所在的文件名称。

%L: 输出代码中的行号。

%m: 输出代码中指定的具体日志信息。

%n:输出一个回车换行符,Windows平台为"\r\n",Unix平台为"\n"。

%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

%X: 输出和当前线程相关联的MDC,如%X{CLIENTNUMBER},这里的CLIENTNUMBER是MDC的key。

%%:输出一个"%"字符。

另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:

1) c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。

2)%-20c:"-"号表示左对齐。

3)%.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。


2. Appenders

这个类用来将日志输出到不同的对象中,如: 控制台(Console)、文件(Files)、syslog等

wKioL1WlpRuy3iWiAAJd4mAIXWg351.jpg

DailyRollingFileAppender格式如下:

1) '.'yyyy-MM:每月

2) '.'yyyy-ww:每周

3) '.'yyyy-MM-dd:每天

4) '.'yyyy-MM-dd-a:每天两次(12点和24点)

5) '.'yyyy-MM-dd-HH:每小时

6) '.'yyyy-MM-dd-HH-mm:每分钟


3. logger

a) logger的命名规则

logger的名字是区分大小写的,并且遵循下面的规则:

比如有3个logger,它们的名字分别是“com”,“com.51cto”,“com.51cto.www”,那么“com”是“com.51cto”的父logger,“com.51cto”是“com.51cto.www”的父logger。子logger会从父logger得到属性继承。


b) logger的级别

Loggers组件在此系统中被分为六个级别:TRACE < DEBUG < INFO < WARN < ERROR < FATAL。

这六个级别是有顺序的,分别用来指定这条日志信息的重要程度,明白这一点很重要,Log4j有一个规则:

只输出级别不低于设定级别的日志信息,假设Loggers级别设定为INFO,则INFO、WARN、ERROR和FATAL级别的日志信息都会输出,而级别比INFO低的DEBUG则不会输出。

//获得一个名为“com”的logger
log4cxx::LoggerPtr logger(log4cxx::Logger::getLogger("com"));
//设置等级为INFO级别
logger->setLevel(log4cxx::Level::getInfo());
//这个请求是有效的,因为INFO < WARN
LOG4CXX_WARN(logger, "Low fuel level.");
//这个请求是无效的,因为DEBUG < INFO
LOG4CXX_DEBUG(logger, "Starting search for nearest gas station.");

//获得一个名为“com.51cto”的logger
log4cxx::LoggerPtr ctologger(log4cxx::Logger::getLogger("com.51cto"));
//ctologger的名字是"com.51cto",所以它将会从名为"com"的logger那边继承等级
//因此这个请求是有效的,因为INFO >= INFO
LOG4CXX_INFO(barlogger. "Located nearest gas station.")
//这个请求是无效的,因为DEBUG < INFO
LOG4CXX_DEBUG(barlogger, "Exiting gas station search")


c) logger和root logger

使用static函数log4cxx::Logger::getRootLogger可以获得root logger指针,root logger有2个属性:

   1. 不管你掉不掉用这个方法,root logger总是存在的

   2. root logger是一个匿名对象

使用static函数log4cxx::Logger::getLogger可以获得Logger指针。用相同的名字调用getLogger方法,会得到同一个logger指针

log4cxx::LoggerPtr x = log4cxx::Logger::getLogger("wombat");
log4cxx::LoggerPtr y = log4cxx::Logger::getLogger("wombat");

这里x和y就是同一个智能指针的2个引用


d) Additivity属性

Additivity属性是用来控制logger是否继承父logger属性的,具体看下面的测试:

#include "log4cxx/logger.h"
#include "log4cxx/basicconfigurator.h"

using namespace log4cxx;
using namespace log4cxx::helpers;

int main(int argc, char **argv)
{
        LoggerPtr logger(Logger::getLogger("test"));
        BasicConfigurator::configure();
        LOG4CXX_INFO(logger, "BasicConfigurator test")
        return 0;
}
#编译并执行
[root@oracle ~]# g++ test.cpp -o test -Wall -O3 -g3 -L /usr/local/log4cxx/lib/ -I /usr/include/log4cxx/ -llog4cxx 
[root@oracle ~]# ./test
0 [0x7f7088970720] INFO test null - BasicConfigurator test

BasicConfigurator::configure()方法会用ConsoleAppender初始化root logger,这个Appender又是被PatternLayout以"%-4r [%t] %-5p %c %x - %m%n"表达式设置的。

#include "log4cxx/logger.h"
#include "log4cxx/basicconfigurator.h"
#include <log4cxx/fileappender.h>
#include <log4cxx/simplelayout.h>
#include <log4cxx/helpers/pool.h>

using namespace log4cxx;
using namespace log4cxx::helpers;

int main(int argc, char **argv)
{
        BasicConfigurator::configure();
        LoggerPtr logger(Logger::getLogger("test"));
        LoggerPtr ttlogger(Logger::getLogger("test.tt"));
                
                //"logfile"是输出文件名,true是开启追加模式
        FileAppenderPtr fileAppender = new FileAppender(LayoutPtr(new SimpleLayout()),"logfile", true);
        Pool p;
        fileAppender->activateOptions(p);
        ttlogger->addAppender(AppenderPtr(fileAppender));
        ttlogger->setAdditivity(false);

        LOG4CXX_INFO(logger, "BasicConfigurator test")
        LOG4CXX_INFO(ttlogger, "BasicConfigurator test.tt");
        return 0;
}

按照我们上面命名规则的说法,“test.tt”应该继承了“test”的ConsoleAppender,然后又增加了一个FileAppender,所有它就应该有了2个输出目标(一个是控制台,另一个是文件)。然而当Additivity设置为false时,ttlogger就不再继承属性了,他就只剩下自己的FileAppender输出了。

Additivity的默认值是true,可以将setAdditivity注释掉,对比一下输出结果。

#Additivity设置为false时的输出
[root@oracle ~]# ./test
1 [0x7f4e0a0dc720] INFO test null - BasicConfigurator test
[root@oracle ~]# cat logfile 
INFO - BasicConfigurator test.tt

#Additivity设置为true时的输出
[root@oracle ~]# ./test
0 [0x7f1950161720] INFO test null - BasicConfigurator test
0 [0x7f1950161720] INFO test.tt null - BasicConfigurator test.tt
[root@oracle ~]# cat logfile 
INFO - BasicConfigurator test.tt
INFO - BasicConfigurator test.tt    #这里可以看到追加了一行


说明:

在log4cxx.h看到这样一条宏定义

#define LOG4CXX_PTR_DEF(T) typedef log4cxx::helpers::ObjectPtrT<T> T##Ptr

这样我们就知道上面的FileAppenderPtr就是log4cxx::helpers::ObjectPtrT<FileAppender>智能指针,所以上面的示例中new的内存都没有delete,而是由智能指针自动帮我们释放。


有写得不对的地方,还望指正!下一篇将是写一个基于log4cxx的简单的类,以及应用^_^