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

前言

自從Xcode8之后, 再也不能像以前一樣愉快的使用插件了蒲凶。之前賴以生存Console插件XcodeColors 也隨之失效。我們再一次回到了原生只有黑白信息的Console上面逻锐。雖然可以用一些Formatting的Log來彌補禾蚕，但依舊不是很直觀访惜。

每一次當(dāng)測試機同事的手機器上有什么BUG需要查看日志的時候带射，可能還需要使用中間層代理來破解HTTPS查看請求咱圆，或者直接來找開發(fā)在Xcode里面查看Log盯孙。 過程還需要打包卦羡，查找噪馏，定位信息，繁瑣無比绿饵。

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

首先第一點刺桃，就是要抓取到所有的Log的同時還需要無任何的侵入性。 不可能因為這個需求把項目里面之前的各種Log重新寫一遍吸祟。

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

先看效果：

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

可行性調(diào)研

抓取所有LOG

第一步查看NSLog的描述葛碧，發(fā)現(xiàn)他其實是使用STDERR_FILENO的文件描述符(File Descriptor)來寫入的。若果你全局搜索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

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

方案二 重定向文件描述符

我們已經(jīng)知道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里面去呻纹，但是磁盤的讀寫監(jiān)聽成本太高了。具體可以看這位同學(xué)寫的DCLog专缠。

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

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

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

遠程Console與樣式

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

//XcodeConsole.html
    var ipAddress = getUrlParameter('ip'); //獲取模擬器或者真機的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

接下來就是簡單的把他們組合起來創(chuàng)建一個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

在開始與結(jié)束的時候分別重寫與重置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

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

//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)鍵字時，我們賦予字體與背景不同的顏色区端，然后添加到頁面的output元素中

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

后續(xù)

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

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

最后Github源碼

Reference：

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