一個(gè)簡單的異步日志模塊,基本達(dá)到了靈活、高效、易用的目標(biāo)。
此日志模塊為文本日志,異步記錄方式,即有單獨(dú)的線程負(fù)責(zé)寫日志文件。
具備以下特征:
1、可同時(shí)操作N個(gè)日志文件,N可配置;
2、可動(dòng)態(tài)添加、刪除和替換日志文件;
3、良好的多線程支持;
4、C++流風(fēng)格的日志消息生成方式;
發(fā)布形式為ZLog.dll,使用時(shí)只需包含ZLog.h并連接ZLog.lib即可。
日志文件操作函數(shù):
// 啟動(dòng)日志模塊,logfile為日志文件名,level為輸出到文件的最低日志等級(jí),nQueueLength為內(nèi)部緩沖隊(duì)列的最大長度,一般使用默認(rèn)值即可
// 日志等級(jí)由高至低分別為:LL_NONE、LL_FATAL、LL_ERROR、LL_WARNING、LL_INFO
// 例如,若level為LL_WARNING,則僅記錄LL_WARNING、LL_ERROR和LL_FATAL等級(jí)的日志消息,而不記錄LL_INFO等級(jí)的日志消息
// 成功啟動(dòng)后logfile的序號(hào)為0
// 返回0表明成功,其它值表明失敗
int __cdecl startup(LPCTSTR logfile, LONG level, unsigned int nQueueLength = 256);
// 關(guān)閉日志模塊
void __cdecl cleanup();
// 刪除一個(gè)日志文件,fileindex指定該文件的序號(hào)(>= 0),僅有一個(gè)日志文件時(shí),不允許刪除
BOOL __cdecl removefile(unsigned int fileindex);
// 得到日志文件的大小,fileindex為該文件的序號(hào)(>= 0)
BOOL __cdecl getfilesize(unsigned int fileindex, ULARGE_INTEGER *lpuliFileSize);
// 將文件序號(hào)為fileindex的日志文件替換為newlogfile指定的文件,fileindex必需有效。
// 若當(dāng)前有三個(gè)日志文件log1.txt,log2.txt和log3.txt,則序號(hào)分別為0,1,2。
// 若刪除1代表的日志文件(即log2.txt),則log1.txt的序號(hào)不變,依然為0,log3.txt的序號(hào)變?yōu)?,同時(shí)序號(hào)2失效。
BOOL __cdecl replacefile(unsigned int fileindex, LPCTSTR newlogfile);
// 添加新的日志文件,newlogfile為文件名,若成功則返回新文件的序號(hào)(>= 0),若失敗,返回-1。日志文件最大數(shù)量為16
int __cdecl addfile(LPCTSTR newlogfile);
以上所有函數(shù)都是線程安全的。
使用方法:
loginfo,logwarn,logerr,logfatal分別生成information,warning,error,fatal類型的日志消息;
輸入?yún)?shù)格式與cout(ostream)基本一致,不同之處在于:
1、可接受Unicode字符串
2、第一個(gè)輸入?yún)?shù)可為choosefile(n),其中n為目標(biāo)日志文件的序號(hào)
例子:
1 #include "ZLog.h"
2
3 using namespace ZLog;
4
5 int _tmain(int argc, _TCHAR* argv[])
6 {
7 startup(TEXT("log1.txt"));
8
9 addfile(TEXT("log2.txt"));
10 addfile(TEXT("log3.txt"));
11
12 loginfo<<"log entry to log1.txt"; // log1.txt, impliedly "choosefile(0)"
13 logwarn<<choosefile(1)<<L"log entry to log2.txt"; // log2.txt
14 logerr<<choosefile(2)<<L"log entry to log3.txt"; // log3.txt
15
16 removefile(2); // remove log3.txt
17
18 logerr<<choosefile(2)<<"log entry to log3.txt"; // log3.txt has been removed, so log entry will be redirected to log1.txt
19
20 addfile(TEXT("newlog3.txt")); // add "newlog3.txt"
21 logerr<<choosefile(2)<<"log entry to newlog3.txt";
22
23 replacefile(1, TEXT("newlog2.txt")); // replace log2.txt with newlog2.txt
24
25 logfatal<<choosefile(1)<<"log entry to newlog2.txt";
26
27 replacefile(1, TEXT("newnewlog2.txt")); // replace newlog2.txt with newnewlog2.txt
28 logfatal<<choosefile(1)<<"log entry to newnewlog2.txt";
29
30 cleanup();
31 return 0;
32 }
33
上例為單線程演示,在多線程環(huán)境下同樣適用。
同一個(gè)程序中,若有多個(gè)模塊同時(shí)引用了ZLog.dll,只需要調(diào)用一次startup和cleanup即可,但多次調(diào)用亦無副作用。
有興趣的朋友可以測試一下,發(fā)現(xiàn)任何問題請告訴我。
DLL下載 源代碼下載