如何調(diào)試Android Framework?
Linus有一句名言廣為人知:Read the fucking source code. 但其實,要深入理解某個軟件、框架或者系統(tǒng)的工作原理,僅僅「看」代碼是遠遠不夠的。就拿Android Framework來說,整個代碼量非常大不說,那些個動輒幾萬行的類如何去理解?所以我今天要說的就是:
Debug the fucking source code!!
之前分享過一個答案:大家遇到過什么 Android 兼容性問題?,這里面的有一些非常詭異的問題,我相信光靠看代碼你是永遠定位不出來的。還有我寫的一系列Android插件框架原理的文章,這里面涉及到大量Android Framework層的知識,有小伙伴會問,這些Framework層的原理,你是如何學習的呢,有訣竅嗎?有!那就是調(diào)試。
Debug是一項非常非常重要的技能,毋庸多言。今天我就給大家分享一下「調(diào)試Android Framework」的經(jīng)驗,一旦掌握這項技能,那么Java層的任何問題都攔不住你了。
概覽
其實整個調(diào)試過程非常簡單:
- 在你要調(diào)試進程的合適位置打上斷點
- 跟蹤代碼(Step in/out/over等等)
在展開講述這兩方面之前,有必要先簡單了解下調(diào)試的基礎知識。Java平臺的調(diào)試是有一個規(guī)范化的標準的,那就是JPDA(Java Platform Debugger Architecture);通過 JPDA 提供的 API,開發(fā)人員可以方便靈活的搭建 Java 調(diào)試應用程序。 JPDA 主要由三個部分組成:Java 虛擬機工具接口(JVMTI),Java 調(diào)試線協(xié)議(JDWP),以及 Java 調(diào)試接口(JDI)。
Java程序的調(diào)試無非就是通過一個調(diào)試器(debugger)獲取對應Java虛擬機的信息,上文所述的JDWP就是調(diào)試器與虛擬機通信的橋梁。在dalvik虛擬機內(nèi)部有一個專門的jdwp線程,Android系統(tǒng)的adbd進程通過socket與各個虛擬機的jdwp線程進行通信,外部調(diào)試器通過adb工具與adbd通信進而完成與jdwp的通信。我們通常所說的「attach debugger」指的就是這個意思——連接到指定的需要調(diào)試的進程。
調(diào)試器工作原理
如何在正確的地方下斷點
「正確的地方」包含兩個含義:首先,調(diào)試是以進程為單位進行的,如果你需要調(diào)試運行在進程A 中的代碼,卻把debugger attach到了B進程,那么這個斷點壓根兒就是牛頭不對馬嘴;另外呢,比如你想調(diào)試Android的多媒體框架,你得知道m(xù)edia相關的類在哪吧,也就是說需要在正確的函數(shù)里面下斷點。
如何在合適的進程下斷點?
如果是調(diào)試我們自己寫的App,在Android Studio里面非常簡單,在Run菜單de最后面有一個attach debugger to android process 的選項,點擊之后會出現(xiàn)一個菜單,選擇自己需要調(diào)試的進程即可;但是,如果需要調(diào)試Android Framework層的代碼,這樣做是達不到目的的——Framework層的代碼通常運行在別的進程(比如ActivityManagerService運行在system_server進程),而這些進程通常情況下是不可調(diào)試的,也就是說在attach debugger to android process 的那個菜單里面不會有系統(tǒng)的進程,如下圖:
普通的無法調(diào)試的Android設備
為什么不可調(diào)試呢?上文我們簡要講述了調(diào)試器的工作原理,我們知道每一個虛擬機有一個jdwp線程,如果這個線程拒絕連接到調(diào)試器,你也就沒辦法對這個進程進行調(diào)試了。Android的所有App進程都是通過Zygote進程fork出來的,我們在android.os.Process這個類里面可以看到android進程的啟動過程有這么一句:
- if ((debugFlags & Zygote.DEBUG_ENABLE_DEBUGGER) != 0) {
- argsForZygote.add("--enable-debugger");
- }
也就是說,一個進程是否可以調(diào)試是由進程啟動時候的參數(shù)決定的;普通的App進程如果是debug keystore默認是可以調(diào)試的,有或者你在AndroidManifest里面指定debuggable為true也是可以調(diào)試的。對系統(tǒng)進程,我們只有采取系統(tǒng)級別的手段:讓整個系統(tǒng)可以調(diào)試——debug版或者編譯參數(shù)debuggable為1的系統(tǒng)。
解決這個辦法很簡單:使用模擬器(真機也行,限Nexus系列刷原生Android系統(tǒng),把系統(tǒng)啟動的debuggable參數(shù)修改為1),我的Nexus 5 可以調(diào)試的進程如下:
可調(diào)試任意進程的設備
這樣,系統(tǒng)中所有的Android進程都可以調(diào)試了;這一點很重要,比如你要分析Activity的啟動流程,相當多一部分代碼是在ActivityManagerService所在的進程system_server執(zhí)行的,如果你把斷點打在別的進程,就會產(chǎn)生跟丟了的情況。在比如,你要調(diào)試ActivityThread的main函數(shù),在main函數(shù)里面執(zhí)行了一句attach,最終調(diào)用AMS的attachApplication的時候,代碼就通過Binder IPC調(diào)用到了AMS的system_server進程。
明白你要執(zhí)行的代碼運行在哪一個進程相當重要,在Android中,由于Binder通信機制的存在,「進程遷移」使用的非常非常頻繁,因此需要對binder機制有一定的了解;詳細的話可以參考我的博客:Binder學習指南
如何在對應的代碼處下斷點?
假設我們現(xiàn)在把debugger attach到了正確的進程,那么斷點應該下在哪里呢?直觀來講,就是說我需要導入所有的Android源碼嗎?如果不是應該導入哪些代碼,怎么導入?
首先,如果你需要調(diào)試的類在sdk里面導出了,你壓根兒就不需要再導入源碼,Android Studio自動幫你關聯(lián)了這部分代碼(前提是你用SDK Manager下載了sdk的源碼,如下圖:
SDK manager下載源碼
比如你要調(diào)試ActivityManagerServce類的attachApplication方法,那么很簡單;創(chuàng)建一個空的Android項目,SDK版本選擇與你要調(diào)試的模擬器/真機 的android相同(這很重要,下文會講述);然后attrach 到system_server進程,直接在attach_application上面打上斷點;隨便啟動一個app,可以看到我們熟悉的調(diào)試界面:
調(diào)試attachApplication
如果這部分類在sdk中沒有導入(比如@hide)的,又或者壓根兒不是SDK的類,(比如系統(tǒng)app的源碼)那應該怎么辦呢?直接導入這部分代碼即可。不需要是Android項目,普通的Java項目即可;舉個例子,假設你想調(diào)試原生Android系統(tǒng)的「系統(tǒng)設置」這個程序,該如何做呢?
根據(jù)上面的分析,我們首先得知道「系統(tǒng)設置˜」運行在哪一個進程,通常情況下進程名字就是包名;我們查出設置的包名即可,而包名是在源碼的AndroidManifeist中聲明的,因此,我們找到「系統(tǒng)設置」這個程序的源碼即可;源碼在 https://android.googlesource.com/ ,系統(tǒng)App的源碼在/packages這個子目錄下面,我們一個個找,最終可以確定「系統(tǒng)設置」的源碼在https://android.googlesource.com/platform/packages/apps/Settings/ ;然后我們把這部分代碼git clone下來,導入Android Studio:
調(diào)試Settings
我們?nèi)ndroidManifest中查到,「系統(tǒng)設置」的包名為:com.android.settings,這樣我們attach到這個進程 :
attach setting進程
然后,我們隨便打個斷點玩一玩,比如進入設置主界面的時候,斷下來;我們在AndroidManifest中查到設置程序的入口界面為:Settings,我們在這個類的onCreate里面打一個斷點,然后進入設置程序,發(fā)現(xiàn)完美滴斷下來了:
在setting中斷點成功
OK,到這里;應該學會如何在正確的位置打斷點了:正確的進程,正確的位置。接下來,要完成調(diào)試,還需要一些技巧。
如何跟蹤代碼?
或許你會說,跟蹤代碼不就是step in/out/over么,這有什么難的?但其實事情并沒有你想象的那么簡單,要優(yōu)雅滴調(diào)試,還是需要一些姿勢的。
行號對應
跟蹤代碼一個首要的問題是行號對應。如果你在正確位置下了斷點,但是跟蹤的時候,單步調(diào)試,發(fā)現(xiàn)運行的代碼和Android Studio里面的代碼對不上號,那么就很蛋疼;要使得調(diào)試器的行號能夠?qū)?,必須保證設備上的代碼和調(diào)試器的代碼是同一份;簡單來說,需要使用Android的原生系統(tǒng)(模擬器,Nexus系列真機),然后調(diào)試器里面使用的SDK版本,必須和設備的系統(tǒng)版本一致。
行號不對應怎么辦?
一定要注意行號對應這一點,這會使調(diào)試過程簡單很多;如果沒有辦法,行號對不上,那該如何調(diào)試呢?
行號不對應帶來的一個首要問題就是,下斷點的時候都有可能出現(xiàn)問題;比如你在TestClass的第100行下了一個斷點,但是由于行號不對應,有可能真正執(zhí)行的代碼第100行是沒有意義的空行或者是在下一個函數(shù)里面,這樣斷點就沒有起到應有的作用了。
要解決行好對應的問題,必須使用方法斷點;我們直接在某個函數(shù)的入口設置斷點,這樣即使行號對不上,也能在正確的入口出斷下來,這一點非常重要。
解決了如何下斷點的問題,那么行號不對應,怎么知道執(zhí)行到哪了,怎么查看局部變量?
觀察棧楨
在Android Studio的調(diào)試器的左邊,顯示了每一個線程執(zhí)行的棧楨,棧楨里面包含了當前線程豐富的信息:
看到?jīng)],真正運行的代碼在哪一行,當前運行的是什么函數(shù)一目了然;接下來你在step into/out的時候,不能以源代碼的行數(shù)為準,而應該以這個棧楨所顯示的代碼行數(shù)為準。
熟練使用斷點
OK,現(xiàn)在不論行號是否能對應,我們都能正確滴下斷點調(diào)試了。斷點有很多種類型,方法斷點,watch point,條件斷點都能夠很好滴輔助我們調(diào)試;如果你連這幾個名詞都沒有聽說過,一定要惡補一下;可以參閱我的博客:Android Studio你不知道的調(diào)試技巧;我就不再復述了。
如果你仔細看完了本文和我給出的鏈接,那么應該對Debug技術不再陌生了;接下來你可以選擇Framework層的代碼,手動調(diào)試一下加深理解;在日后的工作過程中,不斷滴加強debug技術的練習,讓它稱為你解決復雜問題的條件反射,一定會事半功倍!還有記住:
Debug the fucking source code.