重定义你的XCode Console

"iOS10 XCode8 Console Color Log 重定向Log"
author: yuan

前言


自从Xcode8之后, 再也不能像以前一样愉快的使用插件了。之前赖以生存Console插件XcodeColors 也随之失效。我们再一次回到了原生只有黑白信息的Console上面。虽然可以用一些Formatting的Log来弥补,但依旧不是很直观。

每一次当测试机同事的手机器上有什么BUG需要查看日志的时候,可能还需要使用中间层代理来破解HTTPS查看请求,或者直接来找开发在Xcode里面查看Log。 过程还需要打包,查找,定位信息,繁琐无比。

作为一个攻城狮,完全不能忍。于是乎,一个远程查看Log与自定义的展现形式的Console的需求孕育而生:

首先第一点,就是要抓取到所有的Log的同时还需要无任何的侵入性。 不可能因为这个需求把项目里面之前的各种Log重新写一遍。

其次第二点,就是我们的Console的展现要我们可以自己根据自己的需求来定义Console。并且可以远程查看。

先看效果:

着急看的同学可以直接下Github源码

可行性调研


抓取所有LOG

第一步查看NSLog的描述,发现他其实是使用STDERR_FILENO的文件描述符(File Descriptor)来写入的。若果你全局搜索STDERR_FILENO,iOS下面已经定义好的文件描述符:

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

方案一 ALS 读取Log

苹果已经提供了读取Log的ALS API,在asl.h头文件里面,而且在StackOverFlow里面其实已经有人提过相应的问题并且贴出了代码. 可以通过asl_search并设置参数来查询你想要的东西。
但是在iOS10下 ALS被弃用了,使用新的OS.LOG系统。而新系统还没有API对应原来的asl_search(WWDC2016-Session721),所以他们只能被使用在iOS10之前的系统。

方案二 重定向文件描述符

我们已经知道Log是写在STDERR_FILENO的文件描述符里面的, 那么我们可以再重新定向这个文件文件描述符到别的描述符里面,比如写到NSPipe中去:

int fildes[2];
pipe(fildes);  // [0] is read end of pipe while [1] is write end
dup2(fildes[1], STDERR_FILENO);  // Duplicate write end of pipe "onto" fd (this closes fd)
close(fildes[1]);  // Close original write end of pipe
fd = fildes[0];  // We can now monitor the read end of the pipe

其实也可以写到File里面去,但是磁盘的读写监听成本太高了。具体可以看这位同学写的DCLog

使用NSPipe配合Dispatch我们可以很轻易监听Pipe的read end事件:

    int readEnd = fildes[0];
    int writeEnd = fildes[1];
    
    //定义监听事件参数与线程
    dispatch_source_t source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, readEnd, 0, dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0));
    
    dispatch_source_set_cancel_handler(source, ^{
        ///取消时,回复原来的文件描述符
    });
    dispatch_source_set_event_handler(source, ^{
        ///有新的readEnd 监听获取内容
    })
}

到这里我们就可以无痛的抓取到所有的Log了,并且获得与Console一样的实时更新信的回掉

远程Console与样式

既然Xcode不能实现远程的Console与展现形式的自定义,那么我们为什么不换个地方呢?第一个想到的就是网页。我们可以在本地或者远程创建一个简单的HTML5静态页面。在程序内置一个小的WebSocket的服务器,用设备的ip做为连接标识。在获取监听Log的回掉里向HTML5发送内容。 而展现形式由HTML5自己去定义。

//XcodeConsole.html
    var ipAddress = getUrlParameter('ip'); //获取模拟器或者真机的ip地址
    var wsUri ="ws://" + ipAddress + ":8081"; //拼接uri与端口 模拟器应该是ip=0:0:0:0
    //绑定webSocket端口
    function testWebSocket() {
        var websocket = new WebSocket(wsUri); 
        websocket.onopen = function(evt) { 
            onOpen(evt) 
        }; 
        websocket.onclose = function(evt) { 
            onClose(evt) 
        }; 
        websocket.onmessage = function(evt) { 
            onMessage(evt) 
        }; 
        websocket.onerror = function(evt) { 
            onError(evt) 
        }; 
    }  
    function onOpen(evt) { 
        writeToScreen("CONNECTED"); 
    }  
 
    function onClose(evt) { 
        writeToScreen("DISCONNECTED"); 
    }  
 
    function onMessage(evt) { 
        writeToScreen(evt.data); 
    }  

RemoteConsole


接下来就是简单的把他们组合起来创建一个RemoteConsole,

#import "RemoteConsole.h"
#import "PSWebSocketServer.h"
@interface RemoteConsole () <PSWebSocketServerDelegate>

@property (nonatomic, strong) PSWebSocketServer *server;//tiny webSocketServer
@property (nonatomic, strong, nullable)PSWebSocket * webSocket;//the webSocket

@property (nonatomic,assign) int originalStdHandle;//original file descriptor

@property (nonatomic,strong) dispatch_source_t sourt_t;//file descriptor mointor

@end

在开始与结束的时候分别重写与重置STDERR_FILENO的文件描述符

#pragma mark - PSWebSocketServerDelegate
_server = [PSWebSocketServer serverWithHost:nil port:8080];//指定端口为8080
_server.delegate = self;

- (void)serverDidStart:(PSWebSocketServer *)server {
    NSLog(@"Server did start…");
    if (_sourt_t) {
        dispatch_cancel(_sourt_t);
    }
    _sourt_t = [self startCapturingLogFrom:STDERR_FILENO];
}
- (void)serverDidStop:(PSWebSocketServer *)server {
    NSLog(@"Server did stop…");
    dispatch_cancel(_sourt_t);
}

抓取Log与重置Log

- (dispatch_source_t)startCapturingLogFrom:(int)fd  {
    int origianlFD = fd;
    _originalStdHandle = dup(fd);//save the original for reset proporse
    int fildes[2];
    pipe(fildes);  // [0] is read end of pipe while [1] is write end
    dup2(fildes[1], fd);  // Duplicate write end of pipe "onto" fd (this closes fd)
    close(fildes[1]);  // Close original write end of pipe
    fd = fildes[0];  // We can now monitor the read end of the pipe
    
    NSMutableData* data = [[NSMutableData alloc] init];
    fcntl(fd, F_SETFL, O_NONBLOCK);// set the reading of this file descriptor without delay
    __weak typeof(self) wkSelf = self;
    dispatch_source_t source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, fd, 0, dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0));
    
    int writeEnd = fildes[1];
    dispatch_source_set_cancel_handler(source, ^{
        close(writeEnd);
        if (wkSelf) {
            dup2(wkSelf.originalStdHandle, origianlFD);//reset the original file descriptor
        }
    });
    
    dispatch_source_set_event_handler(source, ^{
        @autoreleasepool {
            char buffer[1024 * 10];
            ssize_t size = read(fd, (void*)buffer, (size_t)(sizeof(buffer)));
            [data setLength:0];
            [data appendBytes:buffer length:size];
            NSString *aString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
            [wkSelf.webSocket send:aString];
            printf("\n%s\n",[aString UTF8String]); //print on STDOUT_FILENO,so that logs can show on xcode console as well
        }
    });
    dispatch_resume(source);
    return source;
}

然后在适时的时候开启server即可。这样手机端就完成了,接下来就是远程的Console

XcodeConsole.html

之前我们已经获取了IP,并且建立了Socket的连接了,并且可以接受到数据。接下来就是我们要如何展示了:

//XcodeConsole.html
function writeToScreen(message) { 
      var tr = document.createElement('tr');   
      var pre = document.createElement('pre');
      var td1 = document.createElement('td');
      var text1 = document.createTextNode(message);
      pre.appendChild(text1)
      td1.appendChild(pre);
      tr.appendChild(td1);

      var lowerM = message.toLowerCase()
      if (lowerM.indexOf("code = 0") >= 0 || lowerM.indexOf("error") >= 0 ||  lowerM.indexOf("exception") >= 0) {
        tr.style.background = "#E97E60"
      } else if (lowerM.indexOf("warning") >= 0) {
        tr.style.background = "#FACC9A"
      } else if (lowerM.indexOf("-- response") >= 0) {
        tr.style.color = "#5BBB7B"
      }
      
      output.appendChild(tr);
      footerElement.scrollIntoView(false);
      updateTimestamp();

    }  

当我们的log里面包含了不同的关键字时,我们赋予字体与背景不同的颜色,然后添加到页面的output元素中

现在你就只需要把这个文件放入浏览器里面然后跟上你想要的ip参数就可以访问了/XcodeConsole.html?ip=0.0.0.0

后续


到这里一个远程的Console Log就完成了。你所需要的就是修改ip所跟随的设备地址。模拟器为0:0:0:0,真机可以去WIFI里面查看设比地址。
下一步可以把这个静态页面布置在测试服务器的内网上, 让所有人在内网都可以访问。再也不需要设置代理,或者xCode特意去查看了。

我把这个静态页面放在了http://dev.hyyy.me/iOS/Console?ip=xxx 下不过端口是在9001.需要的同学可以自行修改端口。

最后Github源码

Reference:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容