開源日誌庫<log4cplus+VS2008使用>整理

一.簡介

    log4cplus是C++編寫的開源的日誌系統，功能非常全面.本文介紹如何在Windows+VS2008中使用該日誌庫。

 

二.下載

    可從網站[url]http://log4cplus.sourceforge.net[/url]上去下載 log4cplus 1.0.3 rc9,具體地址[url]http://downloads.sourceforge.net/log4cplus/log4cplus-1.0.3-rc9.tar.bz2?use_mirror=nchc[/url]，同時附件也帶有這個庫。

 

三.配置環境

    1. 將庫解壓到C:\log4cplus下面，使用VS2008打開.\msvc8\log4cplus.sln,編譯log4cplus_static(Debug_Unicode+Release_Unicode),並將生成的Lib(log4cplusUS.lib+log4cplusUSD.lib)複製到.\Lib目錄下。

    2. 將.\Include和.\Lib分別添加到VS2008的搜索路徑下。

    3. 在我們的工程中，添加預定義 LOG4CPLUS_STATIC。

    3. 只需要包含相應的頭文件和鏈接相應的庫就可以正常的使用log4cplus進行日誌的管理了。

    4.注意編譯的庫和使用的程序，使用的CRT方式的一致，如下所示：

   

   

    5. 另外還可以使用動態鏈接的方式去使用log4cplus,這裏不介紹了。

 

四.log4cplus框架

1.log4cplus基本元素

    Layouts       ：控制輸出消息的格式。
    Appenders  ：輸出位置。
    Logger         ：日誌對象。
    Priorities      ：優先權，包括TRACE, DEBUG, INFO, WARNING, ERROR, FATAL。

 

2.log4cplus基本結構

   

3. 使用步驟：

    a.) 生成Appender對象。

    b.) 生成Layout對象，並綁定到Appender。(可選)

    c.) 生成Logger對象。

    d.) 設置Logger優先級。(可選)

    e.) 將需要關聯Logger的Appender添加到Logger上。

    f.) 使用Logger輸出信息，所有大於設定的優先級的信息，並在所有掛接在該Logger對象上的Appender上以相應的Layout設定的格式顯示出來。

 

五.log4cplus內容介紹

1. Logger對象

    Logger對象具有層次結構，按名稱區分，如下代碼：   

Logger test = Logger::getInstance("test");
Logger subtest = Logger::getInstance("test.subtest");

    對象subtest是test的子對象。

 

2. 優先級

    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。

 

3.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"等等。

 

4.) Appender輸出位置

（1）控制檯輸出

        ConsoleAppender

（2）文件輸出

        FileAppender / RollingFileAppender / DailyRollingFileAppender .

 

FileAppender :

    實現了基本的文件操作功能，構造函數如下:

    FileAppender(filename,mode,immediateFlush);

 

<filename > 文件名
<mode> 文件類型，可選擇的文件類型包括app,ate,binary,in,out,trunc。缺省是trunc，表示將先前文件刪除。
<immediateFlush> 緩衝刷新標誌.

 

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。

 

六.測試代碼

1. 一個基本框架的例子

//Include .h file
#include <log4cplus/logger.h>
#include <log4cplus/fileappender.h>
#include <log4cplus/consoleappender.h>
#include <log4cplus/layout.h>

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<Layout> 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 <Warn> log message...");

        return 0;
}

運行結果，在控制檯輸出：

WARN - This is a <Warn> 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 <Warn> log message..."); 
        

        return 0;
}

運行結果，在控制檯輸出：

WARN - This is a <Warn> 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 <Warn> log message..."<<n<<" "<<p);

  return 0;
}

運行結果，在控制檯輸出：

WARN - This is a <Warn> 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 <Warn> log message..."); 

        return 0;
}

運行結果，在文件 d:\\testlog.log 中 輸出：

WARN - This is a <Warn> 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<Layout> pSimpleLayout(new SimpleLayout());
        pFileAppender1->setLayout(pSimpleLayout);

        // 定義一個TTCLayout,並綁定到 pFileAppender2
        auto_ptr<Layout> pTTCLayout(new TTCCLayout());
        pFileAppender2->setLayout(pTTCLayout);

        // 定義一個PatternLayout,並綁定到 pFileAppender3
        auto_ptr<Layout> 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 <Warn> log message...");
        
        return 0;
}

輸出結果：

在控制檯輸出：

WARN - This is a <Warn> log message...

在 d:\testlog1.log 中輸出：

WARN - This is a <Warn> log message...

在 d:\testlog2.log 中輸出：

03-30-09 15:07:50,234 [1188] WARN LoggerName <> - This is a <Warn> log message...

在 d:\testlog3.log 中輸出：

03/30/09 07:07:50  - This is a <Warn> log message... [e:\study\testcode\vs2008\testlog4cplus\testlog4cplus\testlog4cplus.cpp:121]

 

七.把設置移到配置文件中

    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;
}