CocoaLumberjack

CocoaLumberjack是適用於Mac和iOS的快速簡單但功能強大且靈活的日誌框架。
本文主要介紹基於CocoaLumberjack搭建iOS專案Log日誌系統。

一、CocoaLumberjack架構

CocoaLumberjack架構

二、簡單使用

1、使用CocoaPods安裝CocoaLumberjack

platform :ios, '7.0'
pod 'CocoaLumberjack'           # Log日誌

2、全域性定義DDLog日誌級別，才可以編譯通過

• DDLogLevelOff 關閉Log
• DDLogLevelError 列印Error級別Log
• DDLogLevelWarning 列印Error、Warning級別Log
• DDLogLevelInfo 列印Error、Warn、Info級別Log
• DDLogLevelDebug 列印Error、Warn、Info、Debug級別Log
• DDLogLevelVerbose 列印Error、Warn、Info、Debug、Verbose級別Log

#ifdef DEBUG
  static const int ddLogLevel = DDLogLevelVerbose;
#else
  static const int ddLogLevel = DDLogLevelWarning;
#endif
 

3、初始化DDLog配置

• DDASLLogger 輸出出到Console.app
• DDTTYLogger 輸出到Xcode控制檯
• DDLogFileManager 輸出到檔案
• DDAbstractDatabaseLogger 輸出到DB

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
    [DDLog addLogger:[DDTTYLogger sharedInstance]];             // TTY = Xcode console
    [DDLog addLogger:[DDASLLogger sharedInstance]];             // ASL = Apple System Logs
    DDFileLogger *fileLogger = [[DDFileLogger alloc] init];     // File Logger
    fileLogger.rollingFrequency = 60 * 60 * 24;                 // 重新整理頻率為24小時
    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;      // 最大檔案數量為7個
    [DDLog addLogger:fileLogger];
return YES;
}
 

4、簡單使用不同Log等級

DDLogVerbose(@"Verbose");       // 詳細日誌
DDLogDebug(@"Debug");           // 除錯日誌
DDLogInfo(@"Info");             // 資訊日誌
DDLogWarn(@"Warn");             // 警告日誌
DDLogError(@"Error");           // 錯誤日誌

三、搭建Log日誌系統

實現需求：

1、實現不同Log日誌等級。
2、實現定時任務上傳Log日誌到伺服器。

1、建立MagicLogManager類，管理Log日誌系統

通過MagicLogManager來配置日誌資訊、獲取日誌路徑、獲取日誌內容。
所有Log日誌預設儲存在Library/Caches/Logs/目錄下，檔名為bundleid+空格+日期.log。

MagicLogManager.h檔案

#import <Foundation/Foundation.h>
#import <CocoaLumberjack/CocoaLumberjack.h>
//開源依賴
#if DEBUG
static const DDLogLevel ddLogLevel = DDLogLevelVerbose;
#else
static const DDLogLevel ddLogLevel = DDLogLevelWarning;
#endif

@interface MagicLogManager : NSObject
@property(nonatomic, strong)DDFileLogger *fileLogger;
+ (MagicLogManager *)shareManager;
- (void)start;                              // 配置日誌資訊
- (NSArray *)getAllLogFilePath;             // 獲取日誌路徑
- (NSArray *)getAllLogFileContent;          // 獲取日誌內容
@end

MagicLogManager.m檔案

#import "MagicLogManager.h"
#import "MagicLogFormatter.h"

@implementation MagicLogManager
+ (MagicLogManager *)shareManager{    
    static MagicLogManager *manager = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        manager = [[MagicLogManager alloc] init];
        manager.fileLogger = [[DDFileLogger alloc] init];
        manager.fileLogger.rollingFrequency = 60 * 60 * 24;                 // 重新整理頻率為24小時
        manager.fileLogger.logFileManager.maximumNumberOfLogFiles = 7;      // 儲存一週的日誌，即7天
        manager.fileLogger.maximumFileSize = 1024 * 1024 * 2;               // 最大檔案大小

    });
    return manager;
}
/**
 配置日誌資訊
 */
- (void)start{
    // 1.自定義Log格式
    MagicLogFormatter *logFormatter = [[MagicLogFormatter alloc] init];
    // 2.DDASLLogger，日誌語句傳送到蘋果檔案系統、日誌狀態傳送到Console.app
    [[DDASLLogger sharedInstance] setLogFormatter:logFormatter];
    [DDLog addLogger:[DDASLLogger sharedInstance]];
    // 3.DDFileLogger，日誌語句寫入到檔案中（預設路徑：Library/Caches/Logs/目錄下，檔名為bundleid+空格+日期.log）
    DDFileLogger *fileLogger = [MagicLogManager shareManager].fileLogger;
    [fileLogger setLogFormatter:logFormatter];
    [DDLog addLogger:fileLogger withLevel:DDLogLevelError];        // 錯誤日誌，寫到檔案中
    // 4.DDTTYLogger，日誌語句傳送到Xcode
    [[DDTTYLogger sharedInstance] setLogFormatter:logFormatter];
    [[DDTTYLogger sharedInstance] setColorsEnabled:YES];           // 啟用顏色區分
    [[DDTTYLogger sharedInstance] setForegroundColor:DDMakeColor(255, 0, 0) backgroundColor:nil forFlag:DDLogFlagError];
    [[DDTTYLogger sharedInstance] setForegroundColor:DDMakeColor(105, 200, 80) backgroundColor:nil forFlag:DDLogFlagInfo];
    [[DDTTYLogger sharedInstance] setForegroundColor:DDMakeColor(100, 100, 200) backgroundColor:nil forFlag:DDLogFlagDebug];
    [DDLog addLogger:[DDTTYLogger sharedInstance]];
}
/**
 獲取日誌路徑(檔名bundleid+空格+日期)
 */
- (NSArray *)getAllLogFilePath{
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
    NSString *cachesPath = [paths objectAtIndex:0];
    NSString *logPath = [cachesPath stringByAppendingPathComponent:@"Logs"];
    NSFileManager *fileManger = [NSFileManager defaultManager];
    NSError *error = nil;
    NSArray *fileArray = [fileManger contentsOfDirectoryAtPath:logPath error:&error];
    NSMutableArray *result = [NSMutableArray array];
    [fileArray enumerateObjectsUsingBlock:^(NSString *filePath, NSUInteger idx, BOOL * _Nonnull stop) {
        if([filePath hasPrefix:[NSBundle mainBundle].bundleIdentifier]){
            NSString *logFilePath = [logPath stringByAppendingPathComponent:filePath];
            [result addObject:logFilePath];
        }
    }];
    return result;
}
/**
 獲取日誌內容
 */
- (NSArray *)getAllLogFileContent{
    NSMutableArray *result = [NSMutableArray array];
    NSArray *logfilePaths = [self getAllLogFilePath];
    [logfilePaths enumerateObjectsUsingBlock:^(NSString *filePath, NSUInteger idx, BOOL * _Nonnull stop) {
        NSData *data = [NSData dataWithContentsOfFile:filePath];
        NSString *content = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        [result addObject:content];
    }];
    return result;
}

2、建立MagicLogFormatter類，自定義Log日誌格式

通過MagicLogFormatter自定義日誌格式，繼承DDAbstractLogger，遵循DDLogFormatter協議，重寫formatLogMessage方法，返回最終Log訊息字串。

MagicLogFormatter.h檔案

#import <Foundation/Foundation.h>
#import "DDLog.h"
@interface MagicLogFormatter : DDAbstractLogger<DDLogFormatter>
@end

MagicLogFormatter.m檔案

#import "MagicLogFormatter.h"
@implementation MagicLogFormatter
- (NSString *)formatLogMessage:(DDLogMessage *)logMessage{
    NSString *loglevel = nil;
    switch (logMessage.flag){
        case LOG_FLAG_ERROR:
            loglevel = @"[ERROR]--->";
            break;
        case LOG_FLAG_WARN:
            loglevel = @"[WARN]--->";
            break;
        case LOG_FLAG_INFO:
            loglevel = @"[INFO]--->";
            break;
        case LOG_FLAG_DEBUG:
            loglevel = @"[DEBUG]--->";
            break;
        case LOG_FLAG_VERBOSE:
            loglevel = @"[VBOSE]--->";
            break;
        default:
            break;
    }
    NSString *resultString = [NSString stringWithFormat:@"%@ %@___line[%ld]__%@", loglevel, logMessage->_function, logMessage->_line, logMessage->_message];
    return resultString;
}
@end
  /*
    DDLogMessage中返回資訊
    
    NSString *_message;             // 具體logger內容
    DDLogLevel _level;              // 全域性lever等級
    DDLogFlag _flag;                // log的flag等級
    NSInteger _context;             // 
    NSString *_file;                // 檔案
    NSString *_fileName;            // 檔名稱
    NSString *_function;            // 函式名
    NSUInteger _line;               // 行號
    id _tag;                        // 
    DDLogMessageOptions _options;   //
    NSDate *_timestamp;             // 時間
    NSString *_threadID;            // 執行緒id 
    NSString *_threadName;          // 執行緒名稱
    NSString *_queueLabel;          // gcd執行緒名稱
    */

3、使用

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [[MagicLogManager shareManager] start];
    DDLogVerbose(@"Verbose");    // 詳細日誌
    DDLogDebug(@"Debug");        // 除錯日誌
    DDLogInfo(@"Info");          // 資訊日誌
    DDLogWarn(@"Warn");          // 警告日誌
    DDLogError(@"Error");        // 錯誤日誌
    NSLog(@"日誌路徑%@", [[MagicLogManager shareManager] getAllLogFilePath]);
    NSLog(@"日誌內容%@", [[MagicLogManager shareManager] getAllLogFileContent]);
}