iOS CocoaLumberjack/Swift 强大的日志框架使用

https://github.com/CocoaLumberjack/CocoaLumberjack

CocoaLumberjack 是一个强大、灵活且高效的日志框架，适用于 iOS 和 macOS 开发。它比标准的 NSLog() 提供了更多的功能，包括不同级别的日志记录、日志消息到不同目标的重定向（如控制台、文件等），以及对异步日志记录的支持。下面是如何在使用 Swift 的 iOS 项目中集成和使用 CocoaLumberjack 的步骤。

安装 CocoaLumberjack

首先，你需要将 CocoaLumberjack 库添加到你的 iOS 项目中。可以通过 CocoaPods、Carthage 或 Swift Package Manager 来安装。

使用 CocoaPods

在你的 Podfile 中添加以下行：

pod 'CocoaLumberjack/Swift'

然后在终端中运行：

pod install

使用 Carthage

在你的 Cartfile 中添加：

github "CocoaLumberjack/CocoaLumberjack"

运行 carthage update，然后将生成的框架拖动到 Xcode 项目中。

使用 Swift Package Manager

在 Xcode 中，你可以通过选择「File」->「Swift Packages」->「Add Package Dependency...」来添加 CocoaLumberjack。输入 CocoaLumberjack 的 GitHub 仓库 URL：

https://github.com/CocoaLumberjack/CocoaLumberjack.git

设置 CocoaLumberjack

首先确保导入了 CocoaLumberjack：

import CocoaLumberjackSwift

接下来，需要在应用启动时配置日志级别和日志输出：

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // 设置日志级别
    DDLog.add(DDOSLogger.sharedInstance) // 使用系统的os_log
    DDOSLogger.sharedInstance.logFormatter = MyCustomLogFormatter()

    let fileLogger: DDFileLogger = DDFileLogger() // 日志文件记录器
    fileLogger.rollingFrequency = TimeInterval(60 * 60 * 24) // 24小时滚动一次新文件
    fileLogger.logFileManager.maximumNumberOfLogFiles = 7 // 最多7个日志文件
    DDLog.add(fileLogger)

    // 简单测试日志
    DDLogInfo("App启动完成")

    return true
}

使用 CocoaLumberjack 进行日志记录

CocoaLumberjack 支持不同级别的日志记录，如下：

DDLogVerbose("这是一个Verbose级别的日志")
DDLogDebug("这是一个Debug级别的日志")
DDLogInfo("这是一个Info级别的日志")
DDLogWarn("这是一个Warning级别的日志")
DDLogError("这是一个Error级别的日志")

自定义日志格式

你可以通过实现 DDLogFormatter 协议来自定义日志的格式。例如：

class MyCustomLogFormatter: NSObject, DDLogFormatter {
    func format(message logMessage: DDLogMessage) -> String? {
        let dateString = DateFormatter.localizedString(from: logMessage.timestamp, dateStyle: .short, timeStyle: .medium)
        return "\(dateString) [\(logMessage.fileName):\(logMessage.line)] \(logMessage.message)"
    }
}

这样你就可以根据需要对日志格式进行完全的自定义。

总结

CocoaLumberjack 是一个功能丰富的日志框架，提供了比系统日志更多的控制和选项。通过配置不同的日志级别和输出格式，它可以帮助你在开发过程中更好地跟踪和调试应用程序。使用以上方法可以在你的 Swift iOS 项目中轻松集成和使用 CocoaLumberjack。