iOS开源项目之日志框架CocoaLumberjack(未整理版)

CocoaLumberjack是Mac和iOS上一个集快捷、简单、强大和灵活于一身的日志框架。CocoaLumberjack类似于流行 的日志框架(如log4j),但它是专为Objective-C设计的,利用了多线程、GCD(如果可用)、无锁原子操作Objective-C运行时的 动态特性。

快速 在大多数用例中,Lumberjack比NSLog快了一个数量级。

简单 当应用程序启动时,只需一行加单的代码就可配置Lumberjack。然后用DDLog语句简单地取代NSLog语句。 并且DDLog宏与NSLog的有完全相同的格式和语法,所以超级简单。

强大 一个日志语句可以被发送到多个logger,意味着你可以同时记录文件和控制台。此外,还可以创建自己的logger,将日志语句发送到网络、数据库或者分布式文件系统中。没有任何限制。

灵活性 配置你自己想要的日志框架。修改每个文件的日志级别(尤其是测试时)。修改每个logger的日志级 别(详细的控制台,但是简洁的日志文件)。修改每个Xcode配置的日志级别。为你的应用程序定制日志级别的数量。添加自己的精细的日志。在运行时动态修 改日志级别。 选择如何以及何时回滚你的日志文件。将日志文件上传至中心服务器。压缩存档日志文件来节省硬盘空间。

当你遇到一下情况是,你可以选择Lumberjack框架

1.你想找到一种方式来跟踪在程序中不断出现的不可复制的bug;

2.你对iPhone上的简短日志感到很失望;

3.出于支持系统和稳定性的需要,你想将应用程序升级到下一级别;

4.为你的应用程序(Mac或者iPhone)寻找企业级的日志解决方案。

如何开始使用Lumberjack框架

1.将Lumberjack文件添加到你的项目中;

2.配置框架;

3.将NSLog指令转换为使用Lumberjack宏指令;

把Lumberjack框架添加到你的项目

需要添加的主要文件有四个:

1.@DDLog(整个框架的基础)

2.@DDASLLogger(发送日志语句到苹果的日志系统,以便它们显示在Console.app上)

3.@DDTTYLoyger(发送日志语句到Xcode控制台,如果可用)

4.@DDFIleLoger(把日志语句发送至文件)

DDLog是强制性的,其余的都是可选的,这取决于你打算如何使用这个框架。例如,如果你不打算纪录到一个文件,你可以跳过DDFileLogger,或者你想跳过ASL以便更快的文件记录,你可以跳过DDASLLoger

配置框架

首先,你想要在你的应用程序中配置这个日志框架,通常在applicationDidFinishLaunching方法中配置。

  fileLogger = [[DDFileLogger alloc] init];

 fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling

 fileLogger.logFileManager.maximumNumberOfLogFiles = 7;

 [DDLog addLogger:fileLogger];

上面的代码告诉应用程序要在系统上保持一周的日志文件。

用DDLog替换NSLog语句

DDLog的头文件定义了你用来替换NSLog语句的宏,本质上看起来向下边这样:

NSLog(@"Broken sprocket detected!");

NSLog(@"User selected file:%@ withSize:%u", filePath, fileSize);

// To this:

DDLogError(@"Broken sprocket detected!");

DDLogVerbose(@"User selected file:%@ withSize:%u", filePath, fileSize);

我们看到DDLog宏和NSLog的语法完全相同。

所以你所要做的就是决定每个NSlog语句属于哪种日志级别。DDLog默认有四种级别的日志,分别是:

1.@DDlogError

2.@DDlogWarn

3.@DDlogInfo

4.@DDlogVerbose

当然选择哪个NSLog语句取决于你的消息的严重程度。

下面的这些不同的日志等级也许正有你所需要的:

1.如果你将日志级别设置为 LOG_LEVEL_ERROR,那么你只会看到DDlogError语句。

2.如果你将日志级别设置为LOG_LEVEL_WARN,那么你只会看到DDLogError和DDLogWarn语句。

3.如果您将日志级别设置为 LOG_LEVEL_INFO,那么你会看到error、Warn和Info语句。

4.如果您将日志级别设置为LOG_LEVEL_VERBOSE,那么你会看到所有DDLog语句。

5.如果您将日志级别设置为 LOG_LEVEL_OFF,你将不会看到任何DDLog语句。

那么我在哪里设置日志级别呢,在整个项目中我只能使用一个日志级别吗?

当然不是,我们都知道正如调试或者添加新特性,如果你想详细纪录目前正在做的那部分,Lumberjack框 架提供了对每个文件的调试控制,你仅可以修改编辑中的文件的日志级别。

(注释:当然还有许多其他高级选项,比如全球日志级别,Xcode的每个配置级别,每个logger级别等,我们将在另一篇文章中讲到)。

6.使用DDLog.

直接贴代码:

static const int ddLogLevel = LOG_LEVEL_VERBOSE;// 定义日志级别

[DDLog addLogger:[DDTTYLogger sharedInstance]];// 初始化DDLog日志输出,在这里,我们仅仅希望在xCode控制台输出

[[DDTTYLogger sharedInstance] setColorsEnabled:YES];// 启用颜色区分

DDLogError(@"错误信息"); // 红色

DDLogWarn(@"警告"); // 橙色

DDLogInfo(@"提示信息"); // 默认是黑色

DDLogVerbose(@"详细信息"); // 默认是黑色

以上是最简单的应用,当然,可以自定义每种日志的颜色,看需求吧。

[DDLog addLogger:[DDASLLogger sharedInstance]];// 如果需要,可以添加其他的日志输出支持

[[DDTTYLogger sharedInstance] setForegroundColor:[UIColor blueColor] backgroundColor:nil forFlag:LOG_FLAG_INFO];// 可以修改你想要的颜色

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

推荐阅读更多精彩内容