一直以來我都希望能有一套自己的日誌系統,把程式運行過程中產生的 log 統一傳送回自建伺服器,方便後續做資料分析與除錯。先前我也找過一些第三方服務,但仔細評估下來,國內似乎還沒有專門耕耘這塊的團隊;國外倒是找到 Loggly,功能看似符合需求,然而它不僅要收費,日誌的保存週期也短得令人卻步。後來偶然翻到 Loggly 提供的 SDK 原始碼,才發現了 CocoaLumberjack 這個好東西——說白了,Loggly 也不過是在 CocoaLumberjack 之上自訂了 Logger 與 Formatter 而已。既然如此,自己動手做一套其實並不難。
先談談我的需求。理想中的日誌系統需要具備以下幾點:
可以設定日誌等級
能累積到一定數量後再一次性回傳伺服器,絕對不能每打一條 log 就發一次請求
能在經過一段時間後,把尚未送出的日誌傳回伺服器
能在 App 切換到背景時,將未送出的日誌傳回伺服器
至於遠端動態調整日誌等級門檻、門檻的有效期限等需求,與本文主題無關,這裡就不再贅述。
動手之前,先認識一下 CocoaLumberjack 究竟是什麼。它由 Robbie Hanson 最早開發,是一套可用於 iOS 與 MacOSX 開發的日誌庫,簡單、快速、強大又不失靈活。它內建了三種日誌輸出方式:
DDASLLogger:把日誌交給蘋果系統,之後可在 Console.app 中檢視
DDTTYLogger:把日誌輸出到 Xcode 的控制台
DDFileLogger:把日誌寫入本地檔案
CocoaLumberjack 打出一條日誌的流程大致如下:

所有日誌都會先送進 DDLog 物件,它運行在一條獨立的 GCD 佇列(GlobalLoggingQueue)上;接著 DDLog 會把日誌分發給其下註冊的一或多個 Logger,這一步在多核環境下是並發的,效率極高。每個 Logger 處理收到的日誌,同樣是在各自的 GCD 佇列(loggingQueue)中進行:它們向所屬的 Formatter 詢問日誌的格式化方式,最後依照 Logger 自身的邏輯,把訊息分發到不同的目的地。
由於一個 DDLog 能把日誌同時分發給所有註冊的 Logger,也就意味著同一條日誌可以同時打到控制台、傳到遠端伺服器、寫入本地檔案,相當靈活。
CocoaLumberjack 支援以下日誌等級:
typedef NS_OPTIONS(NSUInteger, DDLogFlag) { DDLogFlagError = (1 << 0), // 0...00001 DDLogFlagWarning = (1 << 1), // 0...00010 DDLogFlagInfo = (1 << 2), // 0...00100 DDLogFlagDebug = (1 << 3), // 0...01000 DDLogFlagVerbose = (1 << 4) // 0...10000 }; typedef NS_ENUM(NSUInteger, DDLogLevel) { DDLogLevelOff = 0, DDLogLevelError = (DDLogFlagError), // 0...00001 DDLogLevelWarning = (DDLogLevelError | DDLogFlagWarning), // 0...00011 DDLogLevelInfo = (DDLogLevelWarning | DDLogFlagInfo), // 0...00111 DDLogLevelDebug = (DDLogLevelInfo | DDLogFlagDebug), // 0...01111 DDLogLevelVerbose = (DDLogLevelDebug | DDLogFlagVerbose), // 0...11111 DDLogLevelAll = NSUIntegerMax // 1111....11111 (DDLogLevelVerbose plus any other flags) };其中 DDLogLevel 定義了全域的日誌等級,而 DDLogFlag 則是我們打日誌時設定的等級。CocoaLumberjack 會比對兩者,若 flag 低於 level,就不輸出該條日誌:
#define LOG_MAYBE(async, lvl, flg, ctx, tag, fnct, frmt, ...) \ do { if(lvl & flg) LOG_MACRO(async, lvl, flg, ctx, tag, fnct, frmt, ##__VA_ARGS__); } while(0)DDLogger 協議規定了 logger 物件必須實作的方法與變數。為方便使用,框架提供了 DDAbstractLogger 物件,我們只要繼承它,就能自訂自己的 logger。而針對第二、第三點需求,可以善用 DDAbstractDatabaseLogger——它同樣繼承自 DDAbstractLogger,並在其之上定義了 saveThreshold、saveInterval 等控制參數。這個 logger 原本是為寫入資料庫而設計的,但我們完全可以借用這幾個參數,來滿足前面提到的第二、第三點需求。
對於第二點,設定 _saveThreshold 即可,例如想累積 1000 條日誌再一次送出,就賦值 1000。
對於第三點,設定 _saveInterval 即可,例如希望每分鐘送一次,就設定為 60。
這樣一來,CocoaLumberjack 已經幫我們實現了需求中的第 1、2、3 點,我們要做的,無非是自訂 Logger 與 Formatter,把日誌的最終去處改為傳送到自建伺服器。至於第四點,我們可以監聽 UIApplicationWillResignActiveNotification 事件,一旦觸發,就手動呼叫 logger 的 db_save 方法,把資料傳回伺服器。
鋪墊了這麼多,現在來看具體實現。
首先設定日誌的訊息結構。自訂一個 LogFormatter 並遵循 DDLogFormatter 協議,我們需要重寫 formatLogMessage 這個方法。它的回傳值是 NSString,也就是最終的日誌訊息字串;而傳入參數 logMessage 則是 logger 送出的 DDLogMessage 物件,裡面包含了一些必要資訊:
@interface DDLogMessage : NSObject { // Direct accessors to be used only for performance @public NSString *_message; DDLogLevel _level; DDLogFlag _flag; NSUInteger _context; NSString *_file; NSString *_fileName; NSString *_function; NSUInteger _line; id _tag; DDLogMessageOptions _options; NSDate *_timestamp; NSString *_threadID; NSString *_threadName; NSString *_queueLabel; }我們可以運用這些資訊來組裝自己的日誌訊息體。舉例來說,這裡只需要檔案名、行數與函式名,就可以這樣寫:
- (NSString *)formatLogMessage:(DDLogMessage *)logMessage{ NSMutableDictionary *logDict = [NSMutableDictionary dictionary]; //取得文件名 NSString *locationString; NSArray *parts = [logMessage->_file componentsSeparatedByString:@"/"]; if ([parts count] > 0) locationString = [parts lastObject]; if ([locationString length] == 0) locationString = @"No file"; //這裡的格式: {"location":"myfile.m:120(void a::sub(int)"}, 文件名,行數和函數名是用的編譯器宏 __FILE__, __LINE__, __PRETTY_FUNCTION__ logDict[@"location"] = [NSString stringWithFormat:@"%@:%lu(%@)", locationString, (unsigned long)logMessage->_line, logMessage->_function] //嘗試將logDict內容轉為字符串,其實這裡可以直接構造字符串,但真實項目中,肯定需要很多其他的信息,不可能僅僅文件名、行數和函數名就夠了的。 NSError *error; NSData *outputJson = [NSJSONSerialization dataWithJSONObject:logfields options:0 error:&error]; if (error) return @"{\"location\":\"error\"}" NSString *jsonString = [[NSString alloc] initWithData:outputJson encoding:NSUTF8StringEncoding]; if (jsonString) return jsonString; return @"{\"location\":\"error\"}" }接著自訂 logger,讓它繼承自 DDAbstractDatabaseLogger。在初始化方法中,先設定好各項參數,並註冊一個 UIApplicationWillResignActiveNotification 的觀察者,以實現第四個需求。
- (instancetype)init { self = [super init]; if (self) { self.deleteInterval = 0; self.maxAge = 0; self.deleteOnEverySave = NO; self.saveInterval = 60; self.saveThreshold = 500; //別忘了在 dealloc 裡 removeObserver [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(saveOnSuspend) name:@"UIApplicationWillResignActiveNotification" object:nil]; } return self; } - (void)saveOnSuspend { dispatch_async(_loggerQueue, ^{ [self db_save]; }); }每次打日誌時,db_log: 都會被呼叫。我們在這個方法裡把日誌交給 formatter,將回傳的日誌訊息字串存進緩衝區;而 db_log 的回傳值,則用來告訴 DDLog 這條日誌是否成功存入了緩存。
- (BOOL)db_log:(DDLogMessage *)logMessage { if (!_logFormatter) { //沒有指定 formatter return NO; } if (!_logMessagesArray) _logMessagesArray = [NSMutableArray arrayWithCapacity:500]; // 我們的saveThreshold只有500,所以一般情況下夠了 if ([_logMessagesArray count] > 2000) { // 如果段時間內進入大量log,並且遲遲發不到服務器上,我們可以判斷哪裡出了問題,在這之後的 log 暫時不處理了。 // 但我們依然要告訴 DDLog 這個存進去了。 return YES; } //利用 formatter 得到消息字符串,添加到緩存 [_logMessagesArray addObject:[_logFormatter formatLogMessage:logMessage]]; return YES; }當累積滿 1 分鐘,或未寫入的日誌數達到 500 條時,db_save 就會被呼叫。我們在這裡把緩衝區中的資料上傳到自己的伺服器。
- (void)db_save{ //判斷是否在 logger 自己的GCD隊列中 if ![self isOnInternalLoggerQueue] NSAssert(NO, @"db_saveAndDelete should only be executed on the internalLoggerQueue thread, if you're seeing this, your doing it wrong."); //如果緩存內沒數據,啥也不做 if ([_logMessagesArray count] == 0) return; 獲取緩存中所有數據,之後將緩存清空 NSArray *oldLogMessagesArray = [_logMessagesArray copy]; _logMessagesArray = [NSMutableArray arrayWithCapacity:0]; //用換行符,把所有的數據拼成一個大字符串 NSString *logMessagesString = [oldLogMessagesArray componentsJoinedByString:@"\n"]; //發送給咱自己服務器(自己實現了) [self post:logMessagesString]; }最後,我們需要在程式的某處定義全域日誌等級(這裡採用 Info),並在 AppDelegate 的 didFinishLaunchingWithOptions 中完成所有日誌相關物件的初始化:
static NSUInteger LOG_LEVEL_DEF = DDLogLevelInfo; - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { MyLogger *logger = [MyLogger new]; [logger setLogFormatter:[MyLogFormatter new]]; [DDLog addLogger:logger]; //.... }之後,就能用 DDLogError、DDLogWarning 等巨集在程式中打日誌了,用法與 NSLog 完全相同。這幾個巨集的定義如下:
//注意,DDLogError 是肯定同步的 #define DDLogError(frmt, ...) LOG_MAYBE(NO, LOG_LEVEL_DEF, DDLogFlagError, 0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__) #define DDLogWarn(frmt, ...) LOG_MAYBE(LOG_ASYNC_ENABLED, LOG_LEVEL_DEF, DDLogFlagWarning, 0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__) #define DDLogInfo(frmt, ...) LOG_MAYBE(LOG_ASYNC_ENABLED, LOG_LEVEL_DEF, DDLogFlagInfo, 0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__) #define DDLogDebug(frmt, ...) LOG_MAYBE(LOG_ASYNC_ENABLED, LOG_LEVEL_DEF, DDLogFlagDebug, 0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__) #define DDLogVerbose(frmt, ...) LOG_MAYBE(LOG_ASYNC_ENABLED, LOG_LEVEL_DEF, DDLogFlagVerbose, 0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__)
最後,感謝 CocoaLumberjack 的作者 Robbie Hanson。如果你也喜歡他開發的庫(比如 XMPPFramework),別忘了幫他買杯啤酒以示支持~