一個在 iOS 設備屏幕上實時打印 Log 的小工具

需求

寫這個小工具的想法,主要來源于很多團隊都會用友盟、TalkingData 等第三方框架做自定義事件統計;不過統計代碼加好之后,沒有很好的方法來讓測試工程師驗證一下事件加上了沒有,調用次數有沒有重復等。

所以寫了這個小工具,是一個保持在最前的 UIWindow,可以實時打印 log。

demo

源碼地址

源碼是用 Objective-C 寫的,放在 github 上了。

用法

集成

只需把 HAMLogOutputWindow.hHAMLogOutputWindow.m 兩個文件加到工程中。如果您使用友盟或者 TalkingData 做事件統計,也可以加進來 demo 工程中的 HAMStatisticsManager.hHAMStatisticsManager.m

開啟

啟用這個 debug 窗口非常簡單,只需一行代碼:

[[HAMLogOutputWindow sharedInstance] setHidden:NO];

您可以把這行代碼加到 AppDelegate.m 里,例如:

#define SHOW_STATISTICS_DEBUG 1

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
#if DEBUG && SHOW_STATISTICS_DEBUG
    [[HAMLogOutputWindow sharedInstance] setHidden:NO];
#endif
    
    return YES;
}

不需顯示 時把 define 的1改為0即可,也保證了在 release 版本中不會出現。

輸出和清空 log

輸出 log:

[HAMLogOutputWindow printLog:@"some log"];

輸出的 log 會滾動顯示在 debug 窗口中,末尾會自動添加換行。最新的 log(0.1s 之內)會顯示為黃色,之前的會顯示為白色。

如需清空 log,只需調用:

[HAMLogOutputWindow clear];

源碼解釋

HAMLog

用來存儲 log 信息的 model 類。有兩個屬性,時間戳和具體的 log 內容。

HAMLogOutputWindow

是一個單例的 Window,里面有一個 UITextView 用來顯示 log。windowLevel 設為 UIWindowLevelAlert 所以能保持在最前。userInteractionEnabled 設為 NO,這樣屏幕觸摸事件會傳遞到下層的實際 view 上去,不會擋住測試的操作。

打印 log 的時候,建立一條 log 對象存進 logs 數組里。logs 數組實際是個隊列,超出 20 條之后就會拋棄最舊的一條。之后調用 refreshLogDisplay 刷新 log 的顯示。

refreshLogDisplay 這個方法中,首先根據 logs 數組構造一個 attributedString。其中時間戳與當前時間相差 0.1s 以內的,顯示為黃色,否則顯示為白色。這樣就能在視覺上把前后關聯比較緊密的 log 同時高亮,比如點擊 tab 和相應 viewController 的 viewWillAppear 兩個統計事件。

最后用以下代碼讓顯示 log 的 UITextView 滾動到底部。

NSRange bottom = NSMakeRange(attributedString.length - 1, 1);
[self.textView scrollRangeToVisible:bottom];

代碼非常簡單,在此基礎上可以根據自己項目的需求進行改造。拿去用吧~

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,748評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,165評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,595評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,633評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,435評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,943評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,035評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,175評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,713評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,599評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,788評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,303評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,034評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,412評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,664評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,408評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,747評論 2 370

推薦閱讀更多精彩內容