iOS 日誌重定向和異常捕獲

劉小蠻發表於2017-04-25
iOS

在日常的工作中，日誌是不可缺少的一個環節，平時自己除錯的時候，可以直接連線電腦，直接在視窗中檢視結果。

但是在測試人員測試，或者灰度測試的時候，怎麼才能拿到日誌呢？最先想到的肯定是輸出到本地檔案，然後在需要的時候進行上傳。

分享一段之前找到的方法，下面的程式碼提供了兩個主要功能：

  • 把日誌輸出到檔案中
  • 捕捉異常資訊

【解析都寫在註釋中了】


- (void)redirectNSLogToDocumentFolder
{
//如果已經連線Xcode除錯則不輸出到檔案
//該函式用於檢測輸出 (STDOUT_FILENO) 是否重定向  是個 Linux 程式方法
if(isatty(STDOUT_FILENO)) {  
    return;
}

// 判斷 當前是否在 模擬器環境 下 在模擬器不儲存到檔案中
UIDevice *device = [UIDevice currentDevice];
if([[device model] hasSuffix:@"Simulator"]){ 
    return;
}

//將NSlog列印資訊儲存到Document目錄下的Log資料夾下
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
NSString *logDirectory = [[paths objectAtIndex:0] stringByAppendingPathComponent:@"Log"];

NSFileManager *fileManager = [NSFileManager defaultManager];
BOOL fileExists = [fileManager fileExistsAtPath:logDirectory];
if (!fileExists) {
[fileManager createDirectoryAtPath:logDirectory withIntermediateDirectories:YES attributes:nil error:nil];
}

NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
[formatter setLocale:[[NSLocale alloc] initWithLocaleIdentifier:@"zh_CN"]];
[formatter setDateFormat:@"yyyy-MM-dd HH:mm:ss"]; //每次啟動後都儲存一個新的日誌檔案中
NSString *dateStr = [formatter stringFromDate:[NSDate date]];
NSString *logFilePath = [logDirectory stringByAppendingFormat:@"/%@.log",dateStr];

// 將log輸入到檔案
freopen([logFilePath cStringUsingEncoding:NSUTF8StringEncoding], "a+", stdout);
freopen([logFilePath cStringUsingEncoding:NSUTF8StringEncoding], "a+", stderr);

//未捕獲的Objective-C異常日誌
NSSetUncaughtExceptionHandler (&UncaughtExceptionHandler);
}複製程式碼

之前看的時候，對 NSSetUncaughtExceptionHandler(&UncaughtExceptionHandler) 這個用法一知半解，去翻了一下原始碼，這個方法是在 Foundation 中。

api 中的定義是Changes the top-level error handler ,Sets the top-level error-handling function where you can perform last-minute logging before the program terminates. 通過替換掉最高階別的 handle 方法，可以在程式終止之前可以獲取到崩潰資訊，並執行相應的操作，比如儲存本地，或者上報。

方法呼叫為：
void NSSetUncaughtExceptionHandler(NSUncaughtExceptionHandler *);

傳入的是一個 NSUncaughtExceptionHandler 的指標。

typedef void NSUncaughtExceptionHandler(NSException *exception);

意思就是需要一個 返回 void 並且引數為 NSException *exception 的函式指標。

你想要，那我就給你！

所以下面有個 C 語言的函式，你看這個寫法和 OC 的宣告也不一樣。

void UncaughtExceptionHandler(NSException* exception)
{
    NSString* name = [ exception name ];
    NSString* reason = [ exception reason ];
    NSArray* symbols = [ exception callStackSymbols ]; // 異常發生時的呼叫棧
    NSMutableString* strSymbols = [ [ NSMutableString alloc ] init ]; //將呼叫棧拼成輸出日誌的字串
    for ( NSString* item in symbols )
    {
        [ strSymbols appendString: item ];
        [ strSymbols appendString: @"\r\n" ];
    }

    //將crash日誌儲存到Document目錄下的Log資料夾下
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    NSString *logDirectory = [[paths objectAtIndex:0] stringByAppendingPathComponent:@"Log"];

    NSFileManager *fileManager = [NSFileManager defaultManager];
    if (![fileManager fileExistsAtPath:logDirectory]) {
        [fileManager createDirectoryAtPath:logDirectory  withIntermediateDirectories:YES attributes:nil error:nil];
    }

    NSString *logFilePath = [logDirectory stringByAppendingPathComponent:@"UncaughtException.log"];
    NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
    [formatter setLocale:[[NSLocale alloc] initWithLocaleIdentifier:@"zh_CN"]];
    [formatter setDateFormat:@"yyyy-MM-dd HH:mm:ss"];
    NSString *dateStr = [formatter stringFromDate:[NSDate date]];

    NSString *crashString = [NSString stringWithFormat:@"<- %@ ->[ Uncaught Exception ]\r\nName: %@, Reason: %@\r\n[ Fe Symbols Start ]\r\n%@[ Fe Symbols End ]\r\n\r\n", dateStr, name, reason, strSymbols];
    //把錯誤日誌寫到檔案中
    if (![fileManager fileExistsAtPath:logFilePath]) {
        [crashString writeToFile:logFilePath atomically:YES encoding:NSUTF8StringEncoding error:nil];
    }else{
        NSFileHandle *outFile = [NSFileHandle fileHandleForWritingAtPath:logFilePath];
        [outFile seekToEndOfFile];
        [outFile writeData:[crashString dataUsingEncoding:NSUTF8StringEncoding]];
        [outFile closeFile];
    }

    //把錯誤日誌傳送到郵箱
    //    NSString *urlStr = [NSString stringWithFormat:@"mailto://XXXXX@126.com?subject=bug報告&body=感謝您的配合!<br><br><br>錯誤詳情:<br>%@",crashString ];
    //    NSURL *url = [NSURL URLWithString:[urlStr stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]];
    //    [[UIApplication sharedApplication] openURL:url];
}複製程式碼

相關文章