CocoaLumberjack是Mac和iOS上一個集快捷、簡單、強大和靈活于一身的日志框架。CocoaLumberjack類似于流行 的日志框架(如log4j),但它是專為Objective-C設計的,利用了多線程、GCD(如果可用)、無鎖原子操作Objective-C運行時的 動態特性。
快速?在大多數用例中,Lumberjack比NSLog快了一個數量級。
簡單?當應用程序啟動時,只需一行加單的代碼就可配置Lumberjack。然后用DDLog語句簡單地取代NSLog語句。 并且DDLog宏與NSLog的有完全相同的格式和語法,所以超級簡單。
強大?一個日志語句可以被發送到多個logger,意味著你可以同時記錄文件和控制臺。此外,還可以創建自己的logger,將日志語句發送到網絡、數據庫或者分布式文件系統中。沒有任何限制。
靈活性?配置你自己想要的日志框架。修改每個文件的日志級別(尤其是測試時)。修改每個logger的日志級 別(詳細的控制臺,但是簡潔的日志文件)。修改每個Xcode配置的日志級別。為你的應用程序定制日志級別的數量。添加自己的精細的日志。在運行時動態修 改日志級別。 選擇如何以及何時回滾你的日志文件。將日志文件上傳至中心服務器。壓縮存檔日志文件來節省硬盤空間。
當你遇到一下情況是,你可以選擇Lumberjack框架:
1.你想找到一種方式來跟蹤在程序中不斷出現的不可復制的bug;
2.你對iPhone上的簡短日志感到很失望;
3.出于支持系統和穩定性的需要,你想將應用程序升級到下一級別;
4.為你的應用程序(Mac或者iPhone)尋找企業級的日志解決方案。
如何開始使用Lumberjack框架
1.將Lumberjack文件添加到你的項目中;
2.配置框架;
3.將NSLog指令轉換為使用Lumberjack宏指令;
把Lumberjack框架添加到你的項目
需要添加的主要文件有四個:
1.@DDLog(整個框架的基礎)
2.@DDASLLogger(發送日志語句到蘋果的日志系統,以便它們顯示在Console.app上)
3.@DDTTYLoyger(發送日志語句到Xcode控制臺,如果可用)
4.@DDFIleLoger(把日志語句發送至文件)
DDLog是強制性的,其余的都是可選的,這取決于你打算如何使用這個框架。例如,如果你不打算紀錄到一個文件,你可以跳過DDFileLogger,或者你想跳過ASL以便更快的文件記錄,你可以跳過DDASLLoger
配置框架
首先,你想要在你的應用程序中配置這個日志框架,通常在applicationDidFinishLaunching方法中配置。
? fileLogger = [[DDFileLogger alloc] init];
?fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling
?fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
?[DDLog addLogger:fileLogger];
上面的代碼告訴應用程序要在系統上保持一周的日志文件。
用DDLog替換NSLog語句
DDLog的頭文件定義了你用來替換NSLog語句的宏,本質上看起來向下邊這樣:
NSLog(@"Broken sprocket detected!");
NSLog(@"User selected file:%@ withSize:%u", filePath, fileSize);
// To this:
DDLogError(@"Broken sprocket detected!");
DDLogVerbose(@"User selected file:%@ withSize:%u", filePath, fileSize);
我們看到DDLog宏和NSLog的語法完全相同。
所以你所要做的就是決定每個NSlog語句屬于哪種日志級別。DDLog默認有四種級別的日志,分別是:
1.@DDlogError
2.@DDlogWarn
3.@DDlogInfo
4.@DDlogVerbose
當然選擇哪個NSLog語句取決于你的消息的嚴重程度。
下面的這些不同的日志等級也許正有你所需要的:
1.如果你將日志級別設置為 LOG_LEVEL_ERROR,那么你只會看到DDlogError語句。
2.如果你將日志級別設置為LOG_LEVEL_WARN,那么你只會看到DDLogError和DDLogWarn語句。
3.如果您將日志級別設置為 LOG_LEVEL_INFO,那么你會看到error、Warn和Info語句。
4.如果您將日志級別設置為LOG_LEVEL_VERBOSE,那么你會看到所有DDLog語句。
5.如果您將日志級別設置為 LOG_LEVEL_OFF,你將不會看到任何DDLog語句。
那么我在哪里設置日志級別呢,在整個項目中我只能使用一個日志級別嗎?
當然不是,我們都知道正如調試或者添加新特性,如果你想詳細紀錄目前正在做的那部分,Lumberjack框 架提供了對每個文件的調試控制,你僅可以修改編輯中的文件的日志級別。
(注釋:當然還有許多其他高級選項,比如全球日志級別,Xcode的每個配置級別,每個logger級別等,我們將在另一篇文章中講到)。
6.使用DDLog.
直接貼代碼:
static const int ddLogLevel = LOG_LEVEL_VERBOSE;// 定義日志級別
[DDLog addLogger:[DDTTYLogger sharedInstance]];// 初始化DDLog日志輸出,在這里,我們僅僅希望在xCode控制臺輸出
[[DDTTYLogger sharedInstance] setColorsEnabled:YES];// 啟用顏色區分
DDLogError(@"錯誤信息"); // 紅色
DDLogWarn(@"警告"); // 橙色
DDLogInfo(@"提示信息"); // 默認是黑色
DDLogVerbose(@"詳細信息"); // 默認是黑色
以上是最簡單的應用,當然,可以自定義每種日志的顏色,看需求吧。
[DDLog addLogger:[DDASLLogger sharedInstance]];// 如果需要,可以添加其他的日志輸出支持
[[DDTTYLogger sharedInstance] setForegroundColor:[UIColor blueColor] backgroundColor:nil forFlag:LOG_FLAG_INFO];// 可以修改你想要的顏色