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

前言

自從Xcode8之后, 再也不能像以前一樣愉快的使用插件了。之前賴以生存Console插件XcodeColors 也隨之失效。我們?cè)僖淮位氐搅嗽挥泻诎仔畔⒌腃onsole上面。雖然可以用一些Formatting的Log來(lái)彌補(bǔ)，但依舊不是很直觀。

每一次當(dāng)測(cè)試機(jī)同事的手機(jī)器上有什么BUG需要查看日志的時(shí)候，可能還需要使用中間層代理來(lái)破解HTTPS查看請(qǐng)求，或者直接來(lái)找開(kāi)發(fā)在Xcode里面查看Log。 過(guò)程還需要打包，查找，定位信息，繁瑣無(wú)比。

作為一個(gè)攻城獅，完全不能忍。于是乎，一個(gè)遠(yuǎn)程查看Log與自定義的展現(xiàn)形式的Console的需求孕育而生:

首先第一點(diǎn)，就是要抓取到所有的Log的同時(shí)還需要無(wú)任何的侵入性。 不可能因?yàn)檫@個(gè)需求把項(xiàng)目里面之前的各種Log重新寫(xiě)一遍。

其次第二點(diǎn)，就是我們的Console的展現(xiàn)要我們可以自己根據(jù)自己的需求來(lái)定義Console。并且可以遠(yuǎn)程查看。

先看效果：

著急看的同學(xué)可以直接下Github源碼

可行性調(diào)研

抓取所有LOG

第一步查看NSLog的描述，發(fā)現(xiàn)他其實(shí)是使用STDERR_FILENO的文件描述符(File Descriptor)來(lái)寫(xiě)入的。若果你全局搜索STDERR_FILENO，iOS下面已經(jīng)定義好的文件描述符：

 #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

蘋(píng)果已經(jīng)提供了讀取Log的ALS API,在asl.h頭文件里面，而且在StackOverFlow里面其實(shí)已經(jīng)有人提過(guò)相應(yīng)的問(wèn)題并且貼出了代碼. 可以通過(guò)asl_search并設(shè)置參數(shù)來(lái)查詢你想要的東西。
但是在iOS10下 ALS被棄用了，使用新的OS.LOG系統(tǒng)。而新系統(tǒng)還沒(méi)有API對(duì)應(yīng)原來(lái)的asl_search(WWDC2016-Session721)，所以他們只能被使用在iOS10之前的系統(tǒng)。

方案二 重定向文件描述符

我們已經(jīng)知道Log是寫(xiě)在STDERR_FILENO的文件描述符里面的， 那么我們可以再重新定向這個(gè)文件文件描述符到別的描述符里面，比如寫(xiě)到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

其實(shí)也可以寫(xiě)到File里面去，但是磁盤(pán)的讀寫(xiě)監(jiān)聽(tīng)成本太高了。具體可以看這位同學(xué)寫(xiě)的DCLog。

使用NSPipe配合Dispatch我們可以很輕易監(jiān)聽(tīng)Pipe的read end事件：

    int readEnd = fildes[0];
    int writeEnd = fildes[1];
    
    //定義監(jiān)聽(tīng)事件參數(shù)與線程
    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, ^{
        ///取消時(shí)，回復(fù)原來(lái)的文件描述符
    });
    dispatch_source_set_event_handler(source, ^{
        ///有新的readEnd 監(jiān)聽(tīng)獲取內(nèi)容
    }）
}

到這里我們就可以無(wú)痛的抓取到所有的Log了，并且獲得與Console一樣的實(shí)時(shí)更新信的回掉

遠(yuǎn)程Console與樣式

既然Xcode不能實(shí)現(xiàn)遠(yuǎn)程的Console與展現(xiàn)形式的自定義，那么我們?yōu)槭裁床粨Q個(gè)地方呢？第一個(gè)想到的就是網(wǎng)頁(yè)。我們可以在本地或者遠(yuǎn)程創(chuàng)建一個(gè)簡(jiǎn)單的HTML5靜態(tài)頁(yè)面。在程序內(nèi)置一個(gè)小的WebSocket的服務(wù)器，用設(shè)備的ip做為連接標(biāo)識(shí)。在獲取監(jiān)聽(tīng)Log的回掉里向HTML5發(fā)送內(nèi)容。 而展現(xiàn)形式由HTML5自己去定義。

//XcodeConsole.html
    var ipAddress = getUrlParameter('ip'); //獲取模擬器或者真機(jī)的ip地址
    var wsUri ="ws://" + ipAddress + ":8081"; //拼接uri與端口 模擬器應(yīng)該是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

接下來(lái)就是簡(jiǎn)單的把他們組合起來(lái)創(chuàng)建一個(gè)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

在開(kāi)始與結(jié)束的時(shí)候分別重寫(xiě)與重置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;
}

然后在適時(shí)的時(shí)候開(kāi)啟server即可。這樣手機(jī)端就完成了，接下來(lái)就是遠(yuǎn)程的Console

XcodeConsole.html

之前我們已經(jīng)獲取了IP，并且建立了Socket的連接了，并且可以接受到數(shù)據(jù)。接下來(lái)就是我們要如何展示了：

//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();

    }  

當(dāng)我們的log里面包含了不同的關(guān)鍵字時(shí)，我們賦予字體與背景不同的顏色，然后添加到頁(yè)面的output元素中

現(xiàn)在你就只需要把這個(gè)文件放入瀏覽器里面然后跟上你想要的ip參數(shù)就可以訪問(wèn)了/XcodeConsole.html?ip=0.0.0.0

后續(xù)

到這里一個(gè)遠(yuǎn)程的Console Log就完成了。你所需要的就是修改ip所跟隨的設(shè)備地址。模擬器為0:0:0:0,真機(jī)可以去WIFI里面查看設(shè)比地址。
下一步可以把這個(gè)靜態(tài)頁(yè)面布置在測(cè)試服務(wù)器的內(nèi)網(wǎng)上， 讓所有人在內(nèi)網(wǎng)都可以訪問(wèn)。再也不需要設(shè)置代理，或者xCode特意去查看了。

我把這個(gè)靜態(tài)頁(yè)面放在了http://dev.hyyy.me/iOS/Console?ip=xxx 下不過(guò)端口是在9001.需要的同學(xué)可以自行修改端口。

最后Github源碼

Reference：

• WWDC2016-Session721
  
• dup&dup2
  
• Dari在杭州
  
• Stack Overflow
  
• yohunl's
  
• PocketSocket