iOS自定义log并写入文件

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);
}
复制代码

以上代码主要自定义了打印，并且自己管理了日志文件个数，不影响正常控制台的打印。只是这些，可能还不够，比如我们还想把当前代码所在的类文件，方法名称，行号等也都记录到文件中，又该怎么办呢？我们可以使用宏定义，这样就可以记录到这些信息了。