【源碼】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");

 }