CocoaLumberjack

CocoaLumberjack是適用于Mac和iOS的快速簡(jiǎn)單但功能強(qiáng)大且靈活的日志框架。
本文主要介紹基于CocoaLumberjack搭建iOS項(xiàng)目Log日志系統(tǒng)。

CocoaLumberjack開源地址

一、CocoaLumberjack架構(gòu)

CocoaLumberjack架構(gòu)

二、簡(jiǎn)單使用

1、使用CocoaPods安裝CocoaLumberjack

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

2、全局定義DDLog日志級(jí)別，才可以編譯通過

• DDLogLevelOff 關(guān)閉Log
• DDLogLevelError 打印Error級(jí)別Log
• DDLogLevelWarning 打印Error、Warning級(jí)別Log
• DDLogLevelInfo 打印Error、Warn、Info級(jí)別Log
• DDLogLevelDebug 打印Error、Warn、Info、Debug級(jí)別Log
• DDLogLevelVerbose 打印Error、Warn、Info、Debug、Verbose級(jí)別Log

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

3、初始化DDLog配置

• DDASLLogger 輸出出到Console.app
• DDTTYLogger 輸出到Xcode控制臺(tái)
• 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小時(shí)
    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;      // 最大文件數(shù)量為7個(gè)
    [DDLog addLogger:fileLogger];
return YES;
}

4、簡(jiǎn)單使用不同Log等級(jí)

DDLogVerbose(@"Verbose");       // 詳細(xì)日志
DDLogDebug(@"Debug");           // 調(diào)試日志
DDLogInfo(@"Info");             // 信息日志
DDLogWarn(@"Warn");             // 警告日志
DDLogError(@"Error");           // 錯(cuò)誤日志

三、搭建Log日志系統(tǒng)

實(shí)現(xiàn)需求：

1、實(shí)現(xiàn)不同Log日志等級(jí)。
2、實(shí)現(xiàn)定時(shí)任務(wù)上傳Log日志到服務(wù)器。

1、創(chuàng)建MagicLogManager類，管理Log日志系統(tǒng)

通過MagicLogManager來配置日志信息、獲取日志路徑、獲取日志內(nèi)容。
所有Log日志默認(rèn)保存在Library/Caches/Logs/目錄下，文件名為bundleid+空格+日期.log。

注意：自定義顏色需要插件XcodeColors：https://github.com/robbiehanson/XcodeColors

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;          // 獲取日志內(nèi)容
@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小時(shí)
        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，日志語句發(fā)送到蘋果文件系統(tǒng)、日志狀態(tài)發(fā)送到Console.app
    [[DDASLLogger sharedInstance] setLogFormatter:logFormatter];
    [DDLog addLogger:[DDASLLogger sharedInstance]];
    // 3.DDFileLogger，日志語句寫入到文件中（默認(rèn)路徑：Library/Caches/Logs/目錄下，文件名為bundleid+空格+日期.log）
    DDFileLogger *fileLogger = [MagicLogManager shareManager].fileLogger;
    [fileLogger setLogFormatter:logFormatter];
    [DDLog addLogger:fileLogger withLevel:DDLogLevelError];        // 錯(cuò)誤日志，寫到文件中
    // 4.DDTTYLogger，日志語句發(fā)送到Xcode
    [[DDTTYLogger sharedInstance] setLogFormatter:logFormatter];
    [[DDTTYLogger sharedInstance] setColorsEnabled:YES];           // 啟用顏色區(qū)分
    [[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;
}
/**
 獲取日志內(nèi)容
 */
- (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、創(chuàng)建MagicLogFormatter類，自定義Log日志格式

通過MagicLogFormatter自定義日志格式，繼承DDAbstractLogger，遵循DDLogFormatter協(xié)議，重寫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內(nèi)容
    DDLogLevel _level;              // 全局lever等級(jí)
    DDLogFlag _flag;                // log的flag等級(jí)
    NSInteger _context;             // 
    NSString *_file;                // 文件
    NSString *_fileName;            // 文件名稱
    NSString *_function;            // 函數(shù)名
    NSUInteger _line;               // 行號(hào)
    id _tag;                        // 
    DDLogMessageOptions _options;   //
    NSDate *_timestamp;             // 時(shí)間
    NSString *_threadID;            // 線程id 
    NSString *_threadName;          // 線程名稱
    NSString *_queueLabel;          // gcd線程名稱
    */

3、使用

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [[MagicLogManager shareManager] start];
    DDLogVerbose(@"Verbose");    // 詳細(xì)日志
    DDLogDebug(@"Debug");        // 調(diào)試日志
    DDLogInfo(@"Info");          // 信息日志
    DDLogWarn(@"Warn");          // 警告日志
    DDLogError(@"Error");        // 錯(cuò)誤日志
    NSLog(@"日志路徑%@", [[MagicLogManager shareManager] getAllLogFilePath]);
    NSLog(@"日志內(nèi)容%@", [[MagicLogManager shareManager] getAllLogFileContent]);
}