iOS基于CocoaLumberjack的日志工具

使用Xcode编辑器进行iOS开发,其高效的便捷性和友好的开发体验,无可非议。我毫不怀疑:如果对所有程序猿开发的编辑器做一个排名的话,Xcode肯定能排上前几名。但是不得不说Xcode中的一个缺点是:打印日志不能分级。Android开发中可以对日志分为verbose,debug,error,warning,info等级别,这样能很方便的在编辑器中对日志信息进行过滤,定位问题更加方便。所以,「Ernesto Rivera」大神就开发出了CocoaLumberjack,可以方便的对日志进行分级。

CocoaLumberjack (VS) NSLog 具有效率高、功能强大、便于拓展的诸多优点。CocoaLumberjack的基本使用,github上面写的很详细。可以通过Cocoapods或者将文件直接嵌入工程的方式来使用,可以同时实现在Xcode日志栏、App沙盒目录、iPhone线程三个地方输出日志。

结合实际工程,最好的使用方式是:在CocoaLumberjack基础上,封装成自己的Log日志方式。这样做既可以保持工程编码风格的一致性,同时让工程代码与第三方依赖库隔离,防止以后依赖库没人维护时,顺利地替换成其他库。比如我们在iOS开发中,常常基于AFNetworking封装自己工程的网络请求。

封装CocoaLumberjack很方便,因为CocoaLumberjack本身已经预留了拓展的接口DDDispatchQueueLogFormatter。新建类ZDLogFormatter继承自DDDispatchQueueLogFormatter,重写- (NSString *)formatLogMessage:(DDLogMessage *)logMessage方法定义日志的具体格式。

@interface ZDLogFormatter : DDDispatchQueueLogFormatter

@end

@implementation ZDLogFormatter

//日志具体格式
- (NSString *)formatLogMessage:(DDLogMessage *)logMessage
{

    NSString *logLevel = nil;
    switch (logMessage.flag)
    {
            
        case DDLogFlagError:
            logLevel = @"[ERROR] > ";
            break;
        case DDLogFlagWarning:
            logLevel = @"[WARN]  > ";
            break;
        case DDLogFlagInfo:
            logLevel = @"[INFO]  > ";
            break;
        case DDLogFlagDebug:
            logLevel = @"[DEBUG] > ";
            break;
        case DDLogFlagVerbose:
            logLevel = @"[VBOSE] > ";
            break;
        default:
            logLevel = @"[VBOSE] > ";
            break;
    }
    
    NSTimeZone *zone = [NSTimeZone systemTimeZone];
    NSInteger interval = [zone secondsFromGMTForDate:logMessage.timestamp];
    NSDate *localeDate = [logMessage.timestamp dateByAddingTimeInterval:interval];
    NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
    [dateFormatter setDateFormat:@"yyyy-MM-dd HH:mm:ss:SSS"];
    NSString *formatStr = [NSString stringWithFormat:@"%@ %@[%@ %@][line %@][thread:%@]:\n%@",
                           [dateFormatter stringFromDate:localeDate],
                           logLevel,
                           logMessage.fileName,
                           logMessage.function,
                           @(logMessage.line),
                           [self queueThreadLabelForLogMessage:logMessage],
                           logMessage.message];
    return formatStr;
}
@end

定义自己的日志工具类ZDLog,继承至NSObject。

//.h文件
#import "CocoaLumberjack.h"
#import <Foundation/Foundation.h>

#ifdef LOG_LEVEL_DEF
#undef LOG_LEVEL_DEF
#define LOG_LEVEL_DEF ZDLog_logLevel
#endif

#ifdef LOG_ASYNC_ENABLED
#undef LOG_ASYNC_ENABLED
#ifdef DEBUG
#define LOG_ASYNC_ENABLED NO
#else
#define LOG_ASYNC_ENABLED YES
#endif
#endif

typedef NS_ENUM(NSUInteger, ZDLogLevel)
{
    ZDLogLevelOff = DDLogLevelOff,
    ZDLogLevelError = DDLogLevelError,
    ZDLogLevelWarning = DDLogLevelWarning,
    ZDLogLevelInfo = DDLogLevelInfo,
    ZDLogLevelDebug = DDLogLevelDebug,
    ZDLogLevelVerbose = DDLogLevelVerbose,
    ZDLogLevelAll = DDLogLevelAll
};
extern int ZDLog_logLevel;

#define ZDLogError(frmt, ...)   DDLogError(frmt, ##__VA_ARGS__)
#define ZDLogWarn(frmt, ...)    DDLogWarn(frmt, ##__VA_ARGS__)
#define ZDLogInfo(frmt, ...)    DDLogInfo(frmt, ##__VA_ARGS__)
#define ZDLogDebug(frmt, ...)   DDLogDebug(frmt, ##__VA_ARGS__)
#define ZDLogVerbose(frmt, ...) DDLogVerbose(frmt, ##__VA_ARGS__)

@interface ZDLog : NSObject
/**
 *
 *  设置日志级别,必须设置,否则不打开日志
 *
 *  @param logLevel 级别,见枚举.
 */
+ (void)setLevel:(ZDLogLevel)logLevel;
@end

//.m文件
#import "ZDLog.h"
#import "DDDispatchQueueLogFormatter.h"
#ifdef DEBUG
int ZDLog_logLevel = ZDLogLevelVerbose;
#else
int ZDLog_logLevel = ZDLogLevelWarning;
#endif

@implementation ZDLog

+ (void)setLevel:(ZDLogLevel)logLevel
{
    ZDLog_logLevel = (int)logLevel;
    [DDLog removeAllLoggers];
    [self addTTYLoggerWithLevel:(ZDLogLevel) logLevel];
    [self addFileLoggerWithLevel:(ZDLogLevel) logLevel];
    [self addASLLoggerWithLevel:(ZDLogLevel) logLevel];
}
//添加日志到iPhone后台线程
+ (void)addASLLoggerWithLevel:(ZDLogLevel)logLevel
{
    DDASLLogger *logger = [DDASLLogger sharedInstance];
    logger.logFormatter = [[ZDLogFormatter alloc] init];
    [DDLog addLogger:logger withLevel:(DDLogLevel) logLevel];
}
//添加日志到Xcode打印区
+ (void)addTTYLoggerWithLevel:(ZDLogLevel)logLevel
{
    DDTTYLogger *ttyLogger = [DDTTYLogger sharedInstance];
    ttyLogger.logFormatter = [[ZDLogFormatter alloc] init];
    [DDLog addLogger:ttyLogger withLevel:(DDLogLevel) logLevel];
}
//添加日志到App沙河目录
+ (void)addFileLoggerWithLevel:(ZDLogLevel)logLevel
{
    DDFileLogger *fileLogger = [DDFileLogger new];
    fileLogger.logFileManager.maximumNumberOfLogFiles = 10;
    fileLogger.logFormatter = [[ZDLogFormatter alloc] init];
    [DDLog addLogger:fileLogger withLevel:(DDLogLevel) logLevel];
}
@end

使用时,首先调用ZDLog的类方法setLevel定义需要显示的日志等级。这样在需要打印日志的地方,设置引入ZDLog的头文件,然后就可以调用ZDLog来打印日志了:

ZDLogError(@"ZDLogError");
ZDLogWarn(@"ZDLogWarn");
ZDLogInfo(@"ZDLogInfo");
ZDLogDebug(@"ZDLogDebug");
ZDLogVerbose(@"ZDLogVerbose");

快快试一下吧~

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

推荐阅读更多精彩内容

  • 文/以琳_ 日暖朝晖荡柳垂,啼莺早醒隔帘窥。 情丝不挽凭星落,梦影慵揩任月随。 聒噪夏蝉风也恼...
    以琳_阅读 622评论 42 66
  • 时间过得越久,就越不知道自己来到这个世界究竟是为了生活,还是为了等候。 人人都会遇上遗憾,而最深的遗憾就是,我想在...
    江小鹏阅读 531评论 0 2
  • 生活中每个人总有负面情绪失控的时候,这不仅无法解决问题,还会影响我们的工作生活,其实负面情绪从来不需要控制,而是需...
    Smile_Zhangjie阅读 110评论 0 0