iOS開源專案之日誌框架CocoaLumberjack(未整理版)

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];// 可以修改你想要的顏色