iOS搭建Log日志系统

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。

注意：自定义颜色需要插件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;          // 获取日志内容
@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]);
}

iOS搭建Log日志系统

一、CocoaLumberjack架构

二、简单使用

三、搭建Log日志系统

猜你喜欢