iOS利用NSLogger和CocoaLumberjack打造日志系统(异常捕捉)

前言

最近刚接手一个新项目,被分派到一个日志功能的需求,我们的需求是把日志记录到本地,然后让用户上传到服务端,我分别尝试了用NSLogger和CocoaLumberjack完成,下面说下具体过程。

过程

** NSLogger**
github地址
NSLogger的导入十分简单,以下是github上的Installation

Step 1. Download the NSLogger desktop app on your Mac.
Step 2. Add the NSLogger framework to your project.
Step 3. There is no step 3…

NSLogger在mac端有一个专门查看日志的客户端软件,可在github上下载。
而在客户端中保存的日志格式为.rawnsloggerdata。LoggerSetBufferFile这句代码让你设置日志保存的位置。如下:

NSString *cacheDirectory = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) objectAtIndex:0];  
NSString *logPath = [cacheDirectory stringByAppendingPathComponent:@"log.rawnsloggerdata"];  
LoggerSetBufferFile(NULL, (__bridge CFStringRef)logPath); 

导入框架后,为了方便调用,可以按照自己的想法先定义宏定义

#define NSLog(...)  LogMessageF(__FILE__, __LINE__, __FUNCTION__, @"NSLog", 0, __VA_ARGS__)

下面只要在你想打印日志的地方加入NSLog()即可。

需要注意的是:当电脑和测试机处于同一个局域网内,且NSLogger Viewer开启时,NSLogger Viewer会将手机客户端运行时的日志实时显示,而此时这部分日志是不会写入手机客户端本地的,只有NSLogger Viewer没开启监控,日志才会写入本地,这点要注意!!!

另外,NSLogger支持多种数据类型,如文件,图片,文字等等,有需要同学可以深入研究下。

因为NSLogger只能把日志保存.rawnsloggerdata格式,并且只能在mac上用相应客户端查看,不符合我们的需求,于是,我用了另一个框架-CocoaLumberjack。

** CocoaLumberjack**
github地址
导入框架可参考这篇文章,写得不错,下面也根据我自身的需求大概说下:

首先说下CocoaLumberjack的日志级别:

LOG_LEVEL_ERROR:如果设置为LOG_LEVEL_ERROR,仅仅能看到Error相关的日志输出。
LOG_LEVEL_WARN:如果设置为LOG_LEVEL_WARN,能看到Error、Warn相关的日志输出。
LOG_LEVEL_INFO:如果设置为LOG_LEVEL_INFO,能够看到Error、Warn、Info相关的日志输出。
LOG_LEVEL_DEBUG:如果设置为LOG_LEVEL_DEBUG,能够看到Error/Warn/Info/Debug相关的日志输出。
LOG_LEVEL_VERBOSE:如果设置为LOG_FLAG_VERBOSE,能够看到Error/Warn/Info/Debug/Verbose相关日志输出。
LOG_LEVEL_OFF:不输出日志

CocoaLumberjack记录日志有几种方式,可以根据自己的需求选择是否导入
DDASLLogger(发送日志语句到苹果的日志系统,以便它们显示在Console.app上)
DDTTYLoyger(发送日志语句到Xcode控制台,如果可用)
DDFIleLoger(把日志语句发送至文件)
因为我只需要把日志发送控制台和记录在文件,所以我只导入了DDTTYLoyger和DDFIleLoger

在pch头文件设置全局日志等级

static const DDLogLevel ddLogLevel = DDLogLevelVerbose;

DDLogLevel 定义了全局的 log 等级,DDLogFlag 是我们打 log 时设定的 log 等级,CocoaLumberjack 会比较两者,如果 flag 低于 level,则不会打 log:

//在appdelegate中初始化
    //发送日志语句到Xcode控制台
    [DDLog addLogger:[DDTTYLogger sharedInstance]];
    //把日志语句发送至文件
    DDFileLogger *fileLogger = [[DDFileLogger alloc] init];
    fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling
    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
    [DDLog addLogger:fileLogger withLevel:DDLogLevelError];

在实际应用中我定义了两个不同日志等级的宏

//INFO级别
#define HZLogInfo(format, ...) DDLogInfo((@"[%@][Line:%d]:" format), [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, ## __VA_ARGS__)
//Error级别
#define HZLogError(format, ...) DDLogError((@"[%@][Line:%d]:" format), [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, ## __VA_ARGS__)

解释下上面代码:
我设置全局日志等级为DDLogLevelVerbose,可打印Error/Warn/Info/Debug/Verbose相关等级的日志,当然这里还可以根据debug和release设置不同的等级。

另外,导入DDTTYLogger没设置level,这里会默认打印全部等级日志,而DDFileLogger我设置了DDLogLevelError等级,所以只有error等级日志才能写入文件。

所以我定义的两句宏:
HZLogInfo写入的是INFO级别的日志,所以这类日志只能显示在控制台,而不能写入文件。
HZLogError是ERROR级别日志,所以这类日志不仅显示在控制台,还可以写入文件。
当然各位可以根据自己需求而定,CocoaLumberjack记录的本地日志格式为.log格式,上传到服务器时不需特定在mac端观看,满足我们的需求。

另外,我的需求中还需要捕获异常并写入日志,这篇异常捕捉的文章写得十分详细,推荐给大家。要注意的是,使用 NSUncaughtExceptionHandler 捕获 NSException,后注册的NSUncaughtExceptionHandler会把前面注册的handler覆盖,在我们的项目中就有这样的问题。正确的做法是利用NSGetUncaughtExceptionHandler拿到上一个注册的Handler,处理完自己的Handler后再把exception传给上一个Handler。示例如下

static NSUncaughtExceptionHandler *previousUncaughtExceptionHandler;

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
   //保存之前的Handler
   previousUncaughtExceptionHandler = NSGetUncaughtExceptionHandler();
   // 将下面C函数的函数地址当做参数
  NSSetUncaughtExceptionHandler(&UncaughtExceptionHandler);
   return YES;
}

void UncaughtExceptionHandler(NSException *exception){
   // 错误reason
    NSString *reason = [exception reason];
    // exception name
    NSString *name = [exception name];
    //异常的堆栈信息
    NSArray *stackArray = [exception callStackSymbols];
    //拼接错误信息
    NSString *exceptionInfo = [NSString stringWithFormat:@" Exception reason: %@\nException name: %@\nException stack:%@", reason , name , stackArray];
   //在此处理我们自己的Handler

    //调用之前注册的Handler
    previousUncaughtExceptionHandler(exception);
}

NSSetUncaughtExceptionHandler()函数指针的恶意覆盖的问题就解决了。参考文章

结束

学习之路,与君共勉。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,997评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,975评论 0 6
  • 会的不难,难的不会,这大概就是温习旧知识和学习新知识时的感受了吧。 这几天百度Debug日志管理,利用CocoaL...
    plantseeds阅读 12,858评论 9 62
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,633评论 18 139
  • Spring Boot-日志配置(超详细) 更新日志:20170810 更新通过 application.yml传...
    inke阅读 67,252评论 9 122