孤實現的日誌庫

zuiwuchang

c/c++ 中一直沒有 孤鍾意的 日誌庫 boost1.54開始 提供了一個 boost::log 才少有 解決 此問題 然 boost::log 雖然強大 然不能滿足 孤的需求
對於 應用程序 日誌 使用 boost::log 應該是 最好的 選擇 （http://www.boost.org/doc/libs/1_62_0/libs/log/doc/html/index.html）

然 作為 調試用的 日誌 輸出 選擇boost::log 就 太過不明智了
首先 boost::log 需要 依賴其它幾個 需要編譯的 boost組件 故不編譯 boost 無法使用
boost 環境 太大 對於 一些 短小的 代碼 加入 boost::log 調試 不太 合宜
故 孤 實現了一個調試用的 日誌輸出 庫
孤所有實現 全部使用 宏 在release 時 去掉 宏標記 即可 將 debug代碼 全部 移除

先看 一段 示例代碼

1. #include <fstream>
   
2. 
   
3. //#define KING_DEBUG_USE_DEBUG
   
4. #define KING_DEBUG_USE_RELEASE
   
5. 
   
6. //可選的 替代 tag
   
7. #define KING_DEBUG_TAG_TRACE "[TRACE]"
   
8. #define KING_DEBUG_TAG_DEBUG "[DEBUG]"
   
9. #define KING_DEBUG_TAG_INFO  "[INFO]"
   
10. #define KING_DEBUG_TAG_FAULT "[FAULT]"
    
11. #define KING_DEBUG_TAG_ERROR "[ERROR]"
    
12. 
    
13. //可選 定義
    
14. //#define KING_DEBUG_SHOW_FILE 0
    
15. //#define KING_DEBUG_SHOW_LINE 0
    
16. //#define KING_DEBUG_SHOW_TAG 1
    
17. //#define KING_DEBUG_COUT_FLUSH 0
    
18. 
    
19. //std::ofstream G_fileLog("log.txt",std::ios::out|std::ios::trunc);
    
20. //#define KING_DEBUG_STREAM G_fileLog
    
21. 
    
22. #define KING_DEBUG_X
    
23. #include <king/debug.hpp>
    
24. 
    
25. 
    
26. int main()
    
27. {
    
28.     KING_DEBUG_X_SECTION(
    
29.         puts("KING_DEBUG_X_SECTION");
    
30.     )
    
31. 
    
32.     KING_DEBUG_SECTION(
    
33.                        puts("KING_DEBUG_SECTION");
    
34. 
    
35.     )
    
36. 
    
37. 
    
38.     KING_TRACE("test "<<KING_DEBUG_TAG_TRACE<<" lv = "<<_KING_DEBUG_LV_TRACE)
    
39.     KING_DEBUG("test "<<KING_DEBUG_TAG_DEBUG<<" lv = "<<_KING_DEBUG_LV_DEBUG)
    
40.     KING_INFO("test "<<KING_DEBUG_TAG_INFO<<" lv = "<<_KING_DEBUG_LV_INFO)
    
41.     KING_FAULT("test "<<KING_DEBUG_TAG_FAULT<<" lv = "<<_KING_DEBUG_LV_FAULT)
    
42.     KING_ERROR("test "<<KING_DEBUG_TAG_ERROR<<" lv = "<<_KING_DEBUG_LV_ERROR)
    
43. 
    
44. 
    
45.     KING_FORMAT_TRACE("test format %s lv = %d",KING_DEBUG_TAG_TRACE,_KING_DEBUG_LV_TRACE);
    
46.     KING_FORMAT_DEBUG("test format %s lv = %d",KING_DEBUG_TAG_DEBUG,_KING_DEBUG_LV_DEBUG);
    
47.     KING_FORMAT_INFO("test format %s lv = %d",KING_DEBUG_TAG_INFO,_KING_DEBUG_LV_INFO);
    
48.     KING_FORMAT_FAULT("test format %s lv = %d",KING_DEBUG_TAG_FAULT,_KING_DEBUG_LV_FAULT);
    
49.     KING_FORMAT_ERROR("test format %s lv = %d",KING_DEBUG_TAG_ERROR,_KING_DEBUG_LV_ERROR);
    
50. 
    
51.     return 0;
    
52. }

复制代码

KING_XXX 使用 c++ std::cout 的 << 風格 輸出 日誌到相應 等級 日誌
KING_FORMAT_XXX 使用 c printf 風格 寫入日誌

1. #include <king/debug.hpp>

复制代码

是需要包含的 實現文件 在此之前 定義指定的 宏 可以 改變 宏行為

日誌等級存在如下 幾種

1. KING_DEBUG_TRACE
   
2. KING_DEBUG_DEBUG
   
3. KING_DEBUG_INFO
   
4. KING_DEBUG_FAULT
   
5. KING_DEBUG_ERROR

复制代码

在 include debug.hpp 之前 必須先定義 相應等級 否則 所有 相應宏 都被替換為空 （如 #define KING_DEBUG_ERROR）
如果定義了 KING_DEBUG_USE_RELEASE KING_DEBUG_FAULT KING_DEBUG_ERROR 將被自動啟用
如果定義了 KING_DEBUG_USE_DEBUG 所有日誌等級 都被啟用

KING_XXX_SECTION 定義 一段 代碼 只有在 相應 日誌等級下 才被啟用
其實 就是
#ifdef KING_DEBUG_XXX
        XXX
#endif
的簡寫罷了

KING_DEBUG_X_SECTION 是和日誌等級 無關 而在 定義了 KING_DEBUG_X 時 被 啟用 的 代碼

KING_DEBUG_STREAM 是一個 默認定義 為 std::cout 的 輸出流 可以將它 替換為其它任何 重載了 << 操作符的 示例 如 示例中 註釋掉的 G_fileLog 可將 日誌 輸出 到文件



所有 輸出 默認時 不保證 線程 安全的 然存在如下兩個宏

1. KING_DEBUG_LOCK
   
2. KING_DEBUG_UNLOCK

复制代码

在 include 定義 這兩個宏 實現 你自己的 同步操作 KING_DEBUG_LOCK 在日誌輸出前被調用 KING_DEBUG_UNLOCK在日誌輸出後被調用

https://github.com/zuiwuchang/ki ... lude/king/Debug.hpp