【源码】iOS日志管理(一)------日志框架CocoaLumberjack

 

如何开始使用Lumberjack框架

 

项目导入CocoaLumberjack

在pod文件中加入

#日志

pod 'CocoaLumberjack'

更新pod install

完成

开始

三步开始使用CocoaLumberjack框架：

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

2.配置框架；

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



把Lumberjack框架添加到你的项目

 

需要在AppDelegate.h中添加的主要文件有四个：

#import <DDLog.h>//整个框架的基础

#import <DDASLLogger.h>//发送日志语句到苹果的日志系统，以便它们显示在Console.app上

#import <DDTTYLogger.h>//发送日志语句到Xcode控制台，如果可用

#import <DDFileLogger.h>//把日志语句发送至文件

 

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

 

配置框架

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

 

开始时，你需要下面两行代码：

[DDLog addLogger:[DDASLLogger sharedInstance]]; 

[DDLog addLogger:[DDTTYLogger sharedInstance]]; 

这将在你的日志框架中添加两个“logger”。

也就是说你的日志语句将被发送到Console.app和Xcode控制 台（就像标准的NSLog）

 

这个框架的好处之一就是它的灵活性，如果你还想要你的日志语句写入到一个文件中，你可以添加和配置一个file logger:

    DDFileLogger *fileLogger = [[DDFileLogger alloc] init];

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

    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;

    [DDLog addLogger:fileLogger];

 

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

 

用DDLog替换NSLog语句

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

    DDLogVerbose(@"Verbose");

    DDLogDebug(@"Debug");

    DDLogInfo(@"Info");

    DDLogWarn(@"Warn");

    DDLogError(@"Error");

 

我们看到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级别等，我们将在另一篇文章中讲到)。

 

以下是如何转换你的日志语句：

// CONVERT FROM THIS

#import "Sprocket.h"

@implementation Sprocket

- (void)someMethod
{
    NSLog(@"Meet George Jetson");
}

@end

// TO THIS

#import "Sprocket.h"
#import "DDLog.h"

static const int ddLogLevel = LOG_LEVEL_VERBOSE;

@implementation Sprocket

- (void)someMethod
{
    DDLogVerbose(@"Meet George Jetson");
}

@end

 

注意日志级别声明为常量，这意味着这意味着日志级别阈值以上的DDLog语句都将编译到你的项目中。

 

下面上代码了

 

===================================================================================

#import "AppDelegate.h"

//日志

#import <DDLog.h>//整个框架的基础

#import <DDASLLogger.h>//发送日志语句到苹果的日志系统，以便它们显示在Console.app上

#import <DDTTYLogger.h>//发送日志语句到Xcode控制台，如果可用

#import <DDFileLogger.h>//把日志语句发送至文件

//日志级别阈值以上的DDLog语句都将编译到你的项目中。

//DDLog 必须配置打印级别

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

//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语句。

static const int ddLogLevel = LOG_LEVEL_VERBOSE;

 

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

//    [DDLog addLogger:[DDASLLogger sharedInstance]];

    [DDLog addLogger:[DDTTYLogger sharedInstance]];

    DDFileLogger *fileLogger = [[DDFileLogger alloc] init];

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

    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;

    [DDLog addLogger:fileLogger];

    DDLogVerbose(@"Verbose");

    DDLogDebug(@"Debug");

    DDLogInfo(@"Info");

    DDLogWarn(@"Warn");

    DDLogError(@"Error");

 }