【IT168 專稿】Log4cpp是一個開源的C++類庫，它提供了在C++程序中使用日志和跟蹤調試的功能。使用log4cpp，可以很便利地將日志或者跟蹤調試信息寫入字符流、內存字符串隊列、文件、回滾文件、調試器、Windows日志、syslog和遠程syslog服務器中。
1、Log4cpp簡介
Log4cpp是個基于LGPL的開源項目，移植自Java的日志處理跟蹤項目log4j，并保持了API上的一致。其類似的支持庫還包括Java(log4j)，C++(log4cpp、log4cplus)，C(log4c)，python(log4p)等。
Log4cpp有如下優點：
• 提供了可擴展的多種日志記錄方式；
• 提供了NDC(嵌套診斷上下文)，可用于多線程、多場景的跟蹤調試；
• 提供了完整的日志動態優先級控制，可隨時調整需要記錄的日志優先級；
• 可通過配置文件完成所有配置并動態加載；
• 性能優秀，內存占用小，經過編譯后的log4cpp.dll大小僅有160kb；
• 代碼級的平臺無關性，Log4cpp源代碼經過編譯后，適用于大多數主流的操作系統和開發工具；
• 概念清晰，學習和使用方便，熟練程序員一天之內即可很好地應用log4cpp進行開發。
2、下載和安裝
2.1 下載
Log4cpp的主頁為：http://sourceforge.net/projects/log4cpp/
下載版本0.3.5rc3，這個版本目前是最穩定的，版本1.0在VC中表現不穩定。下載后的包名字為：log4cpp-0.3.5rc3.tar.gz(源代碼包)和log4cpp-docs-0.3.5rc3.tar.gz(文檔壓縮包)。將它們解壓后放入D盤。
2.2 在VC6中編譯Log4cpp
進入D:\log4cpp-0.3.5rc3\msvc6目錄，打開VC6的工作區msvc6.dsw，將其中的工程都刪除，只保留log4cpp和log4cppDLL兩個工程。分別編譯它們的Debug和Release版本。
在VC6中編譯Log4cpp會報錯，其實只有一個錯誤，即不能在頭文件中定義變量，同時給變量賦默認值。修改方法如下：將頭文件Priority.hh中的這一行：
#div_code img{border:0px;}
static const int MESSAGE_SIZE = 8; 改為：
#div_code img{border:0px;}
static const int MESSAGE_SIZE; 并在Priority.cpp中的所有include語句后加上：
#div_code img{border:0px;}
const int log4cpp::Priority::MESSAGE_SIZE = 8; 編譯鏈接成功后會得到log4cppD.dll、log4cppD.lib(Debug版的dll和lib文件)和log4cpp.dll、log4cpp.lib(Release版的dll和lib文件)。新建目錄D:\log4cpp-0.3.5rc3\lib，將以上四個文件拷貝到該目錄下。
在VC中添加設置lib和include路徑。
將D:\log4cpp-0.3.5rc3\lib加入系統的Path路徑中。
2.3 例子程序
本文包含了大量的例子程序，這些程序被組織為多個工程，并放入了一個名為WxbLogDsw的VC工作區。所有代碼被打包為一個名為WxbLogDsw.rar的壓縮文件，解壓后可在VC6以上版本中打開此工程并進行編譯運行。
3、Log4cpp的HelloWorld
讓我們從一個簡單的例子開始，該例子將兩條日志信息寫入字符串流，該流會在標準控制臺cout上輸出，項目的名稱是HelloLog4Cpp：
#div_code img{border:0px;}
#include <iostream>
#include "log4cpp/Category.hh"
#include "log4cpp/OstreamAppender.hh"
#include "log4cpp/BasicLayout.hh"
#include "log4cpp/Priority.hh"
using namespace std;
int main(int argc, char* argv[])
{
log4cpp::OstreamAppender* osAppender = new log4cpp::OstreamAppender("osAppender", &cout);
osAppender->setLayout(new log4cpp::BasicLayout());
log4cpp::Category& root = log4cpp::Category::getRoot();
root.addAppender(osAppender);
root.setPriority(log4cpp::Priority::DEBUG);
root.error("Hello log4cpp in a Error Message!");
root.warn("Hello log4cpp in a Warning Message!");
log4cpp::Category::shutdown();
return 0;
}
要順利編譯運行還有兩個地方需要設置，其一是引入的庫中加上log4cppD.lib(debug版dll庫的引入文件);其二是將C/C++的Code Generation中的Use Runtime library設置為“Debug Multithreaded DLL”。
設置完成后編譯運行結果如下：
#div_code img{border:0px;}
1248337987 ERROR : Hello log4cpp in a Error Message!
1248337987 WARN : Hello log4cpp in a Warning Message! 以上兩條日志格式很簡陋，要設置合乎心意的日志格式，請參考后續的PatternLayout章節。
4、概念
Log4cpp中的概念繼承自log4j，最重要的是Category(種類)、Appender(附加目的地)和Layout(布局)三個概念，此外還有Priority(優先級)和NDC(嵌套的診斷上下文)等。
簡言之，Category負責向日志中寫入信息，Appender負責指定日志的目的地，Layout負責設定日志的格式，Priority被用來指定Category的優先級和日志的優先級， NDC則是一種用來區分不同場景中交替出現的日志的手段。
Log4cpp記錄日志的原理如下：每個Category都有一個優先級，該優先級可以由setPriority方法設置，或者從其父Category中繼承而來。每條日志也有一個優先級，當Category記錄該條日志時，若日志優先級高于Category的優先級時，該日志被記錄，否則被忽略。系統中默認的優先級等級如下：
注意：取值越小，優先級越高。例如一個Category的優先級為101，則所有EMERG、FATAL、ALERT日志都可以記錄下來，而其他則不能。
Category、Appender和Layout三者的關系如下：系統中可以有多個Category，它們都是繼承自同一個根，每個Category負責記錄自己的日志;每個Category可以添加多個Appender，每個Appender指定了一個日志的目的地，例如文件、字符流或者Windows日志，當Category記錄一條日志時，該日志被寫入所有附加到此Category的Appender;每個Append都包含一個Layout，該Layout定義了這個Appender上日志的格式。
現在重溫前面的HelloWorld程序，可以發現其流程如下：
1. 創建一個Appender，并指定其包含的Layout；
2. 從系統中得到Category的根，將Appender添加到該Category中；
3. 設置Category的優先級；
4. 記錄日志；
5. 關閉Category。
下面，我們按照Layout、Appender、Category、NDC的順序來依次介紹這些概念并給出例子。
5、Layout(布局)
首先回顧一下HelloWorld的日志格式，它使用了最簡單的BasicLayout：
#div_code img{border:0px;}
1248337987 ERROR : Hello log4cpp in a Error Message!
1248337987 WARN : Hello log4cpp in a Warning Message! 上面的日志格式還可以，但顯然不是許多程序員心中理想的格式，許多人理想的格式應該是這樣的：
要獲得上面的格式，必須使用比BasicLayout復雜的PatternLayout，而且要花一個小時來熟悉一下PatternLayout的格式定義方式，如果你認為值得的話。
5.1 PatternLayout
在介紹PatternLayout以前，首先來看看log4cpp中所有的Layout子類(Layout本身是個虛類)，一共三個：BasicLayout、PatternLayout和SimpleLayout，其中SimapleLayout并不建議使用，而BaiscLayout過于簡單，因此如果程序員不自己擴展Layout的話，就只能使用PatternLayout了，值得慶幸的是，PatternLayout還是比較好用的。
PatternLayout使用setConversionPattern函數來設置日志的輸出格式。該函數的聲明如下：
#div_code img{border:0px;}
void log4cpp::PatternLayout::setConversionPattern ( const std::string & conversionPattern ) throw (ConfigureFailure) [virtual] 其中參數類型為std::string，類似于C語言中的printf，使用格式化字符串來描述輸出格式，其具體含義如下：
因此，要得到上述的理想格式，可以將setConversionPattern的參數設置為“%d: %p %c %x: %m%n”，其具體含義是“時間: 優先級 Category NDC: 消息 換行”。使用PatternLayout的例子程序如下，項目名稱是LayoutExam：
其運行結果即如下所示：
6、Appender
筆者認為Appender是log4cpp中最精彩的一個部分。我仔細閱讀了大部分Appender的源代碼并對設計者感到非常敬仰。
Log4cpp中所有可直接使用的Appender列表如下：
其中SyslogAppender和RemoteSyslogAppender需要與Syslog配合使用，因此這里不介紹。順便提一句，Syslog是類Unix系統的一個核心服務，用來提供日志服務，在Windows系統中并沒有直接提供支持，當然可以用相關工具提供Windows系統中的syslog服務。
IdsaAppender的功能是將日志寫入Idsa服務，這里也不介紹。因此主要介紹以下Appender：
6.1 OstreamAppender
在我剛剛學習C/C++編程時，一位老師告訴我，如果沒有好用的調試工具，就在代碼中加入printf語句，將調試信息打印出來(當時在linux下面，確實沒有什么易用的c++調試工具)。現在有了OstreamAppender，一切都好辦了，它可以將日志記入一個流，如果該流恰好是cout，則會在標準控制臺上輸出。比printf優越的是，除了輸出消息外，還可以輕松的輸出時間、時鐘數、優先級等大量有用信息。
OstreamAppender的使用非常簡單，在前面的HelloWorld程序中已經見過，創建一個OstreamAppender的具體方法如下：
#div_code img{border:0px;}
log4cpp::OstreamAppender* osAppender = new log4cpp::OstreamAppender("osAppender", &cout); 第一個參數指定OstreamAppender的名稱，第二個參數指定它關聯的流的指針。
6.2 StringQueueAppender
后來一位高手又告訴我“在調試多線程程序時，不能隨意使用printf”。因為printf導致IO中斷，會使得本線程掛起，其花費的時間比一條普通指令多數千倍，若多個線程同時運行，則嚴重干擾了線程間的運行方式。所以調試多線程程序時，最好是將所有調試信息按順序記入內存中，程序結束時依次打印出來。為此當時我們還寫了一個小工具，沒想到時隔多年，我碰上了StringQueueAppender。
我很懷疑StringQueueAppender被設計出來就是用于記錄多線程程序或者實時程序的日志，雖然log4cpp的文檔中并沒有明確指出這一點。StringQueueAppender的功能是將日志記錄到一個字符串隊列中，該字符串隊列使用了STL中的兩個容器，即字符串容器std::string和隊列容器std::queue，具體如下：
#div_code img{border:0px;}
std::queue<std::string> _queue; _queue變量是StringQueueAppender類中用于具體存儲日志的內存隊列。StringQueueAppender的使用方法與OstreamAppender類似，其創建函數只接收一個參數“名稱”，記錄完成后需要程序員自己從隊列中取出每條日志，例子程序StringQueueAppenderExam如下：
程序輸出為：
6.3 FileAppender和RollingFileAppender
FileAppender和RollingFileAppender是log4cpp中最常用的兩個Appender，其功能是將日志寫入文件中。它們之間唯一的區別就是前者會一直在文件中記錄日志(直到操作系統承受不了為止)，而后者會在文件長度到達指定值時循環記錄日志，文件長度不會超過指定值(默認的指定值是10M byte)。
FileAppender的創建函數如下：
一般僅使用前兩個參數，即“名稱”和“日志文件名”。第三個參數指示是否在日志文件后繼續記入日志，還是清空原日志文件再記錄。第四個參數說明文件的打開方式。
RollingFileAppender的創建函數如下：
它與FileAppender的創建函數很類似，但是多了兩個參數：maxFileSize指出了回滾文件的最大值;maxBackupIndex指出了回滾文件所用的備份文件的最大個數。所謂備份文件，是用來保存回滾文件中因為空間不足未能記錄的日志，備份文件的大小僅比回滾文件的最大值大1kb。所以如果maxBackupIndex取值為3，則回滾文件(假設其名稱是rollwxb.log，大小為100kb)會有三個備份文件，其名稱分別是rollwxb.log.1，rollwxb.log.2和rollwxb.log.3，大小為101kb。另外要注意：如果maxBackupIndex取值為0或者小于0，則回滾文件功能會失效，其表現如同FileAppender一樣，不會有大小的限制。這也許是一個bug。
例子程序FileAppenderExam如下：
程序運行后會產生兩個日志文件wxb.log和rollwxb.log，以及一個備份文件rollwxb.log.1。wxb.log的大小為7kb，記錄了所有100條日志;rollwxb.log大小為2kb，記錄了最新的22條日志;rollwxb.log.1大小為6kb，記錄了舊的78條日志。
6.4 Win32DebugAppender
Win32DebugAppender是一個用于調試的Appender，其功能是向Windows的調試器中寫入日志，目前支持MSVC和Borland中的調試器。創建Win32DebugAppender僅需要一個參數“名稱”，其使用非常簡單，下面是例子代碼DebugAppenderExam：
在VC6中調試該代碼會得到如下圖所示的調試信息，注意最下方的兩行調試信息：
6.5 NTEventLogAppender
該Appender可以將日志發送到windows的日志，在運行程序后可以打開windows的計算機管理?系統工具?事件查看器?應用程序，可以看到下圖，注意圖中第一行和第二行的兩個日志。
例子程序NTAppenderExam如下：
7、Category
Log4cpp中有一個總是可用并實例化好的Category，即根Category。使用log4cpp::Category::getRoot()可以得到根Category。在大多數情況下，一個應用程序只需要一個日志種類(Category)，但是有時也會用到多個Category，此時可以使用根Category的getInstance方法來得到子Category。不同的子Category用于不同的場合。一個簡單的例子CategoryExam如下所示：
運行結果如下：
這個例子中共有三個Category，分別是根、sub1和sub2，其中sub1記錄了一條日志，sub2記錄了兩條日志。Sub2另外兩個日志由于優先級不夠未能記錄。
8、NDC
NDC是nested Diagnostic Context的縮寫，意思是“嵌套的診斷上下文”。NDC是一種用來區分不同源代碼中交替出現的日志的手段。當一個服務端程序同時記錄好幾個并行客戶時，輸出的日志會混雜在一起難以區分。但如果不同上下文的日志入口擁有一個特定的標識，則可以解決這個問題。NDC就是在這種情況下發揮作用。注意NDC是以線程為基礎的，每個線程擁有一個NDC，每個NDC的操作僅對執行該操作的線程有效。
NDC的幾個有用的方法是：push、pop、get和clear。注意它們都是靜態函數：
Push可以讓當前線程進入一個NDC，如果該NDC不存在，則根據push的參數創建一個NDC并進入;如果再調用一次push，則進入子NDC;
Pop可以讓當前線程從上一級NDC中退出，但是一次只能退出一級。
Clear可以讓當前線程從所有嵌套的NDC中退出。
Get可以得到當前NDC的名字，如果有嵌套，則不同級別之間的名字用空格隔開。
一個簡單的例子NDCExam如下：
該例子來自log4cpp的例子程序，我做了簡單的修改。在記錄日志的時候，可以從NDC中得知當前線程的嵌套關系。
9、Log4cpp的自動內存管理
9.1 項目的多線程設置
VC中必須將項目設置為Debug MultiThreaded DLL，總之這個設置必須與你使用的Log4cpp庫一致。如果你使用的是Release版本的log4cpp.dll，則應該設置為MultiThreaded DLL。
否則在程序結束時會報錯，報錯處的調用堆棧為：
9.2 Log4cpp的內存對象管理
也許讀者已經注意到，在前面的所有代碼中，log4cpp中所有動態分配的對象都沒有手動釋放。
Log4cpp中new出來的Category、Appender和Layout都不需要手動釋放，因為Log4cpp使用了一個內部類來管理這些對象。此類的名稱是HierarchyMaintainer，它負責管理Category的繼承關系，在程序結束時，HierarchyMaintainer會依次釋放所有Category，而Category則會依次釋放擁有的有效Appender，Appender則會釋放所有附屬的Layout。如果程序員手動釋放這些對象，則會造成內存報錯。
從下面的代碼可以看出這個特征：
#div_code img{border:0px;}
appender->setLayout(new log4cpp::BasicLayout()); 這個new出來的BasicLayout根本就沒有保存其指針，所以它只能被log4cpp的內存管理類HierarchyMaintainer釋放。
了解到HierarchyMaintainer的內存管理方法后，程序員在使用log4cpp時應該遵循以下幾個使用原則：
1. 不要手動釋放Category、Appender和Layout;
2. 同一個Appender不要加入多個Category，否則它會被釋放多次從而導致程序崩潰;
3. 同一個Layout不要附著到多個Appender上，否則也會被釋放多次導致程序崩潰;
下面這個簡單的程序PointerErrorExam會造成經典的崩潰：
運行后出現對話框：
#div_code img{border:0px;}
PointerErrorExam.exe 遇到問題需要關閉。我們對此引起的不便表示抱歉。 其原因就是osAppender被同時加入了sub1和sub2這兩個Category。
9.3 log4cpp::Category::shutdown()
在不使用log4cpp時可調用log4cpp::Category::shutdown()，其功能如同HierarchyMaintainer的內存清理。但如果不手動調用，在程序結束時HierarchyMaintainer會調用Category的析構函數來釋放所有Appender。
10、利用配置文件定制日志
如同log4j一樣，log4cpp也可以讀取配置文件來定制Category、Appender和Layout對象。其配置文件格式基本類似于log4j，一個簡單的配置文件log4cpp.conf例子如下(來自log4cpp的API手冊)：
這是一個標準的java屬性文件。讀取配置文件要依賴PropertyConfigurator和SimpleConfigurator類。這里僅介紹PropertyConfigurator，其使用方法代碼ConfigFileExam所示(該代碼來自《便利的開發工具-log4cpp快速使用指南》一文)：
該程序首先讀入了配置文件log4cpp.conf，從中得到了所有Category、Appender和Layout的優先級和相互附屬關系，然后輸出了一些日志，其運行結果如下：
11、DLL的版本問題
若在VC6中使用Log4cpp的DLL，則必須使用VC6編譯鏈接生成的DLL，不能使用MSVS2008中生成的DLL，反之也是一樣。否則會在運行時報錯。
為此專門提供了兩個版本的DLL，供大家使用。
12、小結
Log4cpp是一個小巧的c++庫，易于上手，使用方便，不依賴其他庫，具有跨平臺性，并可與log4j、log4c、log4p等語言族共享其概念與使用方法。實在是進行日志記錄、程序調試的利器。