開源日誌系統 - log4cplus (二)

本文介紹了使用log4cplus有六個步驟，並提供了一些例子引導你瞭解log4cplus的基本使用。

				
### 基本使用 ###

使用log4cplus有六個基本步驟：

1. 實例化一個appender對象
2. 實例化一個layout對象
3. 將layout對象綁定(attach)到appender對象
4. 實例化一個logger對象,調用靜態函數：log4cplus::Logger::getInstance("logger_name")
5. 將appender對象綁定(attach)到logger對象，如省略此步驟，標準輸出（屏幕）appender對象會綁定到logger
6. 設置logger的優先級，如省略此步驟，各種有限級的消息都將被記錄

下面通過一些例子來了解log4cplus的基本使用。

〖例1〗
/*
    嚴格實現步驟1-6，appender輸出到屏幕, 其中的佈局格式和LogLevel後面會詳細解釋。
*/
#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 _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(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]

				
〖例2〗
/*
    簡潔使用模式，appender輸出到屏幕。
*/
#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(new ConsoleAppender());
    _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...

				
〖例3〗
/*
    iostream模式，appender輸出到屏幕。
*/
#include <log4cplus/logger.h>
#include <log4cplus/consoleappender.h>
#include <iomanip> /* 其實這個東東還是放到log4cplus頭文件中比較合適些，個人意見：） */using namespace log4cplus;

int main()
{
    /* step 1: Instantiate an appender object */
    SharedAppenderPtr _append(new ConsoleAppender());
    _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〗
/*
    調試模式，通過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()
{
    /*
       LogLog類實現了debug, warn, error 函數用於輸出調試、警告或錯誤信息，
       同時提供了兩個方法來進一步控制所輸出的信息，其中：

       setInternalDebugging方法用來控制是否屏蔽輸出信息中的調試信息，當輸入
       參數爲false則屏蔽，缺省設置爲false。

       setQuietMode方法用來控制是否屏蔽所有輸出信息，當輸入參數爲true則屏蔽，
       缺省設置爲false。

       LogLog::getLogLog()->setInternalDebugging(false);
    */

    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:"前綴，有時候會感覺不爽，這是因爲LogLog在實現時候死定了要這麼寫：

LogLog::LogLog()
 : mutex(LOG4CPLUS_MUTEX_CREATE),
   debugEnabled(false),
   quietMode(false),
   PREFIX( LOG4CPLUS_TEXT("log4cplus: ") ),
   WARN_PREFIX( LOG4CPLUS_TEXT("log4cplus:WARN ") ),
   ERR_PREFIX( LOG4CPLUS_TEXT("log4cplus:ERROR ") )
{
}

你可以把這些前綴換成自己看着爽的提示符號，然後重新編譯，hihi。除非萬不得已或者實在鬱悶的不行，否則還是不要這樣幹。

				
〖例5〗

/*    文件模式，appender輸出到文件。*/
#include <log4cplus/logger.h>
#include <log4cplus/fileappender.h>
using namespace log4cplus;
int main()
{    
/* step 1: Instantiate an appender object */
    SharedAppenderPtr _append(new FileAppender("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 #