iOS自定義log並寫入檔案

JmoVxia發表於2018-11-26
iOS

前言

iOS開發中，很多情況需要使用到log列印，本文主要講解如何將列印寫入檔案，並且不影響控制檯的正常列印。

常見方法

NSString *documentDirectory = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
NSDateFormatter *dateformat = [[NSDateFormatter  alloc]init];
[dateformat setDateFormat:@"yyyy-MM-dd-HH-mm-ss"];
NSString *fileName = [NSString stringWithFormat:@"LOG-%@.txt",[dateformat stringFromDate:[NSDate date]]];
NSString *logFilePath = [documentDirectory stringByAppendingPathComponent:fileName];
    // 先刪除已經存在的檔案
NSFileManager *defaultManager = [NSFileManager defaultManager];
[defaultManager removeItemAtPath:logFilePath error:nil];
    // 將log輸入到檔案
 freopen([logFilePath cStringUsingEncoding:NSASCIIStringEncoding], "a+", stdout);  
freopen([logFilePath cStringUsingEncoding:NSASCIIStringEncoding], "a+", stderr);
複製程式碼

這種寫法雖然可以將列印攔截寫入檔案，但是控制檯就沒有了列印，不方便除錯。

自定義方法

考慮到開發總需要檢視控制檯列印，實際應用中需要寫入多個檔案等情況，我們自定義一個列印類來寫日誌檔案。具體程式碼如下

static NSFileHandle *CLLogFileHandle()
{
    static NSFileHandle *fileHandle = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^
                  {
                      NSFileManager *fileManager = [[NSFileManager alloc] init];
                      
                      NSString *documentsDirectory = [Tools pathDocuments];
                      
                      NSString *currentFilePath = [documentsDirectory stringByAppendingPathComponent:@"application-0.log"];
                      NSString *oldestFilePath = [documentsDirectory stringByAppendingPathComponent:@"application-60.log"];
                      
                      //60檔案存在，刪除
                      if ([fileManager fileExistsAtPath:oldestFilePath]){
                          [fileManager removeItemAtPath:oldestFilePath error:nil];
                      }
                      //遍歷檔案，將檔案編號往後移動，新增第0的一個檔案
                      for (int i = 60 - 1; i >= 0; i--) {
                          NSString *filePath = [documentsDirectory stringByAppendingPathComponent:[NSString stringWithFormat:@"application-%d.log", i]];
                          NSString *nextFilePath = [documentsDirectory stringByAppendingPathComponent:[NSString stringWithFormat:@"application-%d.log", i + 1]];
                          if ([fileManager fileExistsAtPath:filePath])
                          {
                              [fileManager moveItemAtPath:filePath toPath:nextFilePath error:nil];
                          }
                      }
                      
                      [fileManager createFileAtPath:currentFilePath contents:nil attributes:nil];
                      fileHandle = [NSFileHandle fileHandleForWritingAtPath:currentFilePath];
                      [fileHandle truncateFileAtOffset:0];
                  });
    
    return fileHandle;
}

void CLLogWithFile(NSString *format, ...) {
    va_list L;
    va_start(L, format);
    NSString *message = [[NSString alloc] initWithFormat:format arguments:L];
    NSLog(@"%@", message);
    // 開啟非同步子執行緒，將列印寫入檔案
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        NSFileHandle *output = CLLogFileHandle();
        if (output != nil) {
            time_t rawtime;
            struct tm timeinfo;
            char buffer[64];
            time(&rawtime);
            localtime_r(&rawtime, &timeinfo);
            struct timeval curTime;
            gettimeofday(&curTime, NULL);
            int milliseconds = curTime.tv_usec / 1000;
            strftime(buffer, 64, "%Y-%m-%d %H:%M", &timeinfo);
            char fullBuffer[128] = { 0 };
            snprintf(fullBuffer, 128, "%s:%2d.%.3d ", buffer, timeinfo.tm_sec, milliseconds);
            [output writeData:[[[NSString alloc] initWithCString:fullBuffer encoding:NSASCIIStringEncoding] dataUsingEncoding:NSUTF8StringEncoding]];
            [output writeData:[message dataUsingEncoding:NSUTF8StringEncoding]];
            static NSData *returnData = nil;
            if (returnData == nil)
                returnData = [@"\n" dataUsingEncoding:NSUTF8StringEncoding];
            [output writeData:returnData];
        }
    });
    va_end(L);
}
複製程式碼

以上程式碼主要自定義了列印，並且自己管理了日誌檔案個數，不影響正常控制檯的列印。只是這些，可能還不夠，比如我們還想把當前程式碼所在的類檔案，方法名稱，行號等也都記錄到檔案中，又該怎麼辦呢？我們可以使用巨集定義，這樣就可以記錄到這些資訊了。

總結

以上是自定義記錄列印日誌，希望能夠給大家幫助，demo地址--->>CLDemo

相關文章