iOS全解13：日志收集、崩溃处理

一、Mac 控制台

Xcode工程其实是可以用命令行来build的，这样就可以用命令行编译出.app的文件，然后就可以打成ipa包。
整个流程做到自动化后，就可以方便的做每日的 daily build，便于产品和测试同事跟进进度！

系统日志App即：控制台 `Console.app`

可以直接看苹果文档：欢迎使用控制台 - Apple 支持

系统控制台

二、CocoaLumberjack 日志收集

CocoaLumberjack 是一个快速、简单，但很强大的日志框架，用于 Mac OS X 和 iOS 系统。
在大多数用例中，Lumberjack比NSLog快了一个数量级。

Log分为以下几种，分别代表不同的等级：

DDLogError
DDLogWarn
DDLogInfo
DDLogDebug
DDLogVerbose

严重度：

DDLogError>DDLogWarn>DDLogInfo>DDLogDebug>DDLogVerbose

语法

static const DDLogLevel ddLogLevel = DDLogLevelDebug;

`DDLog`语法跟`NSLog`语法一摸一样

# NSLog
NSLog(@"Broken sprocket detected!");
NSLog(@"User selected file:%@ withSize:%u", filePath, fileSize);

# DDLog
DDLogError(@"Broken sprocket detected!");
DDLogVerbose(@"User selected file:%@ withSize:%u", filePath, fileSize);

github库：CocoaLumberjack
导入pod库：pod 'CocoaLumberjack'
使用配置：

#pragma mark 日志处理：CocoaLumberjack
- (void)configurationCocoaLumberjack {
    // Uses os_log
    //[DDLog addLogger:[DDASLLogger sharedInstance]]; //iOS10之前
    [DDLog addLogger:[DDOSLogger sharedInstance]]; //iOS10之后
    [DDLog addLogger:[DDTTYLogger sharedInstance]];
    
    DDFileLogger *fileLogger = [[DDFileLogger alloc] init]; // File Logger
    fileLogger.rollingFrequency = 60 * 60 * 24;             // 24 hour rolling
    fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
    [DDLog addLogger:fileLogger];
}

使用CocoaLumberjack，出现问题：Use of undeclared identifier 'ddLogLevel'

解决方案：

在 pch文件添加以下配置

#ifdef __OBJC__
// 配置头文件
#import <UIKit/UIKit.h>
#import <Foundation/Foundation.h>
#import <CocoaLumberjack/CocoaLumberjack.h>
// 老版本不可用
//#ifdef DEBUG
//    static const int ddLogLevel = LOG_LEVEL_VERBOSE;
//#else
//    static const int ddLogLevel = LOG_LEVEL_WARN;
//#endif
// 使用新版本
#ifdef DEBUG
    static const DDLogLevel ddLogLevel = DDLogLevelVerbose;
#else
    static const DDLogLevel ddLogLevel = DDLogLevelWarning;
#endif

#endif

自己写一个日志收集（Swfit版）

自己设计一个日志收集系统需要考虑多个方面，包括日志的格式、存储、传输、性能优化等。以下是一个简单的日志收集系统的设计和实现代码示例。

1. 设计思路

日志级别：支持不同级别的日志（如Verbose、Debug、Info、Warn、Error）。
日志格式：每条日志包含时间戳、日志级别、日志内容等信息。
日志存储：将日志写入文件，支持日志文件的滚动（如按天或按大小）。
日志传输：支持将日志文件上传到服务器。
线程安全：确保在多线程环境下日志记录是安全的。

注意事项：

1.日志打印需要包含：时间、所在的文件、函数名称
2.日志的大小需要控制吗？
3.日志的写入策略、存储策略、删除策略；
4.上传时，有日志写入怎么处理？
5.日志的类型：普通、警告、崩溃
6.区分DEBUG和Release模式
7.多线程大量并发打日志应该怎么处理？

文件命名规则，格式：日期_时间.log
9.DEBUG模式下的日志，也要在控制台打印

2. 实现代码

2.1 定义日志级别

enum LogLevel: String {
    case verbose = "VERBOSE"
    case debug = "DEBUG"
    case info = "INFO"
    case warn = "WARN"
    case error = "ERROR"
}

2.2 日志管理器

以json文件的形式存储在磁盘，再上传到服务端。

import Foundation

class Logger {
    static let shared = Logger()
    private let logQueue = DispatchQueue(label: "com.yourapp.logger", attributes: .concurrent)
    private var logFileHandle: FileHandle?
    private let logFileURL: URL

    private init() {
        let documentsDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
        logFileURL = documentsDirectory.appendingPathComponent("app.log")
        createLogFileIfNeeded()
    }

    private func createLogFileIfNeeded() {
        if !FileManager.default.fileExists(atPath: logFileURL.path) {
            FileManager.default.createFile(atPath: logFileURL.path, contents: nil, attributes: nil)
        }
        logFileHandle = try? FileHandle(forWritingTo: logFileURL)
    }

    func log(_ level: LogLevel, message: String) {
        let timestamp = Date().iso8601
        let logMessage = "\(timestamp) [\(level.rawValue)] \(message)\n"

        logQueue.async(flags: .barrier) {
            if let data = logMessage.data(using: .utf8) {
                self.logFileHandle?.seekToEndOfFile()
                self.logFileHandle?.write(data)
            }
        }
    }

    func uploadLogFile(to url: URL, completion: @escaping (Bool) -> Void) {
        logQueue.async {
            self.logFileHandle?.synchronizeFile()
            let logFileData = try? Data(contentsOf: self.logFileURL)

            var request = URLRequest(url: url)
            request.httpMethod = "POST"
            request.httpBody = logFileData

            let task = URLSession.shared.dataTask(with: request) { data, response, error in
                if let error = error {
                    self.log(.error, message: "Error uploading log file: \(error)")
                    completion(false)
                    return
                }
                self.log(.info, message: "Log file uploaded successfully")
                completion(true)
            }
            task.resume()
        }
    }

    deinit {
        logFileHandle?.closeFile()
    }
}

extension Date {
    var iso8601: String {
        let formatter = ISO8601DateFormatter()
        return formatter.string(from: self)
    }
}

3. 代码说明

日志级别：定义了五种日志级别，方便区分日志的重要性。
日志格式：每条日志包含时间戳、日志级别和日志内容，格式为[时间戳] [日志级别] 日志内容。
日志存储：日志被写入到应用的Documents目录下的app.log文件中。使用FileHandle来高效地追加日志内容。
日志传输：提供了uploadLogFile方法，将日志文件上传到指定的服务器URL。
线程安全：使用DispatchQueue确保日志记录和文件上传操作是线程安全的。

4. 扩展和优化

日志滚动：可以扩展Logger类，支持按天或按文件大小滚动日志文件。
日志压缩：在上传日志文件之前，可以对日志文件进行压缩，减少传输的数据量。
日志加密：如果日志包含敏感信息，可以在上传之前对日志文件进行加密。
日志缓存：在网络不可用时，可以将日志缓存到本地，待网络恢复后再上传。

5. 使用示例

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        Logger.shared.log(.info, message: "Application started")
        Logger.shared.log(.debug, message: "Debugging some issue")
        Logger.shared.log(.error, message: "An error occurred")
    }
}

6. 总结

通过 FileHandle 实现日志系统，可以高效地管理日志文件的写入和滚动。以上代码提供了一个完整的实现，支持日志级别、文件滚动、旧日志清理等功能，适合在 iOS 应用中使用。

iOS全解13：日志收集、崩溃处理