iOS開發：日誌架構CocoaLumberjack

iOS開發：日誌架構CocoaLumberjack

 　　CocoaLumberjack是Mac和iOS上一個集快捷、簡單、強大和靈活於一身的日誌架構。CocoaLumberjack類似於流行 的日誌架構(如log4j)，但它是專為Objective-C設計的，利用了多線程、GCD(如果可用)、無鎖原子操作Objective-C運行時的 動態特性。

　　快速

　　在大多數用例中，Lumberjack比NSLog快了一個數量級。

　　簡單

　　當應用程式啟動時，只需一行加單的代碼就可配置Lumberjack。然後用DDLog語句簡單地取代NSLog語句。 並且DDLog宏與NSLog的有完全相同的格式和文法，所以超級簡單。

　　強大

　　一個日誌語句可以被發送到多個logger，意味著你可以同時記錄檔案和控制台。此外，還可以建立自己的logger，將日誌語句發送到網路、資料庫或者Distributed File System中。沒有任何限制。

　　靈活性

　　配置你自己想要的日誌架構。修改每個檔案的記錄層級(尤其是測試時)。修改每個logger的日誌級 別(詳細的控制台，但是簡潔的記錄檔)。修改每個Xcode配置的記錄層級。為你的應用程式定製記錄層級的數量。添加自己的精細的日誌。在運行時動態修 改記錄層級。 選擇如何以及何時復原你的記錄檔。將記錄檔上傳至中心伺服器。壓縮存檔記錄檔來節省硬碟空間。

　　當你遇到一下情況是，你可以選擇Lumberjack架構：

　　1.你想找到一種方式來跟蹤在程式中不斷出現的不可複製的bug;

　　2.你對iPhone上的簡短日誌感到很失望;

　　3.出於支援系統和穩定性的需要，你想將應用程式升級到下一層級;

　　4.為你的應用程式(Mac或者iPhone)尋找企業級的日誌解決方案。

　　如何開始使用Lumberjack架構

　　開始

　　三步開始使用CocoaLumberjack架構：

　　1.將Lumberjack檔案添加到你的項目中;

　　2.組態架構;

　　3.將NSLog指令轉換為使用Lumberjack巨集指令;

　　把Lumberjack架構添加到你的項目

　　需要添加的主要檔案有四個：

　　1.@DDLog(整個架構的基礎)

　　2.@DDASLLogger(發送日誌語句到蘋果的日誌系統，以便它們顯示在Console.app上)

　　3.@DDTTYLoyger(發送日誌語句到Xcode控制台，如果可用)

　　4.@DDFIleLoger(把日誌語句發送至檔案)

　　DDLog是強制性的，其餘的都是可選的，這取決於你打算如何使用這個架構。例如，如果你不打算紀錄到一個檔案，你可以跳過DDFileLogger，或者你想跳過ASL以便更快的檔案記錄，你可以跳過DDASLLoger。

　　組態架構

　　首先，你想要在你的應用程式中配置這個日誌架構，通常在applicationDidFinishLaunching方法中配置。

　　開始時，你需要下面兩行代碼：

　　[DDLog addLogger:[DDASLLogger sharedInstance]];

　　[DDLog addLogger:[DDTTYLogger sharedInstance]];

　　這將在你的日誌架構中添加兩個“logger”。也就是說你的日誌語句將被發送到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];

　　上面的代碼告訴應用程式要在系統上保持一周的記錄檔。

　　用DDLog替換NSLog語句

　　DDLog的標頭檔定義了你用來替換NSLog語句的宏，本質上看起來向下邊這樣：

　　// 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

　　(注意：你也可以自訂層級以及層級名或者添加更精細的控制來代替系統四個簡單的等級。)

　　當然選擇哪個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層級等，我們將在另一篇文章中講到)。

　　以下是如何轉換你的日誌語句：

　　// 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語句都將編譯到你的項目中。

　　自動引用計數(ARC)

　　最新版本的Lumberjack使用ARC。如果你的項目沒有使用ARC，你可以在ARC頁面學習如何在Xcode中像ARC一樣正確地標記Lumberjack檔案。