log4cplus使用帮助文档基础详解

 

  • 下载

  可从网站http://log4cplus.sourceforge.net上去下载 log4cplus 1.0.4,具体地址http://sourceforge.net/projects/log4cplus/files/log4cplus-stable/

  • 安装

  本地只有一个vs2005的工程,我的是vs2003的,所以要搞定工程的问题,去下个CMake很轻松就搞定你在工程上的问题。

  • 基础

1. log4cplus基本元素

  Layouts:控制输出消息的格式。
  Appenders:输出位置。
  Logger:日志对象。
  Priorities:优先权,包括TRACE, DEBUG, INFO, WARNING, ERROR, FATAL。

2. log4cplus基本结构

        log4cplus使用帮助文档基础详解_第1张图片

3. 层次性

  Logger对象具有层次结构,按名称区分,如下代码:   
Logger test = Logger::getInstance("test"); 
Logger subtest = Logger::getInstance("test.subtest");
  对象subtest是test的子对象。
 

4. 优先级

  log4cplus优先级有低到高:  
  NOT_SET_LOG_LEVEL:接受缺省的LogLevel,如果有父logger则继承它的LogLevel
  ALL_LOG_LEVEL:开放所有log信息输出
  TRACE_LOG_LEVEL:开放trace信息输出(即ALL_LOG_LEVEL)
  DEBUG_LOG_LEVEL:开放debug信息输出
  INFO_LOG_LEVEL:开放info信息输出
  WARN_LOG_LEVEL:开放warning信息输出
  ERROR_LOG_LEVEL:开放error信息输出
  FATAL_LOG_LEVEL:开放fatal信息输出
  OFF_LOG_LEVEL:关闭所有log信息输出

  各个logger可以通过setLogLevel设置自己的优先级,当某个logger的LogLevel设置成NOT_SET_LOG_LEVEL时,该logger会继承父logger的优先级,另外,如果定义了重名的多个logger, 对其中任何一个的修改都会同时改变其它logger。

5. Layout格式输出

1.) SimpleLayout
  是一种简单格式的布局器,在输出的原始信息之前加上LogLevel和一个"-"。
 
2.) TTCCLayout
  其格式由时间,线程ID,Logger和NDC 组成。
 
3.) PatternLayout
  是一种有词法分析功能的模式布局器,类似正则表达式。以“%”作为开头的特殊预定义标识符,将产生特殊的格式信息。
 
  (1)"%%",转义为% 。
  (2)"%c",输出logger名称,如test.subtest 。也可以控制logger名称的显示层次,比如"%c{1}"时输出"test",其中数字表示层次。
  (3)"%D",显示本地时间,比如:"2004-10-16 18:55:45",%d显示标准时间。    
    可以通过%d{...}定义更详细的显示格式,比如%d{%H:%M:%s}表示要显示小时:分钟:秒。大括号中可显示的预定义标识符如下:
       %a -- 表示礼拜几,英文缩写形式,比如"Fri"
       %A -- 表示礼拜几,比如"Friday"
       %b -- 表示几月份,英文缩写形式,比如"Oct"
       %B -- 表示几月份,"October"
       %c -- 标准的日期+时间格式,如 "Sat Oct 16 18:56:19 2004"
       %d -- 表示今天是这个月的几号(1-31)"16"
       %H -- 表示当前时刻是几时(0-23),如 "18"
       %I -- 表示当前时刻是几时(1-12),如 "6"
       %j -- 表示今天是哪一天(1-366),如 "290"
       %m -- 表示本月是哪一月(1-12),如 "10"
       %M -- 表示当前时刻是哪一分钟(0-59),如 "59"
       %p -- 表示现在是上午还是下午, AM or PM
       %q -- 表示当前时刻中毫秒部分(0-999),如 "237"
       %Q -- 表示当前时刻中带小数的毫秒部分(0-999.999),如 "430.732"
       %S -- 表示当前时刻的多少秒(0-59),如 "32"
       %U -- 表示本周是今年的第几个礼拜,以周日为第一天开始计算(0-53),如 "41"
       %w -- 表示礼拜几,(0-6, 礼拜天为0),如 "6"
       %W -- 表示本周是今年的第几个礼拜,以周一为第一天开始计算(0-53),如 "41"
       %x -- 标准的日期格式,如 "10/16/04"
       %X -- 标准的时间格式,如 "19:02:34"
       %y -- 两位数的年份(0-99),如 "04"
       %Y -- 四位数的年份,如 "2004"
       %Z -- 时区名,比如 "GMT"
  (4)"%F",输出当前记录器所在的文件名称,比如"main.cpp"
  (5)"%L",输出当前记录器所在的文件行号,比如"51"
  (6)"%l",输出当前记录器所在的文件名称和行号,比如"main.cpp:51"
  (7)"%m",输出原始信息。
  (8)"%n",换行符。
  (9)"%p",输出LogLevel,比如"DEBUG"
  (10)"%t",输出记录器所在的线程ID,比如 "1075298944"
  (11)"%x",嵌套诊断上下文NDC (nested diagnostic context) 输出,从堆栈中弹出上下文信息,NDC可以用对不同源的log信息(同时地)交叉输出进行区分。
  (12)格式对齐,比如"%-10m"时表示左对齐,宽度是10,当然其它的控制字符也可以相同的方式来使用,比如"%-12d","%-5p"等等。
 

6. Appender输出位置

(1)控制台输出
        ConsoleAppender
(2)文件输出
        FileAppender / RollingFileAppender / DailyRollingFileAppender .
----
FileAppender :
    实现了基本的文件操作功能,构造函数如下:
    FileAppender(filename,mode,immediateFlush);
 
文件名
文件类型,可选择的文件类型包括app,ate,binary,in,out,trunc。缺省是trunc,表示将先前文件删除。
缓冲刷新标志.
 
-----
RollingFileAppender:
    RollingFileAppender(filename,maxFileSize,maxBackupIndex,immediateFlush)
filename       : 文件名
maxFileSize    : 文件的最大尺寸
maxBackupIndex : 最大记录文件数
immediateFlush : 缓冲刷新标志
    可以根据你预先设定的大小来决定是否转储,当超过该大小,后续log信息会另存到新文件中,除了定义每个记录文件的大小之外,你还要确定在RollingFileAppender类对象构造时最多需要多少个这样的记录文件(maxBackupIndex+1),当存储的文件数目超过maxBackupIndex+1时,会删除最早生成的文件,保证整个文件数目等于maxBackupIndex+1 。
 
---- 
DailyRollingFileAppender:
    DailyRollingFileAppender(filename, schedule,immediateFlush,  maxBackupIndex)

filename       : 文件名
schedule       : 存储频度
immediateFlush : 缓冲刷新标志
maxBackupIndex : 最大记录文件数
 
DailyRollingFileAppender类可以根据你预先设定的频度来决定是否转储,当超过该频度,后续log信息会另存到新文件中,这里的频度包括:MONTHLY,WEEKLY,DAILY,TWICE_DAILY,HOURLY,MINUTELY。

7. 使用步骤

    a.) 生成Appender对象。
    b.) 生成Layout对象,并绑定到Appender。(可选)
    c.) 生成Logger对象。
    d.) 设置Logger优先级。(可选)
    e.) 将需要关联Logger的Appender添加到Logger上。
    f.) 使用Logger输出信息,所有大于设定的优先级的信息,并在所有挂接在该Logger对象上的Appender上以相应的Layout设定的格式显示出来。
 

8. 测试代码

1.) 一个基本框架的例子

//Include .h file 
#include  
#include  
#include  
#include  

using namespace log4cplus; 
using namespace log4cplus::helpers; 

// Link Lib 
#ifndef _DEBUG 
#pragma comment(lib,"log4cplusUS.lib") 
#else 
#pragma comment(lib,"log4cplusUSD.lib") 
#endif 

int _tmain(int argc, _TCHAR* argv[]) 
{    
        // 定义一个控制台的Appender 
        SharedAppenderPtr pConsoleAppender(new ConsoleAppender()); 

        // 定义一个简单的Layout,并绑定到Appender 
        auto_ptr pSimpleLayout(new SimpleLayout()); 
        pConsoleAppender->setLayout(pSimpleLayout); 

        // 定义Logger,并设置优先级 
        Logger pTestLogger = Logger::getInstance(_T("LoggerName"));    
        pTestLogger.setLogLevel(WARN_LOG_LEVEL); 

        // 将需要关联Logger的Appender添加到Logger上 
        pTestLogger.addAppender(pConsoleAppender); 

        // 输出日志信息 
        LOG4CPLUS_WARN(pTestLogger, "This is a log message..."); 

        return 0; 
}
运行结果,在控制台输出:
WARN - This is a log message...
 

2.) 一个精简模式的例子

int _tmain(int argc, _TCHAR* argv[]) 

        // 定义一个控制台的Appender 
        SharedAppenderPtr pConsoleAppender(new ConsoleAppender()); 

        // 定义Logger 
        Logger pTestLogger = Logger::getInstance(_T("LoggerName"));    

        // 将需要关联Logger的Appender添加到Logger上 
        pTestLogger.addAppender(pConsoleAppender); 

        // 输出日志信息 
        LOG4CPLUS_WARN(pTestLogger, "This is a log message..."); 
        
        return 0; 
}
运行结果,在控制台输出:
WARN - This is a log message...
 

3.)输出更多的信息内容

int _tmain(int argc, _TCHAR* argv[]) 
        // 定义一个控制台的Appender 
        SharedAppenderPtr pConsoleAppender(new ConsoleAppender()); 

        // 定义Logger 
        Logger pTestLogger = Logger::getInstance(_T("LoggerName"));    

        // 将需要关联Logger的Appender添加到Logger上 
        pTestLogger.addAppender(pConsoleAppender); 

        int n = 6 ; 
        TCHAR *p = _T("TestString") ; 

        // 输出日志信息 
        LOG4CPLUS_WARN(pTestLogger,"This is a log message..."<

  return 0; 
}
运行结果,在控制台输出:
WARN - This is a log message...6 TestString
 

4.)输出到日志文件

int _tmain(int argc, _TCHAR* argv[]) 

        // 定义一个文件Appender 
        SharedAppenderPtr pFileAppender(new FileAppender(_T("d:\\testlog.log"))); 

        // 定义Logger 
        Logger pTestLogger = Logger::getInstance(_T("LoggerName"));    

        // 将需要关联Logger的Appender添加到Logger上 
        pTestLogger.addAppender(pFileAppender); 

        // 输出日志信息 
        LOG4CPLUS_WARN(pTestLogger, "This is a log message..."); 

        return 0; 
}
运行结果,在文件 d:\\testlog.log 中 输出:
WARN - This is a log message...
 

5.)使用更多的格式控制

int _tmain(int argc, _TCHAR* argv[]) 

        // 定义1个控制台的Appender,3个文件Appender 
        SharedAppenderPtr pConsoleAppender(new ConsoleAppender()); 
        SharedAppenderPtr pFileAppender1(new FileAppender(_T("d:\\testlog1.log"))); 
        SharedAppenderPtr pFileAppender2(new FileAppender(_T("d:\\testlog2.log"))); 
        SharedAppenderPtr pFileAppender3(new FileAppender(_T("d:\\testlog3.log"))); 

        // 定义一个简单的Layout,并绑定到 pFileAppender1 
        auto_ptr pSimpleLayout(new SimpleLayout()); 
        pFileAppender1->setLayout(pSimpleLayout); 

        // 定义一个TTCLayout,并绑定到 pFileAppender2 
        auto_ptr pTTCLayout(new TTCCLayout()); 
        pFileAppender2->setLayout(pTTCLayout); 

        // 定义一个PatternLayout,并绑定到 pFileAppender3 
        auto_ptr pPatternLayout(new PatternLayout(_T("%d{%m/%d/%y %H:%M:%S}    - %m [%l]%n"))); 
        pFileAppender3->setLayout(pPatternLayout); 

        // 定义Logger 
        Logger pTestLogger = Logger::getInstance(_T("LoggerName"));    

        // 将需要关联Logger的Appender添加到Logger上 
        pTestLogger.addAppender(pConsoleAppender); 
        pTestLogger.addAppender(pFileAppender1); 
        pTestLogger.addAppender(pFileAppender2); 
        pTestLogger.addAppender(pFileAppender3); 

        // 输出日志信息 
        LOG4CPLUS_WARN(pTestLogger, "This is a log message..."); 
         
        return 0; 
}
输出结果:
在控制台输出:
WARN - This is a log message...
在 d:\testlog1.log 中输出:
WARN - This is a log message...
在 d:\testlog2.log 中输出:
03-30-09 15:07:50,234 [1188] WARN LoggerName <> - This is a log message...
在 d:\testlog3.log 中输出:
03/30/09 07:07:50  - This is a log message... [e:\study\testcode\vs2008\testlog4cplus\testlog4cplus\testlog4cplus.cpp:121]

9. 把设置移到配置文件中

   log4cplus通过PropertyConfigurator类实现了基于脚本配置的功能,通过脚本可以完成对logger、appender和layout的配置。
   配置步骤:

1.)配置Appender名称

  枚举:
  log4cplus.appender.AppenderName1=log4cplus::ConsoleAppender
  log4cplus.appender.AppenderName2=log4cplus::FileAppender
  log4cplus.appender.AppenderName3=log4cplus::RollingFileAppender
  log4cplus.appender.AppenderName4=log4cplus::DailyRollingFileAppender
  log4cplus.appender.AppenderName5=log4cplus::SocketAppender

2.)配置Layout

  可以选择不设置、TTCCLayout、或PatternLayout
  设置TTCCLayout如下所示:
    log4cplus.appender.AppenderName.layout=log4cplus::TTCCLayout
  设置PatternLayout如下所示:
    log4cplus.appender.AppenderName.layout=log4cplus::PatternLayout
    log4cplus.appender.append_1.layout.ConversionPattern=%d{%m/%d/%y %H:%M:%S,%Q} [%t] %-5p - %m%n
 

3.)配置Filter

  可选择的Filter: LogLevelMatchFilter,LogLevelRangeFilter和StringMatchFilter.
  对LogLevelMatchFilter来说,过滤条件包括LogLevelToMatch和AcceptOnMatch,只有当log信息的LogLevel值与LogLevelToMatch相同,且AcceptOnMatch为true时才会匹配。
  对LogLevelRangeFilter来说,过滤条件包括LogLevelMin、LogLevelMax和AcceptOnMatch,只有当log信息的LogLevel在LogLevelMin、LogLevelMax之间同时AcceptOnMatch为true时才会匹配。
  对StringMatchFilter来说,过滤条件包括StringToMatch和AcceptOnMatch,只有当log信息的LogLevel值与StringToMatch对应的LogLevel值与相同,且AcceptOnMatch为true时会匹配。
 

4.)配置Logger

  对于RootLogger,如:
  log4cplus.rootLogger=[LogLevel], appenderName, appenderName, ...
  对于non-root logger来说:
  log4cplus.logger.logger_name=[LogLevel|INHERITED], appenderName, ...

5.)加载配置

   PropertyConfigurator::doConfigure("cfg_filename");

6.)举例:

a.) 对Appender对象进行配置,包括设置Appende名称,Layout和Filter及相关参数。
  设置Appender名称及参数,如:
  log4cplus.appender.AppenderName=log4cplus::FileAppender
  log4cplus.appender.AppenderName.File=d:\testlog.log
 
  设置Layout及参数,如:
  log4cplus.appender.AppenderName.layout=log4cplus::PatternLayout
  log4cplus.appender.AppenderName.layout.ConversionPattern=%d{%m/%d/%y %H:%M:%S,%Q} [%t] %-5p - %m%n
 
  设置Filter及参数,如:
  log4cplus.appender.AppenderName.filters.1=log4cplus::spi::LogLevelRangeFilter
  log4cplus.appender.AppenderName.filters.1.LogLevelMin=DEBUG
  log4cplus.appender.AppenderName.filters.1.LogLevelMax=INFO
  log4cplus.appender.AppenderName.filters.1.AcceptOnMatch=true
  log4cplus.appender.AppenderName.filters.2=log4cplus::spi::DenyAllFilter
      
b.) 设置Logger对象
  log4cplus.rootLogger=TRACE,AppenderName1,AppenderName2
   
c.) 将以上配置保存到文件中,比如:d:\log4clpus.cfg 中,并如何使用:
int _tmain(int argc, _TCHAR* argv[]) 

        PropertyConfigurator::doConfigure(_T("d:\\log4cplus.cfg")); 

        Logger logger = Logger::getRoot(); 
    
        LOG4CPLUS_DEBUG(logger, "This is a DEBUG message");         
        LOG4CPLUS_INFO(logger, "This is a INFO message");         
        LOG4CPLUS_WARN(logger, "This is a WARN message");         
        LOG4CPLUS_ERROR(logger, "This is a ERROR message");         
        LOG4CPLUS_FATAL(logger, "This is a FATAL message"); 

        return 0; 
}


 

 

 

http://www.blogbus.com/public/tb.php/6175002/147072514/38fdcf5c86b19096de0be90ddadca75b

你可能感兴趣的:(log4cplus)