iOS - 原理探究之Log的重定向

Created by Shuimu

日志分级

分级定义：

Fatal 严重级别。

表明程序遇到了非常严重的错误，已经不能继续运行下去。

Error 出错级别。

程序可能正处于非正常状态下，无法正常完成既定功能，但程序依然能运行。

Warning 警告级别。

程序处理中遇到非法数据或者某种可能的错误，程序无法处理，但是依然能正常运行。

Info 重要信息级别。

一般用于打印模块中一些重要的点，以证明程序运行正常。

Debug 调试级别。

表明当前正在临时打印一些log，以便调试程序。

输出格式

[level] file function [line num] message

[level] file function [line num] message

[level] file function [line num] message

基本使用方法

像极了 NSLog

#define XXLogFatal(fmt, ...)   // 省略具体实现
#define XXLogError(fmt, ...)   // 省略具体实现
#define XXLogWarn(fmt, ...)    // 省略具体实现
#define XXLogInfo(fmt, ...)    // 省略具体实现
#define XXLogDebug(fmt, ...)   // 省略具体实现

#define XXLog XXLogDebug       // 等价于 Debug 级别（只是为了少打几个字母）

日志读取

简介

日常开发中，经常会用到NSLog进行调试，NSLog本质上是一个C函数，它的函数声明如下：

FOUNDATION_EXPORT void NSLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2) NS_NO_TAIL_CALL;

系统的说明是：Logs an error message to the Apple System Log facility.。

它是用来输出信息到标准Error控制台的，内部使用的是Apple System Log的API（相关API可以查看<asl.h>）。调试阶段，日志会输出到Xcode控制台中，真机调试时，则会输出到系统的/var/log/syslog这个文件中。

日志输出到文件中的句柄定义在unistd.h文件中

#define  STDIN_FILENO   0   /* standard input file descriptor */
#define STDOUT_FILENO   1   /* standard output file descriptor */
#define STDERR_FILENO   2   /* standard error file descriptor */

NSLog的日志是通过STDERR_FILENO输出到文件的。另外，fprintf并不会调用ASL接口，只是简单的输出信息（相对NSLog，少了日期、进程名、进程id等信息），其日志是通过STDOUT_FILENO输出到文件中。

ASL读取日志

鉴于以上信息，既然日志是写入到系统的syslog中，那么就可以直接读取这些日志。通过ASL的相关API，我们可以读取到这些日志内容。

不过，查看<asl.h>相关API可以发现，

__API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.4,10.12), ios(2.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0))

asl从iOS 10开始被弃用了，并提供了新的APIos_log进行替代的（详见<os/log.h>）

👿，系统版本限制，放弃。

NSLog重定向

通过前面的介绍可以了解到，NSLog输出的日志内容，最终都通过STDERR句柄来记录的，所以可以考虑对其进行重定向（当然，重定向之后，就无法在控制台看到log打印了）。

文件重定向

利用c语言的freopen函数进行重定向，将写往stderr的内容重定向到我们指定的文件中去。

函数声明：

FILE    *freopen(const char * __restrict, const char * __restrict, FILE * __restrict)

第一个参数：需要重定向到文件路径
第二个参数：文件的打开模式，r/w/a/+等
第三个参数：被打开的文件名，通常使用标准流文件（stdin/stdout/stderr）

核心代码：

    NSString *newLogFilePath = @"xxxxxx"; // 指定的写入文件路径
    freopen([newLogFilePath cStringUsingEncoding:NSASCIIStringEncoding], "a+", stderr); // stderr 标准错误输出流

由于iOS的沙盒机制，无法得知stderr原来的文件路径，导致freopen无法重定向回去。这里利用dup 和 dup2 来实现。

大致实现思路如下：

// 记录原来的输出流
int origin = dup(STDERR_FILENO);

// 利用freopen进行重定向
FILE *myFile = freopen([newLogFilePath cStringUsingEncoding:NSASCIIStringEncoding], "a+", stderr);

// 恢复重定向
dup2(origin, STDERR_FILENO)

dup2重定向

上面提到的dup2函数是专门进行文件重定向的。同样也可以直接通过dup2函数直接重定向STDERR句柄，将内容指向指定的位置。

思路：

首先通过NSPipe创建一个管道，pipe有读端和写端，通过dup2将标准输入重定向到pipe的写端，在通过NSFileHandle监听pipe的读端，再处理读出的信息。

核心代码如下：

- (void)redirectStandardOutput {
    // 记录标准输出及错误流原始文件描述符
    self.errFd = dup(STDERR_FILENO);
    stderr->_flags = 10;
    NSPipe *errPipe = [NSPipe pipe];
    NSFileHandle *pipeErrHandle = [errPipe fileHandleForReading];
    dup2([[errPipe fileHandleForWriting] fileDescriptor], STDERR_FILENO);
    [pipeErrHandle readInBackgroundAndNotify];
    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(redirectErrNotificationHandle:) name:NSFileHandleReadCompletionNotification object:pipeErrHandle];
    
}

- (void)recoverStandardOutput {
    dup2(self.errFd, STDERR_FILENO);
    [[NSNotificationCenter defaultCenter] removeObserver:self];
}

// 重定向之后的错误输出
- (void)redirectErrNotificationHandle:(NSNotification *)nf {
    NSData *data = [[nf userInfo] objectForKey:NSFileHandleNotificationDataItem];
    NSString *str = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
    
    // write your code. 保存日志、上传或展示等等
    
    
    [[nf object] readInBackgroundAndNotify];
}