iOS开源项目之日志框架CocoaLumberjack

一、概述

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

• 快速简单
  用法跟NSLog一样，但是速度比NSLog快一个量级。
• 强大
  一个日志语句可以被发送到多个logger，意味着你可以同时记录文件和控制台。此外，还可以创建自己的logger，将日志语句发送到网络、数据库或者分布式文件系统中。没有任何限制。
• 灵活性
  配置你自己想要的日志框架。修改每个文件的日志级别（尤其是测试时）。修改每个logger的日志级别（详细的控制台，但是简洁的日志文件）。修改每个Xcode配置的日志级别。为你的应用程序定制日志级别的数量。添加自己的精细的日志。在运行时动态修改日志级别。 选择如何以及何时回滚你的日志文件。将日志文件上传至中心服务器。压缩存档日志文件来节省硬盘空间。

当你想找到一种方式来跟踪在程序中不断出现的不可复制的bug时，你可以选择CocoaLumberjack框架。

2，CocoaLumberjack自带了几种Log方式：

• DDLog（整个框架的基础）
• DDASLLogger（发送日志语句到苹果的日志系统，以便它们显示在Console.app(控制台)）
• DDTTYLoyger（发送日志语句到Xcode控制台或终端上）
• DDFIleLoger（把日志写入本地文件）

DDLog是强制性的，其余的都是可选的，这取决于你打算如何使用这个框架。例如，如果你不打算纪录到一个文件，你可以跳过DDFileLogger，或者你想跳过ASL以便更快的文件记录，你可以跳过DDASLLoger。你可以同时记录文件和控制台，还可以创建自己的logger，将日志语句发送到网络或者数据库中。

3，Log级别

1> CocoaLumberjack的Log级别有5种：

typedef NS_OPTIONS(NSUInteger, DDLogFlag){
    DDLogFlagError      = (1 << 0),
    DDLogFlagWarning    = (1 << 1),
    DDLogFlagInfo       = (1 << 2),
    DDLogFlagDebug      = (1 << 3),
    DDLogFlagVerbose    = (1 << 4)
};

2> Log Level 用来过滤每条Log：

typedef NS_ENUM(NSUInteger, DDLogLevel){
    DDLogLevelOff       = 0,
    DDLogLevelError     = (DDLogFlagError),
    DDLogLevelWarning   = (DDLogLevelError   | DDLogFlagWarning),
    DDLogLevelInfo      = (DDLogLevelWarning | DDLogFlagInfo),
    DDLogLevelDebug     = (DDLogLevelInfo    | DDLogFlagDebug),
    DDLogLevelVerbose   = (DDLogLevelDebug   | DDLogFlagVerbose),
    DDLogLevelAll       = NSUIntegerMax
};

例如，如果您将日志级别设置为DDLogLevelInfo，那么你会看到error、Warn和Info语句。你也可以自定义Log级别或者每个级别的名字或者在单纯的级别上增加一些高级用法。

二、安装使用

1，使用CocoaPods安装：

pod 'CocoaLumberjack'

2，在项目中使用：
1> 将下列代码粘贴到.pch文件或者想要单独控制的某个文件中：

// 日志
#import <CocoaLumberjack/CocoaLumberjack.h>
#ifdef DEBUG
static const DDLogLevel ddLogLevel = DDLogLevelInfo;
#else
static const DDLogLevel ddLogLevel = DDLogLevelWarning;
#endif

2> 在AppDelegate的applicationDidFinishLaunching方法中添加需要的logger：

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // 添加DDASLLogger，你的日志语句将被发送到Xcode控制台
    [DDLog addLogger:[DDTTYLogger sharedInstance]];
    
    // 添加DDTTYLogger，你的日志语句将被发送到Console.app
    [DDLog addLogger:[DDASLLogger sharedInstance]];
    
    // 添加DDFileLogger，你的日志语句将写入到一个文件中，默认路径在沙盒的Library/Caches/Logs/目录下，文件名为bundleid+空格+日期.log。
    DDFileLogger *fileLogger = [[DDFileLogger alloc] init];
    fileLogger.rollingFrequency = 60 * 60 * 24;
    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
    [DDLog addLogger:fileLogger];
    
    //产生Log
    DDLogVerbose(@"Verbose");
    DDLogDebug(@"Debug");
    DDLogInfo(@"Info");
    DDLogWarn(@"Warn");
    DDLogError(@"Error");
    
    return YES;
}

我们还可以为每种loger设置不同的级别：

[DDLog addLogger:[DDASLLogger sharedInstance] withLevel:DDLogLevelInfo];
[DDLog addLogger:[DDTTYLogger sharedInstance] withLevel:DDLogLevelDebug];

三、给Xcode中控制台输出的日志添加颜色

image.png
1> 首先给Xcode安装XcodeColors插件。
2> 参考文章：使用XcodeColors正确姿势

三、自定义日志的格式(DDLogFormatter)

首先自定义一个 LogFormatter, 遵从 DDLogFormatter 协议，我们需要重写 - (NSString *)formatLogMessage:(DDLogMessage *)logMessage 这个方法，这个方法的输入参数是由 logger 发的一个 DDLogMessage 对象，包含了一些必要的信息，返回值就是最终 log 的消息体字符串。参考官方文档：自定义日志的formatter格式。

四、自定义日志的Logger(DDLogger)

我们还可以自定义Logger，实现我们自己想要的处理，我这边需要实现的格式是：

// 格式： 日期 [类名 行数] 日志信息
2018-01-24 11:47:03:262 [AppDelegate 24] Verbose
2018-01-24 11:47:03:262 [AppDelegate 25] Debug
2018-01-24 11:47:03:262 [AppDelegate 26] Info
2018-01-24 11:47:03:262 [AppDelegate 27] Warn
2018-01-24 11:47:03:262 [AppDelegate 28] Error
2018-01-24 11:47:03:263 [AppDelegate 30] ZJLog
2018-01-24 11:47:03:263 [AppDelegate 31] ZJLogLive

参考官方文档：CustomLoggers

五、搭建自己的 Log 系统(ZJLog)

1> 首先新建ZJLog.h文件，内容如下：

// 引入CocoaLumberjack
#import <CocoaLumberjack/CocoaLumberjack.h>
#ifdef DEBUG
static const DDLogLevel ddLogLevel = DDLogLevelVerbose;
#else
static const DDLogLevel ddLogLevel = DDLogLevelWarning;
#endif

// 自定义日志对象
#import "ZJLogger.h"
// 自定义日志格式
#import "ZJLogFormatter.h"
// 自定义数据库日志对象
#import "ZJDatabaseLogger.h"

// 日志宏重命名
#ifndef ZJLog
#define ZJLog           DDLogVerbose
#define ZJLogError      DDLogError
#define ZJLogWarn       DDLogWarn
#define ZJLogInfo       DDLogInfo
#define ZJLogDebug      DDLogDebug
#define ZJLogVerbose    DDLogVerbose
#endif

// 根据业务定义日志类型
// 直播
#define ZJLiveSwitch 1
#ifndef ZJLogLive
#if ZJLiveSwitch && DEBUG
#define ZJLogLive           DDLogVerbose
#else
#define ZJLogLive
#endif
#endif

2> 在AppDelegate中引入ZJLog.h

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // 添加ZJLogger，你的日志语句将被发送到Xcode控制台或终端
    [DDLog addLogger:[ZJLogger sharedInstance]];

    // 打印Log
    ZJLogVerbose(@"Verbose");
    ZJLogDebug(@"Debug");
    ZJLogInfo(@"Info");
    ZJLogWarn(@"Warn");
    ZJLogError(@"Error");
    
    ZJLog(@"ZJLog");
    ZJLogLive(@"ZJLogLive");

    return YES;
}

效果图如下：

image.png

搭建的日志框架我已经放在GitHub上了，感兴趣的老铁可以给个Star，有问题和需求欢迎Pull Request，Demo里面给了一个大致的方向，具体上传到服务端的请求需要自己写。

六、总结

讲真，如果不需要实时上传日志数据，没啥必要使用日志框架。但是对于出现很难复现问题且无法定位时，就需要查看日志文件了，一般情况是，我们可以在前端反馈页面提供上传日志按钮，用户点击即可把本地日志上传到服务器。

参考文档：

官方文档：CocoaLumberjack Documentation
iOS开源项目之日志框架CocoaLumberjack
CocoaLumberjack：简单好用的Log库
深入解析iOS日志库CocoaLumberjack
利用 CocoaLumberjack 搭建自己的 Log 系统

image.png