CocoaLumberjack是Mac和iOS上一個集快捷巫橄、簡單茵典、強大和靈活于一身的日志框架。CocoaLumberjack類似于流行的日志框架(如log4j)彩倚,但它是專為Objective-C設(shè)計的扶平,利用了多線程、GCD(如果可用)哥谷、無鎖原子操作Objective-C運行時的動態(tài)特性。
快速 在大多數(shù)用例中们妥,Lumberjack比NSLog快了一個數(shù)量級。
簡單 當應(yīng)用程序啟動時旅赢,只需一行加單的代碼就可配置Lumberjack惑惶。然后用DDLog語句簡單地取代NSLog語句。 并且DDLog宏與NSLog的有完全相同的格式和語法僵控,所以超級簡單刮刑。
強大 一個日志語句可以被發(fā)送到多個logger,意味著你可以同時記錄文件和控制臺泛烙。此外翘紊,還可以創(chuàng)建自己的logger,將日志語句發(fā)送到網(wǎng)絡(luò)鹉究、數(shù)據(jù)庫或者分布式文件系統(tǒng)中踪宠。沒有任何限制。
靈活性 配置你自己想要的日志框架绍妨。修改每個文件的日志級別(尤其是測試時)柬脸。修改每個logger的日志級 別(詳細的控制臺,但是簡潔的日志文件)灾测。修改每個Xcode配置的日志級別垦巴。為你的應(yīng)用程序定制日志級別的數(shù)量铭段。添加自己的精細的日志稠项。在運行時動態(tài)修改日志級別鲜结。 選擇如何以及何時回滾你的日志文件。將日志文件上傳至中心服務(wù)器拗胜。壓縮存檔日志文件來節(jié)省硬盤空間怒允。
當你遇到一下情況是,你可以選擇Lumberjack框架: 1.你想找到一種方式來跟蹤在程序中不斷出現(xiàn)的不可復(fù)制的bug勘畔; 2.你對iPhone上的簡短日志感到很失望丽惶; 3.出于支持系統(tǒng)和穩(wěn)定性的需要,你想將應(yīng)用程序升級到下一級別万哪; 4.為你的應(yīng)用程序(Mac或者iPhone)尋找企業(yè)級的日志解決方案抡秆。
如何開始使用Lumberjack框架
開始 三步開始使用CocoaLumberjack框架: 1.將Lumberjack文件添加到你的項目中; 2.配置框架的止; 3.將NSLog指令轉(zhuǎn)換為使用Lumberjack宏指令着撩;
把Lumberjack框架添加到你的項目 需要添加的主要文件有四個: 1.@DDLog(整個框架的基礎(chǔ)) 2.@DDASLLogger(發(fā)送日志語句到蘋果的日志系統(tǒng),以便它們顯示在Console.app上) 3.@DDTTYLoyger(發(fā)送日志語句到Xcode控制臺权谁,如果可用) 4.@DDFIleLoger(把日志語句發(fā)送至文件)
DDLog是強制性的憋沿,其余的都是可選的沪猴,這取決于你打算如何使用這個框架采章。例如悯舟,如果你不打算紀錄到一個文件砸民,你可以跳過DDFileLogger,或者你想跳過ASL以便更快的文件記錄反惕,你可以跳過DDASLLoger演侯。
配置框架 首先,你想要在你的應(yīng)用程序中配置這個日志框架悬赏,通常在applicationDidFinishLaunching方法中配置娄徊。
開始時,你需要下面兩行代碼: [DDLog addLogger:[DDASLLogger sharedInstance]]; [DDLog addLogger:[DDTTYLogger sharedInstance]]; 這將在你的日志框架中添加兩個“l(fā)ogger”寄锐。也就是說你的日志語句將被發(fā)送到Console.app和Xcode控制 臺(就像標準的NSLog)
這個框架的好處之一就是它的靈活性,如果你還想要你的日志語句寫入到一個文件中中鼠,你可以添加和配置一個file logger: fileLogger = [[DDFileLogger alloc] init]; fileLogger.rollingFrequency = 60 60 24; // 24 hour rolling fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
[DDLog addLogger:fileLogger];
上面的代碼告訴應(yīng)用程序要在系統(tǒng)上保持一周的日志文件援雇。
用DDLog替換NSLog語句 DDLog的頭文件定義了你用來替換NSLog語句的宏,本質(zhì)上看起來向下邊這樣: // Convert from this: 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
(注意:你也可以自定義級別以及級別名或者添加更精細的控制來代替系統(tǒng)四個簡單的等級茴丰。)
當然選擇哪個NSLog語句取決于你的消息的嚴重程度。
下面的這些不同的日志等級也許正有你所需要的: 1.如果你將日志級別設(shè)置為 LOG_LEVEL_ERROR峦椰,那么你只會看到DDlogError語句汰规。 2.如果你將日志級別設(shè)置為LOG_LEVEL_WARN,那么你只會看到DDLogError和DDLogWarn語句滔金。 3.如果您將日志級別設(shè)置為 LOG_LEVEL_INFO,那么你會看到error茂嗓、Warn和Info語句。 4.如果您將日志級別設(shè)置為LOG_LEVEL_VERBOSE,那么你會看到所有DDLog語句在抛。 5.如果您將日志級別設(shè)置為 LOG_LEVEL_OFF,你將不會看到任何DDLog語句。
那么我在哪里設(shè)置日志級別呢肠阱,在整個項目中我只能使用一個日志級別嗎?
當然不是朴读,我們都知道正如調(diào)試或者添加新特性,如果你想詳細紀錄目前正在做的那部分衅金,Lumberjack框 架提供了對每個文件的調(diào)試控制氮唯,你僅可以修改編輯中的文件的日志級別。
(注釋:當然還有許多其他高級選項,比如全球日志級別,Xcode的每個配置級別,每個logger級別等豆励,我們將在另一篇文章中講到)瞒渠。
以下是如何轉(zhuǎn)換你的日志語句: // CONVERT FROM THIS
import "Sprocket.h"
@implementation Sprocket
(void)someMethod { NSLog(@"Meet George Jetson"); }
@end
// TO THIS
import "Sprocket.h"
import "DDLog.h"
static const int ddLogLevel = LOG_LEVEL_VERBOSE;
@implementation Sprocket
(void)someMethod { DDLogVerbose(@"Meet George Jetson"); }
@end
注意日志級別聲明為常量,這意味著這意味著日志級別閾值以上的DDLog語句都將編譯到你的項目中伍玖。
自動引用計數(shù)(ARC) 最新版本的Lumberjack使用ARC。如果你的項目沒有使用ARC串纺,你可以在ARC頁面學(xué)習如何在Xcode中像ARC一樣正確地標記Lumberjack文件。