将log信息记录到控制台,文件或远程服务器被广泛用于几乎任何类型的软件开发。它是调试的最简单的形式之一。当调试或试图理解一个复杂的逻辑,不管语言,日志系统都能够很容易,且快速为开发和维护带来便利。在iOS中,在正常的debug情况下当然可以通过NSLog
来打印,但是当程序正式上线,程序闪退等意外发生的时候,这时候要是有记录用户行为的日志被记录下来,那么能够更容易分析错误。这里介绍一个iOS上一个第三方日志库CocoaLumberjack
。正如它在Github 上介绍的那样
CocoaLumberjack is a fast & simple, yet powerful & flexible logging framework for Mac and iOS.
为什么不用NSLog
你可能不知道NSLog
会使你的程序变慢。NSLog
首先就不是设计作为普通的debug log的,而是error log。并且每一次NSLog
的打印都需要和苹果系统日志(ASL)进行一次连接,然后在打印结束后,断开这次连接。总结下NSLog
有如下几个缺点
-
NSLog
太不灵活 -
NSLog
太慢 -
NSLog
没有等级制度log
其中最为重要一点就是NSLog
缺少成为日志系统所必须的log级别。这就是本文所要介绍的CocoaLumberjack的优点,并且CocoaLumberjack能够很容易的自定义自己的log等级
CocoaLumberjack
CocoaLumberjack
能够快速的给你提供如下的的功能:
- 跟踪在程序中不断出现的不可复制的bug
- 为你的应用程序寻找企业级的日志解决方案。
CocoaLumberjack的使用很简单,只需要简单将Lumberjack文件添加到你的项目中,配置完后使用所定义的宏就好了。
配置CocoaLumberjack
整个配置很简单,只需在applicationDidFinishLaunching
后添加如下两句代码,这样就使CocoaLumberjack定义的宏DDLog
具有NSLog
的功能(ASL和控制台)
[DDLog addLogger:[DDASLLogger sharedInstance]]; // 向ASL 发送log
[DDLog addLogger:[DDTTYLogger sharedInstance]]; // 向控制台发送
对于调试代码来说,只需要打开向控制台发送输出结果就好,即打开下面那个logger。CocoaLumberjack
我觉得最酷的就是可以异步输出到文件,并且能定期的发送到远程服务器,或者缓存到达一定的size发送到制定的服务器,而且使用也很简单,只需要单独的设置。
fileLogger = [[DDFileLogger new];
fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling
fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
[DDLog addLogger:fileLogger];
上面的代码告诉应用程序要在系统上保持一周的日志文件,是不是简单而又功能强大。
DDLog四种级别
DDLog
默认有四种级别,分别为:
DDlogError
DDlogWarn
DDlogInfo
DDlogVerbose
DDLogLevel
定义了全局的logger等级,DDLogFlag
是打log时设定的log等级,CocoaLumberjack
会比较两者,如果flag低于level,则不会打log.针对不同的flag。这两个在后面自定义自己的日志系统中,有很大的作用。
DDlogVerbose
这个级别最低的东东,一般的来说,在系统实际运行过程中,一般都是不输出的。因此这个级别的信息,可以随意的使用,任何觉得有利于在调试时更详细的了解系统运行状态的东东,比如变量的值等等,都输出来看看也无妨。当然,在每一个 Debug 调用之前,一定要加上 If 判断。
DDlogInfo
这个应该用来反馈系统的当前状态给最终用户的,所以,在这里输出的信息,应该对最终用户具有实际意义,也就是最终用户要能够看得明白是什么意思才行。从某种角度上说,Info 输出的信息可以看作是软件产品的一部分(就像那些交互界面上的文字一样),所以需要谨慎对待,不可随便。
DDlogError DDlogWarn
警告、错误应该都在系统运行时检测到了一个不正常的状态.
自定义log系统
对于构建自己的log系统,一般需要以下实现几个方面
- 可以设定 Log 等级
- 可以积攒到一定量的 log 后,一次性发送给服务器,绝对不能打一个 Log 就发一次
- 可以一定时间后,将未发送的 log 发送到服务器
- 可以在 App 切入后台时将未发送的 log 发送到服务器
下面基于Lumberjack,实现自己的log系统。
自定义Log等级
如果觉得Lumberjack默认的等级分的不够细,Lumberjack支持自定义log等级,只需要自定义我们自己的头文件,然后替代DDlog.h来引入到项目中去。等级的详细程度可以根据自己的需求,首先需要undefine Lumberjack自带的log,然后自定义自己的等级和flag。最后定义自己格式的宏,来替代DDLog
和NSLog
#import "DDLog.h"
// First undefine the default stuff we don't want to use.
#undef LOG_FLAG_ERROR
#undef LOG_FLAG_WARN
#undef LOG_FLAG_INFO
#undef LOG_FLAG_DEBUG
#undef LOG_FLAG_VERBOSE
#undef LOG_LEVEL_ERROR
#undef LOG_LEVEL_WARN
#undef LOG_LEVEL_INFO
#undef LOG_LEVEL_DEBUG
#undef LOG_LEVEL_VERBOSE
#undef LOG_ERROR
#undef LOG_WARN
#undef LOG_INFO
#undef LOG_DEBUG
#undef LOG_VERBOSE
#undef DDLogError
#undef DDLogWarn
#undef DDLogInfo
#undef DDLogDebug
#undef DDLogVerbose
#undef DDLogCError
#undef DDLogCWarn
#undef DDLogCInfo
#undef DDLogCDebug
#undef DDLogCVerbose
// Now define everything how we want it
#define LOG_FLAG_FATAL (1 << 0) // 0...000001
#define LOG_FLAG_ERROR (1 << 1) // 0...000010
#define LOG_FLAG_WARN (1 << 2) // 0...000100
#define LOG_FLAG_NOTICE (1 << 3) // 0...001000
#define LOG_FLAG_INFO (1 << 4) // 0...010000
#define LOG_FLAG_DEBUG (1 << 5) // 0...100000
#define LOG_LEVEL_FATAL (LOG_FLAG_FATAL) // 0...000001
#define LOG_LEVEL_ERROR (LOG_FLAG_ERROR | LOG_LEVEL_FATAL ) // 0...000011
#define LOG_LEVEL_WARN (LOG_FLAG_WARN | LOG_LEVEL_ERROR ) // 0...000111
#define LOG_LEVEL_NOTICE (LOG_FLAG_NOTICE | LOG_LEVEL_WARN ) // 0...001111
#define LOG_LEVEL_INFO (LOG_FLAG_INFO | LOG_LEVEL_NOTICE) // 0...011111
#define LOG_LEVEL_DEBUG (LOG_FLAG_DEBUG | LOG_LEVEL_INFO ) // 0...111111
#define LOG_FATAL (ddLogLevel & LOG_FLAG_FATAL )
#define LOG_ERROR (ddLogLevel & LOG_FLAG_ERROR )
#define LOG_WARN (ddLogLevel & LOG_FLAG_WARN )
#define LOG_NOTICE (ddLogLevel & LOG_FLAG_NOTICE)
#define LOG_INFO (ddLogLevel & LOG_FLAG_INFO )
#define LOG_DEBUG (ddLogLevel & LOG_FLAG_DEBUG )
// third define Formmater
#define DDLogFatal(frmt, ...) SYNC_LOG_OBJC_MAYBE(ddLogLevel, LOG_FLAG_FATAL, 0, frmt, ##__VA_ARGS__)
#define DDLogError(frmt, ...) SYNC_LOG_OBJC_MAYBE(ddLogLevel, LOG_FLAG_ERROR, 0, frmt, ##__VA_ARGS__)
#define DDLogWarn(frmt, ...) ASYNC_LOG_OBJC_MAYBE(ddLogLevel, LOG_FLAG_WARN, 0, frmt, ##__VA_ARGS__)
#define DDLogNotice(frmt, ...) ASYNC_LOG_OBJC_MAYBE(ddLogLevel, LOG_FLAG_NOTICE, 0, frmt, ##__VA_ARGS__)
#define DDLogInfo(frmt, ...) ASYNC_LOG_OBJC_MAYBE(ddLogLevel, LOG_FLAG_INFO, 0, frmt, ##__VA_ARGS__)
#define DDLogDebug(frmt, ...) ASYNC_LOG_OBJC_MAYBE(ddLogLevel, LOG_FLAG_DEBUG, 0, frmt, ##__VA_ARGS__)
#define DDLogCFatal(frmt, ...) SYNC_LOG_C_MAYBE(ddLogLevel, LOG_FLAG_FATAL, 0, frmt, ##__VA_ARGS__)
#define DDLogCError(frmt, ...) SYNC_LOG_C_MAYBE(ddLogLevel, LOG_FLAG_ERROR, 0, frmt, ##__VA_ARGS__)
#define DDLogCWarn(frmt, ...) ASYNC_LOG_C_MAYBE(ddLogLevel, LOG_FLAG_WARN, 0, frmt, ##__VA_ARGS__)
#define DDLogCNotice(frmt, ...) ASYNC_LOG_C_MAYBE(ddLogLevel, LOG_FLAG_NOTICE, 0, frmt, ##__VA_ARGS__)
#define DDLogCInfo(frmt, ...) ASYNC_LOG_C_MAYBE(ddLogLevel, LOG_FLAG_INFO, 0, frmt, ##__VA_ARGS__)
#define DDLogCDebug(frmt, ...) ASYNC_LOG_C_MAYBE(ddLogLevel, LOG_FLAG_DEBUG, 0, frmt, ##__VA_ARGS__)
自定义log格式
CocoaLumberjack 允许自定义log的消息结构。自定义一个 LogFormatter的类, 遵从DDLogFormatter
协议,重写 formatLogMessage
方法,这个方法返回值是NSString
,就是最终 log 的消息体字符串。而输入参数 logMessage 是由 logger 发的一个 DDLogMessage
对象,包含了一些必要的信息。以下是一个简单的实现,输出时间和flag格式,和log消息
- (NSString *)formatLogMessage:(DDLogMessage *)logMessage {
NSString *flag = stringByLogFlag(logMessage->_flag);
NSString *dateAndTime = [_dataFormatter stringFromDate:logMessage->_timestamp];
return [NSString stringWithFormat:@"%@ %@ %@", dateAndTime, flag, logMessage->_message];
}
总结
CocoaLumberjack 使构建自己的log系统变得十分简单,只需要定义level和log消息格式就好了。