:## 為什么
為什么要尋找單獨(dú)的logger庫?用Andorid原生的Log不好嗎?原生Log長得這樣:
先分級(jí),再打上TAG,然后直接輸出驹针。功能很基礎(chǔ),平時(shí)基本夠用诀艰。但是在長期的Android開發(fā)實(shí)踐中柬甥,我們會(huì)發(fā)現(xiàn),這個(gè)功能太基礎(chǔ)了涡驮,當(dāng):
- 每次打TAG都要寫下雷同的代碼暗甥,太不DRY了。
- 想打印的數(shù)據(jù)各種打不出捉捅,要么就是打出來一長串看的發(fā)暈撤防。
- 為了找某條log是從哪里打出來的,還要花點(diǎn)功夫棒口。
- 即使找到了寄月,怎么知道運(yùn)行時(shí)是在哪個(gè)線程?
- 日志去了不再來无牵。在未連接調(diào)試的手機(jī)上漾肮,或者調(diào)試中不小心重啟App了,日志就沒了茎毁。
不多說了克懊,光這幾個(gè)問題就夠我們有充分的理由去尋找一個(gè)新的Log系統(tǒng)了。先從最常用的下手七蜘,從網(wǎng)上能搜到最常用的Android logger有兩個(gè)谭溉。
- https://github.com/orhanobut/logger :簡(jiǎn)單、漂亮橡卤、強(qiáng)大的Android logger扮念,github上3000+ Star
- https://github.com/JakeWharton/timber :基于Android原生Log的logger,小巧易擴(kuò)展碧库。
看簡(jiǎn)介幫助不大柜与,我們還是真刀真槍用一下,看看這兩個(gè)開源庫為什么這么受歡迎嵌灰,有沒有解決我們的問題弄匕。
好Logger應(yīng)該長什么樣?
動(dòng)手分析之前沽瞭,我們要先想想清楚粘茄,我們要的好Logger,應(yīng)該是什么樣的秕脓?
打印日志是一門傳統(tǒng)藝術(shù)柒瓣,歷史悠久,打從有編程那年就開始有了吠架。它與單步調(diào)試并稱程序調(diào)試兩大神技芙贫,程序員們因?yàn)閾碜o(hù)不同的調(diào)試方法,分裂成了兩大陣營:日志派和調(diào)試派傍药,兩派互相看不起磺平。調(diào)試派說打印日志太沒技術(shù)含量,還要到處做標(biāo)記拐辽,看我們調(diào)試派拣挪,想停哪里點(diǎn)哪里,想看什么看什么俱诸,調(diào)試器能帶我飛菠劝。日志派也不服氣,你能離線調(diào)試嗎睁搭?你能調(diào)試多線程錯(cuò)誤嗎赶诊?你能xxx調(diào)試嗎?
好程序員兩種技能都要掌握园骆,現(xiàn)在調(diào)試工具越來越好用舔痪,單步調(diào)試沒有任何困難。但是打印日志仍然是不可或缺的必殺技锌唾,尤其是查活系統(tǒng)(運(yùn)行中軟件)的問題時(shí)锄码,如果沒有后臺(tái)日志或者用戶手機(jī)日志,真是打死也不知道哪里出了問題晌涕。
扯完日志的重要性滋捶,認(rèn)真說說我們對(duì)日志系統(tǒng)的需求:
- 容易打印:無論什么格式的數(shù)據(jù)渐排,上到自定義類炬太,下到字節(jié)流,都能單行代碼給打出來驯耻,不用為了打日志寫一堆額外的代碼邏輯亲族。
- 格式漂亮:對(duì)格式化數(shù)據(jù)做打印美化,必要時(shí)適當(dāng)做點(diǎn)排版可缚。
- 容易篩選:給日志分級(jí)和打標(biāo)簽霎迫,就是為了達(dá)到這個(gè)目的。
- 立即定位:每條日志都有兩個(gè)位置帘靡,代碼中的位置和運(yùn)行時(shí)位置(所在線程)知给。這兩個(gè)位置對(duì)快速定位問題很重要。
- 靈活設(shè)置:日志數(shù)量和日志詳細(xì)程度是一對(duì)矛盾體。大多數(shù)情況下涩赢,普通的日志就夠我們分析問題了戈次。但是某些情況下,如多線程問題筒扒,異步問題怯邪,需要打印盡量詳細(xì)的信息,這個(gè)要能靈活設(shè)置花墩。
- 日志留存:日志打到屏幕上悬秉,說沒就沒。有沒有辦法屏幕上打一份冰蘑,SD卡上存一份和泌,崩潰信息網(wǎng)站上留一份?這有點(diǎn)類似linux上的tee命令祠肥。
- 容易上手:本來沒想寫這條武氓,也沒想到上面會(huì)列出這么多特性,沒辦法搪柑,還是加上個(gè)容易上手的指標(biāo)吧聋丝。就是說上邊這些特性,
能做到上面幾點(diǎn)工碾,我們就認(rèn)為這個(gè)日志系統(tǒng)非常好了弱睦。注意,我為什么沒提性能要求渊额?因?yàn)檎桨l(fā)布版本里况木,是不會(huì)有日志的,起碼不會(huì)大量存在旬迹,所以性能也就無所謂了火惊,別太差就行。尺子有了奔垦,我們就用它來衡量一下Timber和Logger屹耐。
Logger分析
這個(gè)項(xiàng)目在github上有3000+ star,必有過人之處椿猎。
- 容易打踊塘搿:除了普通字符串和含變量字符串,還能直接打印json犯眠、xml按灶、異常,通過筐咧。
- 格式漂亮:的確漂亮鸯旁,但是過分漂亮了噪矛。本來一行的日志給打成了8行,真超值铺罢。結(jié)果贈(zèng)品太多艇挨,都找不到我想看的那條了。
- 容易篩選:能分級(jí)畏铆,能自動(dòng)打tag雷袋,能自定義tag。等等辞居,為什么tag不是類名?難道用類名當(dāng)tag不是普世價(jià)值觀嗎蛋勺?明白了瓦灶,它的類名和方法名都在日志內(nèi)容中有了,tag中不用再放一個(gè)了抱完。但是有Android Monitor依賴癥的我表示贼陶,這讓我怎么篩選一眼望不到頭的日志呀,差評(píng)巧娱。
- 立即定位:能跳轉(zhuǎn)到文件位置碉怔,能看函數(shù)名、線程號(hào)禁添,通過撮胧。
- 靈活設(shè)置:可以設(shè)置,但是設(shè)置項(xiàng)似乎不太豐富呀老翘。
- 日志留存:不支持芹啥。
- 容易上手:一行代碼就能用,通過铺峭。
Timber分析
這個(gè)庫非常簡(jiǎn)潔墓怀,準(zhǔn)確講,它只有一個(gè)文件卫键,是Jake Wharton大神自己用的傀履。大神說嫌拷貝來拷貝去太麻煩,才開源成一個(gè)庫莉炉。
- 容易打拥稣恕:支持普通字符串和含變量字符串。
- 格式漂亮:不支持呢袱。
- 容易篩選:自動(dòng)用類名當(dāng)tag官扣,也可以自定義。
- 立即定位:不支持羞福。
- 靈活設(shè)置:支持惕蹄,但沒什么設(shè)置項(xiàng)。
- 日志留存:支持。
- 容易上手:還是吐槽一下卖陵,這個(gè)庫的tree和plant是什么鬼遭顶?我是讀完它的代碼才明白的。其實(shí)跟樹泪蔫、種樹棒旗、木頭沒一毛錢關(guān)系,大神只是借種樹這個(gè)形象的方法撩荣,說日志可以寫到各種地方去铣揉。想寫哪里寫哪里,自己plant一個(gè)自己實(shí)現(xiàn)的Tree就可以了餐曹。不種樹就沒有日志逛拱。大神太幽默了。
總結(jié)
從總評(píng)價(jià)看台猴,顯然Logger更好朽合,特性更豐富。但是它的排版我實(shí)在接受不了饱狂。所以項(xiàng)目實(shí)踐中曹步,我還是會(huì)用Timber。全劇終休讳。
我去讲婚,這個(gè)結(jié)局太不能讓人滿意了,選了半天選了個(gè)不好用的衍腥,這世界怎么了磺樱?
改進(jìn)
權(quán)衡之下,還是改造一下Logger吧婆咸。在github上fork了Logger的代碼竹捉,針對(duì)Logger不滿的地方,加入我的改動(dòng)尚骄。為了保持Logger自身的特點(diǎn)块差,新改動(dòng)通過Settings的形式加入,我給Settings加入mode設(shè)置倔丈。默認(rèn)是pretty模式憨闰,一切用法與輸出結(jié)果與原Logger保持一致,可以通過單元測(cè)試需五。如果對(duì)PRETTY模式下日志過多有意見鹉动,可以啟用brief模式,去除無用的分割線宏邮,把默認(rèn)日志從8行減為4行泽示,保持可讀性和所有信息缸血。如果還嫌多,可以啟動(dòng)single模式械筛,默認(rèn)日志從8行壓縮到1行捎泻,保持必要信息。代碼庫見https://github.com/oreofish/logger
對(duì)這個(gè)改進(jìn)的版本重新評(píng)估如下:
- 容易打勇裼础:同原作笆豁。
- 格式漂亮:可以方便的在8行的pretty模式,和4行的簡(jiǎn)潔模式赤赊,和1行的單行模式中切換闯狱。
- 容易篩選:能分級(jí),能自動(dòng)打tag砍鸠,能自定義tag扩氢。單行模式下用Android Monitor過濾日志很方便。通過爷辱。
- 立即定位:同原作,而且重點(diǎn)保持了"能跳轉(zhuǎn)到文件位置"這個(gè)特性朦肘,通過饭弓。
- 靈活設(shè)置:可以設(shè)置。
- 日志留存:暫不支持(我很喜歡這個(gè)特性媒抠,有空要加上)弟断。
- 容易上手:一行代碼就能用,通過趴生。
- 彩蛋:寫代碼時(shí)經(jīng)常會(huì)加上一些臨時(shí)的日志阀趴,例如一大串相同的字符,只是為了在日志堆里容易看到苍匆。改進(jìn)版本中加入了預(yù)定義的表情字符串IAMHERE1到IAMHERE6刘急,就是為了容易看到。
開源大法好浸踩。這叔汁,就是我想要的日志系統(tǒng)。我會(huì)嘗試提交代碼給Logger官方检碗,雖然由于思路不同据块,他們可能不會(huì)合并我的代碼:)
結(jié)論
- 如果對(duì)日志要求不高,簡(jiǎn)單用用而已折剃,Android自帶的Log就不錯(cuò)另假。
- 如果厭煩了Android Log,覺得用著不方便怕犁,Timber和Logger都是好選擇边篮,Timber只要一個(gè)文件己莺。
- 如果你覺得日志很重要,特別推薦的我的改進(jìn)版Logger苟耻。
- 還覺得不好篇恒?把你的需求說出來,或者自己動(dòng)手改進(jìn)凶杖,都?xì)g迎胁艰。