现在的位置: 首页 > 综合 > 正文

log4cpp之Layout布局

2013年10月02日 ⁄ 综合 ⁄ 共 2899字 ⁄ 字号 评论关闭

    首先回顾一下HelloWorld的日志格式,它使用了最简单的BasicLayout:

1248337987 ERROR  :
Hello log4cpp 
in a Error Message!
1248337987 WARN : Hello log4cpp in a
Warning Message
!

  上面的日志格式还可以,但显然不是许多程序员心中理想的格式,许多人理想的格式应该是这样的:

2009-07-24 15:59:55,703:
INFO infoCategory : system 
is running
2009-07-24 15:59:55,703:
WARN infoCategory : system has a warning
2009-07-24 15:59:55,703:
ERROR infoCategory : system has a error, can
't find a file
2009-07-24 15:59:55,718:
FATAL infoCategory : system has a fatal error, must be shutdown
2009-07-24 15:59:55,718:
INFO infoCategory : system shutdown, you can find some information 
in system log

   要获得上面的格式,必须使用比BasicLayout复杂的PatternLayout,而且要花一个小时来熟悉一下PatternLayout的格式定义方式,如果你认为值得的话。

PatternLayout

  在介绍PatternLayout以前,首先来看看log4cpp中所有的Layout子类(Layout本身是个虚类),一共三个:BasicLayout、PatternLayout和SimpleLayout,其中SimapleLayout并不建议使用,而BaiscLayout过于简单,因此如果程序员不自己扩展Layout的话,就只能使用PatternLayout了,值得庆幸的是,PatternLayout还是比较好用的。

PatternLayout使用setConversionPattern函数来设置日志的输出格式。该函数的声明如下:

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

%m 消息;
%n 换行符,会根据平台的不同而不同,但对于用户透明;
%p 优先级;
%r 自从layout被创建后的毫秒数;
%R 从1970年1月1日0时开始到目前为止的秒数;
%u 进程开始到目前为止的时钟周期数;
%x NDC。

   因此,要得到上述的理想格式,可以将setConversionPattern的参数设置为“%d:
%p %c %x: %m%n”,其具体含义是“时间: 优先级 Category NDC: 消息 换行”。使用PatternLayout的例子程序如下,项目名称是LayoutExam:

#include <iostream>
#include 
<log4cpp/Category.hh>
#include 
<log4cpp/OstreamAppender.hh>
#include 
<log4cpp/Priority.hh>
#include 
<log4cpp/PatternLayout.hh>
using namespace std;

int main(int argc, char* argv[])
{
    log4cpp::OstreamAppender
* osAppender = new log4cpp::OstreamAppender("osAppender"&cout);
    
    log4cpp::PatternLayout
* pLayout = new log4cpp::PatternLayout();
    pLayout
->setConversionPattern("%d:
%p %c %x: %m%n
");
    osAppender
->setLayout(pLayout);
        
    log4cpp::Category
& root = log4cpp::Category::getRoot();
    log4cpp::Category
& infoCategory = root.getInstance("infoCategory");
    infoCategory.addAppender(osAppender);
    infoCategory.setPriority(log4cpp::Priority::INFO);

    infoCategory.info(
"system is running");
    infoCategory.warn(
"system has a warning");
    infoCategory.error(
"system has a error, can't
find a file
");
    infoCategory.fatal(
"system has a fatal error,must
be shutdown
");
    infoCategory.info(
"system shutdown,you can
find some information in system log
");

    log4cpp::Category::shutdown();
    
    
return 0;
}

其运行结果即如下所示:

2009-07-24
15:59:55,703: INFO infoCategory : system is running

2009-07-24 15:59:55,703: WARN infoCategory : system has a warning
2009-07-24 15:59:55,703: ERROR infoCategory : system has a error, can't find a file
2009-07-24 15:59:55,718: FATAL infoCategory : system has a fatal error, must be shutdown
2009-07-24 15:59:55,718: INFO infoCategory : system shutdown, you can find some information
in system log

抱歉!评论已关闭.