fastlog 的使用

C++ 通用框架的設(shè)計(jì) 作者： naven

1           fastlog 介紹

fastlog 是參考 log4j 和 log4cplus 框架使用 javen c++ 庫設(shè)計(jì)實(shí)現(xiàn)的日志記錄庫，具有 log4j 庫類似的優(yōu)點(diǎn)，記錄日志非常方便，擴(kuò)展和配置也非常容易。 Log4j 日志庫我想應(yīng)該在 java 的領(lǐng)域已經(jīng)應(yīng)用很廣泛了，這樣的日志庫可以非常方便地將日志輸出到屏幕、文件、 syslog 、遠(yuǎn)程服務(wù)器等任何地方，而日志輸出的格式也可以任意調(diào)整，可以很容易控制輸出的日志級(jí)別，而這一切僅需修改一下配置文件，應(yīng)用程序不用作任何修改。

fastlog 主要有如下一些模塊

Appenders                          掛接器，定義一些日志輸出的設(shè)備終端，如文件、屏幕等

Layouts                                布局器，定義輸出的日志格式

         Hierarchies                           分類器，用于對(duì)日志信息分類，即對(duì)日志分級(jí)，用戶不能直接調(diào)用

         LoglevelManager               日志級(jí)別管理器，即 TRACE, DEBUG, INFO, WARNING, ERROR 等

Logger                                  記錄器，即記錄日志的對(duì)象，每個(gè)應(yīng)用模塊應(yīng)該擁有一個(gè) Logger

         PropertyConfigurator         配置器，用于通過配置文件配置 Logger 和 Appender 、 Layout 等

2           Hello World!

下面的程序示例如何使用 fastlog 記錄日志：

//  定義一個(gè)該應(yīng)用模塊使用的Logger記錄器，命名為”log”
static  Logger _logger  =  Logger::getInstance( " log " );
void  main() 
{
//  配置器讀取配置文件fastlog.properties初始化Logger,只初始化一次
    PropertyConfigurator::doConfigure( " fastlog.properties " ); 
     //  輸出日志
    _logger.notice( " This is the NOTICE log message”); 
}

日志輸出可能（與 fastlog.properties 配置有關(guān)）如下：

1           fastlog 配置文件

fastlog 配置文件可能會(huì)較復(fù)雜，下面先介紹一個(gè)典型的 fastlog.properties 如下：

下面講講主要用到的 Appender 和 Layout 的用法

2           fastlog::ConsoleAppender 輸出設(shè)備

輸出到控制臺(tái)的 Appender ，比較簡單就不詳細(xì)講了。

還有 fastlog::FileAppender 也比較簡單，實(shí)際用處也不大，配置跟下面類似。

還有 fastlog::NullAppender 比較特殊，哪里也不輸出，主要用于測試。

3           fastlog::DailyFileAppender 輸出設(shè)備

按日期時(shí)間等自動(dòng)切分日志的 Appender ，意思是會(huì)輸出到帶時(shí)間格式命名的文件，到新的時(shí)間段如下一天，則自動(dòng)生成新的日期命名的文件輸出，日志會(huì)自動(dòng)切分，推薦使用。

舉例，按上面的例子，如果當(dāng)前時(shí)間是 2006-8-10 12:00:00 ，日志會(huì)自動(dòng)輸出到 2006081012.log 的文件中，如果當(dāng)前時(shí)間變成 2006-8-10 13:01:00 ，則日志系統(tǒng)會(huì)自動(dòng)創(chuàng)建名為 2006081013.log 的文件，并將新日志輸出到此新文件中。

配置定義如下：

4           fastlog::RollingFileAppender 輸出設(shè)備

按文件大小自動(dòng)滾動(dòng)日志的 Appender ，這種方式 Unix 的 syslog 用的比較多。當(dāng)日志文件達(dá)到一定大小后就自動(dòng)換一個(gè)名字備份起來，所以當(dāng)前日志文件始終不會(huì)超過一定大小。

配置定義如下：

5           fastlog::DailyRollingFileAppender 輸出設(shè)備

按日期自動(dòng)滾動(dòng)日志的 Appender 。它與上面的 RollingFileAppender 類似，不同就是時(shí)間經(jīng)過一定時(shí)間段就自動(dòng)滾動(dòng)日志備份起來。而時(shí)間的處理又與 fastlog::DailyFileAppender 類似。

配置定義如下：

6           fastlog::SocketAppender 輸出設(shè)備

這個(gè)比較特殊，它可以將日志輸出到某臺(tái)服務(wù)器，通過指定日志服務(wù)器的 IP/ 域名和端口。

配置定義如下：

下面介紹幾種 Layout

7           fastlog::SimpleLayout 布局器

這個(gè)非常，只是在輸出的原始日志前加個(gè) Loglevel 和一個(gè) ”-” ，如：

DEBUG - This is the simple formatted log message 

8           fastlog::TTCCLayout 布局器

這是一種缺省的帶格式輸出的布局器，其格式由時(shí)間、線程 ID 、 Logger 和 NDC 組成（ consists of time, thread, Logger and nested diagnostic context information, hence the name ）。 TTCCLayout 在使用時(shí)可以選擇顯示本地時(shí)間或 GMT 時(shí)間，缺省是按照本地時(shí)間顯示。

典型輸出如下：

10-16-06 12:12:23,321 [1075298944] DEBUG log <> - this is a TTCCLayout log format

9           fastlog::PatternLayout 布局器

這是一種有詞法分析功能的模式布局器，應(yīng)用最廣泛，也最強(qiáng)大，推薦使用，下面詳細(xì)介紹。

用戶可以根據(jù)一些定義好的標(biāo)識(shí)符自定義輸出格式，如上面的例子：

          其中的 %D{%Y-%m-%d %H:%M:%S.%q} [%c:%R:%T]-[%5p] %m %n 即是一種輸出模式。

下面詳細(xì)介紹這些標(biāo)識(shí)符的定義：

（ 1 ） "%%" ，轉(zhuǎn)義為 % ，即 pattern = "%%" 時(shí)輸出 "%" 

（ 2 ） "%c" ，輸出 logger 名稱，比如 pattern ="%c" 時(shí)輸出 : "test.logger.mytest " ，也可以控制 logger 名稱的顯示層次，比如 "%c{1}" 時(shí)輸出 "test_logger" ，其中數(shù)字表示層次。 

（ 3 ） "%D" ，顯示本地時(shí)間，當(dāng) pattern ="%D" 時(shí)輸出 :"2006-8-10 20:55:25" ， %d 顯示標(biāo)準(zhǔn)時(shí)間。還可以通過 %d{} 定義更詳細(xì)的顯示格式，比如 %d{%H:%M:%s} 表示要顯示小時(shí)：分鐘：秒。 

大括號(hào)中可顯示的預(yù)定義標(biāo)識(shí)符如下： 

%a            表示禮拜幾，英文縮寫形式，比如 "Fri" 

%A           表示禮拜幾，比如 "Friday" 

%b             表示幾月份，英文縮寫形式，比如 "Oct" 

%B           表示幾月份， "October" 

%c            標(biāo)準(zhǔn)的日期＋時(shí)間格式，如 "Sat Oct 16 18:56:19 2006" 

%d             表示今天是這個(gè)月的幾號(hào) (1-31)"16" 

%H            表示當(dāng)前時(shí)刻是幾時(shí) (0-23) ，如 "18" 

%I              表示當(dāng)前時(shí)刻是幾時(shí) (1-12) ，如 "6" 

%j              表示今天是哪一天 (1-366) ，如 "290" 

%m            表示本月是哪一月 (1-12) ，如 "10" 

%M           表示當(dāng)前時(shí)刻是哪一分鐘 (0-59) ，如 "59" 

%p             表示現(xiàn)在是上午還是下午， AM or PM 

%q             表示當(dāng)前時(shí)刻中毫秒部分 (0-999) ，如 "237" 

%Q            表示當(dāng)前時(shí)刻中帶小數(shù)的毫秒部分 (0-999.999) ，如 "430.732" 

%S             表示當(dāng)前時(shí)刻的多少秒 (0-59) ，如 "32" 

%U            表示本周是今年的第幾個(gè)禮拜，以周日為第一天開始計(jì)算 (0-53) ，如 "41" 

%w            表示禮拜幾， (0-6, 禮拜天為 0) ，如 "6" 

%W           表示本周是今年的第幾個(gè)禮拜，以周一為第一天開始計(jì)算 (0-53) ，如 "41" 

%x             標(biāo)準(zhǔn)的日期格式，如 "08/10/06" 

%X            標(biāo)準(zhǔn)的時(shí)間格式，如 "19:02:34" 

%y             兩位數(shù)的年份 (0-99) ，如 "06" 

%Y            四位數(shù)的年份，如 "2006" 

%Z            時(shí)區(qū)名，比如 "GMT" 

  

（ 4 ） "%F" ，輸出當(dāng)前記錄器所在的文件名稱，比如 pattern ="%F" 時(shí)輸出 : "main.cpp" 

（ 5 ） "%L" ，輸出當(dāng)前記錄器所在的文件行號(hào)，比如 pattern ="%L" 時(shí)輸出 : "51" 

（ 6 ） "%l" ，輸出當(dāng)前記錄器所在的文件名稱和行號(hào)，比如 pattern ="%L" 時(shí)輸出 :     "main.cpp:51" 

（ 7 ） "%m" ，輸出原始信息，比如 pattern ="%m" 時(shí)輸出 : "this a test log" 。 

（ 8 ） "%n" ，換行符 

（ 9 ） "%p" ，輸出 LogLevel ，比如 pattern ="%p" 時(shí)輸出 : "DEBUG" 

（ 10 ） "%R" ，輸出記錄器所在的進(jìn)程 ID ，比如 pattern ="%R" 時(shí)輸出 : "567" 

（ 11 ） "%T" ，輸出記錄器所在的線程 ID ，比如 pattern ="%T" 時(shí)輸出 : "2332" 

（ 12 ） "%x" ，嵌套診斷上下文 NDC (nested diagnostic context) 輸出，從堆棧中彈出上下文信息。 

（ 13 ）格式對(duì)齊，比如 pattern ="%-10m" 時(shí)表示左對(duì)齊，寬度是 10 ，此時(shí)會(huì)輸出 "teststr   " ，當(dāng)然其它的控制字符也可以相同的方式來使用，比如 "%-12d" ， "%-5p" 等。 

  

C++ 通用框架的設(shè)計(jì) 作者： naven 日期： 2006-8-10