我們在寫程序時,有不少時間都是在看別人的代碼。 例如看小組的代碼,看小組整合的守則,若一開始沒規(guī)劃怎么看, 就會看得云山霧罩不知其所然。
不管是參考也好,從開源抓下來研究也好,為了了解箇中含意,在有限的時間下,不免會對龐大的源代碼解讀感到壓力。
以下來介紹一下讀代碼的心法:
- 讀懂程序代碼,使心法皆為我所用。
- 摸清架構(gòu),便可輕松掌握全貌。
- 優(yōu)質(zhì)工具在手,讀懂程序非難事。
- 望文生義,進(jìn)而推敲組件的作用。
- 找到程序入口,再由上而下抽絲剝繭。
- 閱讀的樂趣,透過程序認(rèn)識作者。
讀懂程序,使心法皆為我所用
程序是別人寫的,只有原作者才真的了解程序的用途及涵義。許多程員心里都有一種不自覺的恐懼感,深怕被迫去碰觸其他人所寫的程序。但是,與其抗拒接收別人的程序,不如徹底了解相關(guān)的語言和慣例,當(dāng)成是培養(yǎng)自我實(shí)力的基石。
對大多數(shù)的程序員來說,撰寫程序或許是令人開心的一件事情,但我相信,有更多人視閱讀他人所寫成的程序?yàn)槲吠尽TS多人寧可自己重新寫過一遍程序,也不愿意接收別人的程序,進(jìn)而修正錯誤,維護(hù)它們,甚至加強(qiáng)功能。
這其中的關(guān)鍵究竟在何處呢?若是一語道破,其實(shí)也很簡單,程序是別人寫的,只有原作者才真的了解程序的用途及涵義。許多程序員心里都有一種不自覺的恐懼感,深怕被迫去碰觸其他人所寫的程序。這是來自于人類內(nèi)心深處對于陌生事物的原始恐懼。
讀懂別人寫的程序,讓你收獲滿滿。不過,基于許多現(xiàn)實(shí)的原因,程序員時常受迫要去接收別人的程序。例如,同事離職了,必須接手他遺留下來的工作,也有可能你是剛進(jìn)部門的菜鳥,而同事經(jīng)驗(yàn)值夠了,升級了,風(fēng)水輪流轉(zhuǎn),一代菜鳥換菜鳥。甚至,你的公司所承接的項目,必須接手或是整合客戶前一個廠商所遺留下來的系統(tǒng),你們手上只有那套系統(tǒng)的源代碼(運(yùn)氣好時,還有數(shù)量不等的文件) 。
諸如此類的故事,其實(shí)時常在程序員身邊或身上持續(xù)上演著。許多程序員都將接手他人的程序,當(dāng)做一件悲慘的事情。每個人都不想接手別人所撰寫的程序員,因?yàn)椴幌牖〞r間去探索,寧可將生產(chǎn)力花在產(chǎn)生新的程序,而不是耗費(fèi)在了解這些程序上。
很遺憾的是,上述的情況對程序員來說很難避免。我們總是必須碰觸到其他人所寫成的程序,甚至必須了解它,加以修改。對于這項需求,在現(xiàn)今開放源代碼的風(fēng)氣如此盛行的今日,你可以透過開放源碼學(xué)習(xí)到新的技術(shù),學(xué)習(xí)到高手的架構(gòu)設(shè)計,大幅提高學(xué)習(xí)的效率及效果。你甚至可以直接自開放源代碼項目中抽取,提煉出自己所需的程序,站在巨人的肩膀上,直接由彼端獲得所需的生產(chǎn)力。從這個觀點(diǎn)來看,讀懂別人所寫的程序,就不再只是從負(fù)面觀點(diǎn)的“被迫接收” ,而是極具正面價值的“汲取養(yǎng)份。 ”
先了解系統(tǒng)架構(gòu)與行為模式,再細(xì)讀倘若撰寫程序是程序員的重要技藝之一,那么讀懂別人的程序,接著加以修改,也勢必是另一個重要的技藝。
如果你不能熟悉這項工作,不僅在遭逢你所不愿面對的局面時,無法解決眼前接手他人程序的難題,更重要的是,當(dāng)你看著眼前現(xiàn)成的程序,卻不知如何從中擷取自己所需,導(dǎo)致最后只能入寶山空手回,望之興嘆。
接觸他人的程序,大致上可以分為三種程度:
- 了解
- 修改,擴(kuò)充
- 抽取,提煉。
了解別人的程序是最基礎(chǔ)的工作,倘若不能了解自己要處理的程序,就甭論修改或擴(kuò)充,更不可能去蕪存菁,從中萃取出自己所需,回收再利用別人所撰寫的程序。雖說是“閱讀” ,但程序并不像文章或小說一樣,透過這種做法,便能夠獲得一定程度的了解。閱讀文章或小說時,幾乎都是循序地閱讀,你只消翻開第一頁,一行行閱讀下去即可。但是,有許多程序員在試著閱讀其他人的程序時,卻往往有不知如何讀起的困難。
或許找到系統(tǒng)的第一頁(也就是程序執(zhí)行的啟始點(diǎn))并不難,但是復(fù)雜度高的系統(tǒng),有時十分龐大,有時千頭萬緒。
從程序的啟始點(diǎn)開始讀起,一來要循序讀完所有的程序曠日費(fèi)時,二來透過這種方式來了解系統(tǒng),很難在腦中構(gòu)建出系統(tǒng)的面貌,進(jìn)而了解到系統(tǒng)真正的行為。所以,閱讀程序員的重點(diǎn),不在于讀完每一行程序員,而是在于有效率地透過探索及閱讀,從而了解系統(tǒng)的架構(gòu)及行為模式。以便在你需要了解任何片段的細(xì)節(jié)實(shí)現(xiàn)時,能夠很快在腦上對映到具體的程序員位置,直到那一刻,才是細(xì)讀的時機(jī)。
熟悉溝通語言與慣例用語
不論如何,有些基本的準(zhǔn)備,是閱讀他人程序員時必須要有的。
首先,你最好得了解程序員使用的編程語言。想要讀懂法文寫成的小說,總不能連法文都不懂吧。有些情況則很特殊。我們雖然不懂該程序員撰寫所用的語言,但是因?yàn)楝F(xiàn)代語言的高階化,而且流行的編程語言多半都是血統(tǒng)相近,所以即使不那么熟悉,有時也可勉力為之。
除了認(rèn)識所用語言之外,再來就是要先確認(rèn)程序員所用的命名慣例(命名慣例) 。了解命名慣例很重要,不同的程序員或開發(fā)團(tuán)隊,差異可能很大。
這命名慣例涵蓋的范圍通常包括了變數(shù)的名稱,函數(shù)的名稱,類別(如果是面向?qū)ο蟮脑挘┑拿Q,源代碼檔案,甚至是項目建構(gòu)目錄的名稱。倘若使用了像設(shè)計模式之類的方法,這些名稱更有一些具體的表述方式。
命名慣例有點(diǎn)像是程序員在編程語言之上,另行建構(gòu)的一組溝通行話。程序員會透過共通約束,遵守的命名慣例,來表達(dá)一些較高階的概念。例如,有名的匈牙利式命名法,便將變數(shù)名稱以屬性,型別,說明合并在一起描述。對程序員來說,這種方式能夠提供更豐富的資訊,以了解該變數(shù)的作用及性質(zhì)。
對程序員閱讀來說,熟悉這個做法之所以重要,是因?yàn)楫?dāng)你了解整個系統(tǒng)所采用的慣例時,你便能試著以他們所共同操用的語匯來進(jìn)行理解。倘若,不能了解其所用的慣例,那么這些額外提供的資訊,就無法為你所用。像以設(shè)計模式寫成的程序員,同樣處處充滿著模式的名稱,諸如:工廠,門面,代理等等。以這些名稱指涉的類別,也直接透過名稱,表達(dá)了它們自身的作用。對于懂得這命名慣例的讀者來說,不需要深入探索,也能很快捕捉到這些類別的意義。
當(dāng)你拿到一套必須閱讀的程序員時,最好先取得命名慣例的說明文件。然而,并不是每套程序員都附有此類的說明文件。另一個方式,就是自己到程序員中,大略瀏覽一遍,有經(jīng)驗(yàn)的程序員可以輕易發(fā)掘出該系統(tǒng)所用的命名慣例。
常見的命名方式不脫那幾類,這時候經(jīng)驗(yàn)就很重要,倘若你知道的慣例越多,就越能輕易識別他人所用的慣例。如果運(yùn)氣很糟,程序員所用的慣例是前所未見的,那么你也得花點(diǎn)時間歸納,憑自己的力量找出這程序員命名上的規(guī)則。
掌握程序員撰寫者的心態(tài)與習(xí)慣
大多數(shù)的程序員,基本上都依循一致的命名慣例。不過運(yùn)氣更差的時候,一套系統(tǒng)中可能會充斥著多套命名慣例。這有可能是因?yàn)殚_發(fā)團(tuán)隊由多組人馬所構(gòu)成,每組人馬都有不同的文化,而在項目開發(fā)管理又沒有管控得宜所造成。最糟的情況,程序員完全沒有明顯的慣例可言,這時候閱讀的難度就更高了。
想要閱讀程序員,得先試著體會程序員作者的“心” 。想要這么做,就得多了解對方所使用的語言,以及慣常運(yùn)用的語匯。在下一回中,我們將繼續(xù)探討閱讀程序員的相關(guān)議題。
摸清架構(gòu),便可輕松掌握全貌
在本文中,我們的重點(diǎn)放在:要了解一個系統(tǒng),最好是采取由上至下的方式。先試著捕捉系統(tǒng)架構(gòu)性的觀念,不要過早鉆進(jìn)細(xì)節(jié),因?yàn)槟峭ǔτ谀懔私馊玻瑳]有多大的幫助。閱讀程序員不需要從第一行讀起,我們的目的并不是在于讀遍每一段程序員。
基于許多原因,程序員需要閱讀其他人所寫成的程序員。而對程序設(shè)計2.0時代的程序員來說,最正面的價值在于,能讀懂別人程序的人,才有能力從中萃取自己所需的程序,借以提高生產(chǎn)力。
閱讀程序員的目的,在于了解全貌而非細(xì)節(jié)
想要讀懂別人程序員的根本基礎(chǔ),便是了解對方所用的編程語言及命名慣例。有了這個基礎(chǔ)之后,才算是具備了基本的閱讀能力。正如我之前提到的─ ─想要讀懂法文寫成的小說,總不能連法文都不懂吧。閱讀程序員和閱讀文學(xué)作品,都需要了解撰寫所用的語言及作者習(xí)用的語匯。
但我們在閱讀文學(xué)作品通常是采循序的方式,也就是從第一頁開始,一行一行地讀下去,依循作者為你鋪陳的步調(diào),逐漸進(jìn)到他為你準(zhǔn)備好的世界里。閱讀程序員卻大大不同。我們很少從第一行開始讀起,因?yàn)槌撬呛芎唵蔚膯螆?zhí)行緒程序,否則很少這么做。因?yàn)橐沁@么做,就很難了解整個系統(tǒng)的全貌。是的,我們這邊提到了一個重點(diǎn),閱讀程序員的目的在于了解系統(tǒng)的全貌,而不是在于只是為了地毯式的讀遍每一段程序員。
就拿面向?qū)ο缶幊陶Z言所寫成的系統(tǒng)來說,整個系統(tǒng)被拆解,分析成為一個個獨(dú)立的類別。閱讀個別類別的程序員,或許可以明白每項類別物件個別的行為。但對于各類別物件之間如何交互影響,如何協(xié)同工作,又很容易陷入盲人摸象的困境。這是因?yàn)楦黝悇e的程序員,只描述個別物件的行為,而片段的閱讀就只能造就片面的認(rèn)識。
由上而下理清架構(gòu)后,便可輕易理解組成關(guān)系
如果你想要跳脫困境,不想浪費(fèi)大量時間閱讀程序員,卻始終只能捕捉到對系統(tǒng)片段認(rèn)識,就必須轉(zhuǎn)換到另一種觀點(diǎn)來看待系統(tǒng)。從個別的類別行為著手,是由下至上(自下而上)的方法;在閱讀程序員時,卻應(yīng)該先采由上至下(自上而下)的方式。對程序員的閱讀來說,由上至下意謂著,你得先了解整個系統(tǒng)架構(gòu)。
系統(tǒng)的架構(gòu)是整個系統(tǒng)的骨干,支柱。它表現(xiàn)出系統(tǒng)最突出的特征。知道系統(tǒng)架構(gòu)究竟屬于那一種類型,通常大大有益于了解系統(tǒng)的個別組成之間的靜態(tài)及動態(tài)關(guān)系。有些系統(tǒng)因?yàn)樗玫募夹g(shù)或框架的關(guān)系,決定了最上層的架構(gòu)。例如,采用的Java Servlet的/ JSP的技術(shù)的應(yīng)用系統(tǒng),最外層的架構(gòu)便是以J2EE的(或起碼的J2EE中的Web容器)為根本。
使用的Java Servlet的/ JSP的技術(shù)時,決定了某些組成之間的關(guān)系。例如, Web容器依據(jù)web.xml中的內(nèi)容載入所有的Servlets ,聽眾,以及過濾器。每當(dāng)語境發(fā)生事件(例如初始化)時,它便會通知監(jiān)聽類別。每當(dāng)它收到來自客戶端的請求時,便會依循設(shè)定的所有過濾器鏈,讓每個過濾器都有機(jī)會檢查并處理此一請求,最后再將請求導(dǎo)至用來處理該請求的Servlet的。
當(dāng)我們明白某個系統(tǒng)采用這樣的架構(gòu)時,便可以很容易地知道各個組成之間的關(guān)系。即使我們還不知道究竟有多少Servlets ,但我們會知道,每當(dāng)收到一個請求時,總是會有個相對應(yīng)的服務(wù)器來處理它。當(dāng)想要關(guān)注某個請求如何處理時,我應(yīng)該去找出這個請求對應(yīng)的服務(wù)器。
了解架構(gòu),必須要加上層次感
同樣的,以爪哇寫成的網(wǎng)頁應(yīng)用程序中,也許會應(yīng)用諸如Struts的之類的的MVC框架,以及像Hibernate的這樣的資料存取框架。它們都可以視為最主要的架構(gòu)下的較次級架構(gòu)。而各個應(yīng)用系統(tǒng),甚至有可能在Struts的及休眠之下,建立自有的更次級的架構(gòu)。
也就是說,當(dāng)我們談到“架構(gòu)”這樣的觀念時,必須要有層次感。而不論是那一層級的架構(gòu),都會定義出各自的角色,以及角色間的關(guān)系。對閱讀者來說,相較于直接切入最細(xì)微的單一角色行為,不如了解某個特定的架構(gòu)中,究竟存在多少角色,以及這些角色之間的互動模式,比較能夠幫助我們了解整個系統(tǒng)的運(yùn)作方式。
這是一個很重要的關(guān)鍵,當(dāng)你試著進(jìn)到最細(xì)節(jié)處之前,應(yīng)該先試著找出參與的角色,及他們之間的關(guān)系。例如,對事件驅(qū)動式的架構(gòu)而言,有3個很重要的角色。一個是事件處理的分派器(事件調(diào)度) ,一個是事件產(chǎn)生者(事件發(fā)生器) ,另一個則是事件處理器(事件處理程序) 。
事件產(chǎn)生器產(chǎn)生事件,并送至事件分派器,而事件分派器負(fù)責(zé)找出各事件相對應(yīng)的事件處理器,并且轉(zhuǎn)交該事件,并命令事件處理器加以處理。像的圖形用戶界面的Windows應(yīng)用程序,便是采用事件驅(qū)動式的架構(gòu)。
當(dāng)你知道此類的應(yīng)用程序皆為事件驅(qū)動式的架構(gòu)時,你便可以進(jìn)一步得知,在這樣的架構(gòu)下會有3種主要的角色。雖然也許還不清楚整個系統(tǒng)中,究竟會需要處理多少事件的類型,但對你而言,已經(jīng)建立了對系統(tǒng)全貌最概觀的認(rèn)識。
雖然你還不清楚所有的細(xì)節(jié),但諸如確切會有那些事件類型之類的資訊,在此刻還不重要─ ─不要忘了,我們采取的是由上而下的方式,要先摸清楚主建筑結(jié)構(gòu),至于壁紙的花色怎么處理,那是到了尾聲時才會做的事。
探索架構(gòu)的第一件事:找出系統(tǒng)如何初始化
有經(jīng)驗(yàn)的程序員,對于時常被運(yùn)用的架構(gòu)都很熟悉。常常只需要瞧上幾眼,就能明白一個系統(tǒng)所用的架構(gòu),自然就能夠直接聯(lián)想到其中會存在的角色,以及角色間的關(guān)系。然而,并不是每個系統(tǒng)所用的架構(gòu),都是大眾所熟悉,或是一眼能夠望穿的。這時候,你需要探索。目標(biāo)同樣要放在界定其中的角色,以及角色間的靜態(tài),動態(tài)關(guān)系。
不論某個系統(tǒng)所采用的架構(gòu)是否為大部分人所熟知的,在試著探索一個系統(tǒng)的長相時,我們應(yīng)該找出來幾個答案,了解在它所用的架構(gòu)下,下列這件事是如何被完成的:一,系統(tǒng)如何初始化,二,與這個系統(tǒng)相接的其他系統(tǒng)(或使用者)有那些,而相接的界面又是什么;三,系統(tǒng)如何反應(yīng)各種事件,四,系統(tǒng)如何處理各種異常及錯誤。
系統(tǒng)如何初始化是很重要的一件事,因?yàn)槌跏蓟菫榱私酉聛淼乃惺挛锒龅臏?zhǔn)備。從初始化的方式,內(nèi)容,能知道系統(tǒng)做了什么準(zhǔn)備,對于系統(tǒng)會有什么行為展現(xiàn),也就能得窺一二了。之所以要了解與系統(tǒng)相接的其他系統(tǒng)(或使用者),為的是要界定出系統(tǒng)的邊界。其他的系統(tǒng)可能會提供輸入給我們所探索的系統(tǒng),也可能接收來自這系統(tǒng)的輸出,了解這邊界所在,才能確定系統(tǒng)的外觀。
而系統(tǒng)所反應(yīng)的事件類型,以及如何反應(yīng),基本上就代表著系統(tǒng)本身的主要行為模式。最后,我們必須了解系統(tǒng)處理異常及錯誤的方式,這同樣也是系統(tǒng)的重要行為,但容易被忽略。之前,我們提到必須先具備一個系統(tǒng)的語言基礎(chǔ),才能夠進(jìn)一步加以閱讀,而在本文中,我們的重點(diǎn)放在:要了解一個系統(tǒng),最好是采取由上至下的方式。先試著捕捉系統(tǒng)架構(gòu)性的觀念,不要過早鉆進(jìn)細(xì)節(jié),因?yàn)槟峭ǔτ谀懔私馊玻瑳]有多大的幫助。
優(yōu)質(zhì)工具在手,讀懂程序非難事
系統(tǒng)的復(fù)雜度往往超過人腦的負(fù)荷。閱讀程序員的時候,你會需要更多工具提供協(xié)助。使用好的整合式開發(fā)環(huán)境( IDE )的或文字編輯器,就能提供最基本的幫助。
閱讀程序員的動作,可以是很原始的,利用最簡單的文字編輯器,逐一開啟源代碼,然后憑借著一己的組織能力,在不同的程序員間跳躍,拼湊出腦中想要構(gòu)建的圖像。
不過,系統(tǒng)的復(fù)雜度往往超過人腦的負(fù)荷。閱讀程序員的時候,你會需要更多工具提供協(xié)助。使用好的整合式開發(fā)環(huán)境( IDE )的或文字編輯器,就能提供最基本的幫助。
善用文字編輯器或IDE中,加速解讀程序員
許多文字編輯器提供了常見編程語言的語法及關(guān)鍵字標(biāo)示功能。這對于閱讀來說,絕對能夠起很大的作用。有些文字編輯器(例如我常用的編輯器及偶而使用的記事本+ + ),甚至能夠自動列出某個原始檔中所有定義的函數(shù)清單,更允許你直接從清單中選擇函數(shù),直接跳躍到該函數(shù)的定義位置。這對于閱讀程序員的人來說,就提供了極佳的便利性。
因?yàn)樵陂喿x程序員時,最常做的事,就是隨著程序中的某個控制流,將閱讀的重心,從某個函數(shù)移至它所調(diào)用的另一個函數(shù)。所以對程序員來說,閱讀程序員時最常做的事之一就是:找出某個函數(shù)位在那一個原始檔里,接著找到該函數(shù)所在的位置。
好的的IDE能夠提供的協(xié)助就更多了。有些能夠自動呈現(xiàn)一些額外的資訊,最有用的莫過于函數(shù)的原型宣告了。例如,有些的IDE支援當(dāng)游標(biāo)停留在某函數(shù)名稱上一段時間后,它會以提示的方式顯示該函數(shù)的原型宣告。
對閱讀程序員的人來說,在看到程序員中調(diào)用到某個函數(shù)時,可以直接利用這樣的支援,立即取得和這個函數(shù)有關(guān)的原型資訊,馬上就能知道調(diào)用該函數(shù)所傳入的各個引數(shù)的意義,而不必等到將該函數(shù)的定義位置找出后,才能明白這件事。
grep
是一個基本而極為有用的工具
除了選用好的文字編輯器或的IDE 之外,還有一個基本,但卻極為有用的工具,它就是grep
。熟悉的Unix/Linux系統(tǒng)的程序員對grep
這個程序多半都不陌生。 grep
最大的用途,在于它允許我們搜尋某個目錄(包括遞回進(jìn)入所有子目錄)中所有指定檔案,是否有符合指定條件(常數(shù)字串或正規(guī)表示式)檔案。
倘若有的話,則能幫你指出所在的位置。這在閱讀程序員時的作用極大。當(dāng)我們隨著閱讀的腳步,遇上了任何一個不認(rèn)識,但自認(rèn)為重要的類別,函數(shù),資料結(jié)構(gòu)定義或變數(shù),我們就得找出它究竟位在這茫茫程序員海中的何處,才能將這個圖塊從未知變?yōu)橐阎?/p>
grep之所以好用,就是在于當(dāng)我們發(fā)現(xiàn)某個未知的事物時,可以輕易地利用它找出這個未知的事物究竟位在何方。此外,雖說grep按是Unix系統(tǒng)的標(biāo)準(zhǔn)公用程序之一,但是像視窗這樣子的平臺,也有各種類型的grep
命令。對于在視窗環(huán)境工作的程序員來說,可以自行選用覺得稱手的工具。
gtags
可建立索引,讓搜索更有效率
grep
雖然好用,但是仍然有一些不足之處。第一個缺點(diǎn)在于它并不會為所搜尋的源代碼檔案索引。每當(dāng)你搜尋時,它都會逐一地找出所有的檔案,并且讀取其中的所有內(nèi)容,過濾出滿足指定條件的檔案。當(dāng)項目的源代碼數(shù)量太大時,就會產(chǎn)生搜尋效率不高的問題。
第二個缺點(diǎn)是它只是一個單純的文字檔搜尋工具,本身并不會剖析源代碼所對應(yīng)的語言語法。當(dāng)我們只想針對“函數(shù)”名稱進(jìn)行搜尋時,它有可能將注解中含有該名稱的源代碼,也一并找了出來。
針對grep
的缺點(diǎn),打算閱讀他人程序員的程序員,可以考慮使用像是gtags
這樣子的工具。 gtags
是源代碼的GNU全局標(biāo)記系統(tǒng),它不只搜尋文字層次,而且因?yàn)榫邆淞烁鞣N語言的語法剖析器,所以在搜尋時,可以只針對和語言有關(guān)的元素,例如類別名稱,函數(shù)名稱等。
而且,它能針對源代碼的內(nèi)容進(jìn)行索引,這意謂一旦建好索引之后,每次搜尋的動作,都毋需重新讀取所有源代碼的內(nèi)容并逐一搜尋。只需要以現(xiàn)成的索引結(jié)構(gòu)為基礎(chǔ),即可有效率的尋找關(guān)鍵段落。
gtags
提供了基于命令列的程序,讓你指定源代碼所在的目錄執(zhí)行建立索引的動作。它同時也提供程序讓你得如同操作grep按一般,針對索引結(jié)構(gòu)進(jìn)行搜尋及檢索。它提供了許多有用的檢索方式,例如找出項目中定義某個資料結(jié)構(gòu)的檔案及定義所在的行號,或者是找出項目中所有引用某資料結(jié)構(gòu)的檔案,以及引用處的行號。
這么一來,你就可以輕易地針對閱讀程序員時的需求予以檢索。相較于grep
按所能提供的支援,gtags
這樣的工具,簡直是強(qiáng)大許多。
望文生義,進(jìn)而推敲組件的作用
先建立系統(tǒng)的架構(gòu)性認(rèn)識,然后透過名稱及命名慣例,就可以推測出各組件的作用。例如:當(dāng)AOL的Winamp嘗試著初始化一個插件時,它會調(diào)用這個結(jié)構(gòu)中的初始化函數(shù),以便讓每個插件程序有機(jī)會初始化自己。當(dāng)AOL的Winamp打算結(jié)束自己或結(jié)束某個插件的執(zhí)行時,便會調(diào)用結(jié)束函數(shù)。
在閱讀程序的細(xì)節(jié)之前,我們應(yīng)先試著捕捉系統(tǒng)的運(yùn)作情境。在采取由上至下的方式時,系統(tǒng)性的架構(gòu)是最頂端的層次,而系統(tǒng)的運(yùn)作情境,則是在它之下的另一個層次。
好的說明文件難求,拼湊故事的能力很重要
有些系統(tǒng)提供良善的說明文件,也許還利用UML的充分描述系統(tǒng)的運(yùn)行情況。那么對于閱讀者來說,從系統(tǒng)的分析及設(shè)計文件著手,便是快速了解系統(tǒng)運(yùn)作情境的一個途徑。
但是,并不是每個軟件項目都伴隨著良好的系統(tǒng)文件,而許多極具價值的開放源代碼項目,也時常不具備此類的文件。對此,閱讀者必須嘗試自行捕捉,并適度地記錄捕捉到的運(yùn)作情境。
我喜歡將系統(tǒng)的運(yùn)作情境,比擬成系統(tǒng)會上演的故事情節(jié)。在閱讀細(xì)節(jié)性質(zhì)的程序員前,先知道系統(tǒng)究竟會發(fā)生那些故事,是必備的基本功課。你可以利用熟悉或者自己發(fā)明的表示工具,描述你所找到的情境。甚至可以只利用簡單的列表,直接將它們列出。只要能夠達(dá)到記錄的目的,對程序員閱讀來說,都能夠提供幫助。或者,你也可以利用基于UML中的類別圖,合作圖,循序圖之類的表示方法,做出更詳細(xì)的描述。
當(dāng)你能夠列出系統(tǒng)可能會有的情境,表示你對系統(tǒng)所具備的功能,以及在各種情況下的反應(yīng),都具備概括性的認(rèn)識。以此為基礎(chǔ),便可在任何需要的時候,鉆進(jìn)細(xì)節(jié)處深入了解。
探索架構(gòu)的第一步──找到程序的入口
在之前,我們在一個開發(fā)項目中,曾經(jīng)需要將系統(tǒng)所得到的的MP3音訊檔,放至iPod的這個極受歡迎的播放設(shè)備中。
雖然iPod的本身也可以做為可移動式的儲存設(shè)備,但并不是單純地將MP3播放檔案放到中的iPod ,就可以讓蘋果的播放器認(rèn)得這個檔案,甚至能夠加以播放。
這是因?yàn)樘O果利用一個特殊的檔案結(jié)構(gòu)( iTunes的數(shù)據(jù)庫) ,記錄播放器中可供播放的樂曲,播放清單以及樂曲資訊(例如專輯名稱,樂曲長度,演唱者等) 。為了了解并且試著重復(fù)使用既有的程序員,我們找到了一個AOL的Winamp的iPod的外掛程序(插件) 。
AOL的Winamp是個人電腦上極受歡迎的播放軟件,而我們找到的外掛程序,能讓的軟件直接顯示連接至電腦的的iPod中的歌曲資訊,并且允許的軟件直接播放。
我們追蹤與閱讀這個外掛程序的思路及步驟如下,首先,我們要先了解外掛程序的系統(tǒng)架構(gòu)。很明顯的,大概瀏覽過源代碼后,我們注意到它依循著AOL的Winamp為插件程序所制定的規(guī)范,也就是說,它是實(shí)現(xiàn)成的Windows上的DLL的,并且透過一個叫做winampGetMediaLibraryPlugin的DLL的函數(shù),提供一個名為winampMediaLibraryPlugin的結(jié)構(gòu)。
當(dāng)我們不清楚系統(tǒng)的架構(gòu)究竟為何時,我們會試著探索,而第一步,便是找到程序的入口。如何找到呢?這會依程序的性質(zhì)不同而有所差別。
對一個本身就是可獨(dú)立執(zhí)行的程序來說,我們會找啟動程序的主要函數(shù),例如對的C/C++來說就是main()
函數(shù),而對Java來說,便是靜態(tài)方法main()
。在找到入口后,再逐一追蹤,摸索出系統(tǒng)的架構(gòu)。
但有時,我們閱讀的程序如果是類庫或函數(shù)庫,本身并不具單一入口,此類的程序具有多重的入口──每個允許用戶端程序調(diào)用的函數(shù)或類別,都是它可能的入口。
例如,對AOL的Winamp的 iPod的插件來說,它是一個動態(tài)鏈接庫形式的函數(shù)庫,所以當(dāng)我們想了解它的架構(gòu)時,必須要先找出它對外提供的函數(shù),而對的Windows的DLL來說,對外提供的函數(shù),皆會以dllexport這個關(guān)鍵字來修飾。所以,不論是利用grep按或gtags之類的工具,我們可以很快從源代碼中,找到它只有一個DLL的函數(shù)(這對我們而言,真是一個好消息) ,而這個函數(shù)便是上述的winampGetMediaLibraryPlugin 。
系統(tǒng)多會采用相同的架構(gòu)處理插件程序
如果經(jīng)驗(yàn)不夠的話,也許無法直接猜出這個函數(shù)的作用。 不過,如果你是個有經(jīng)驗(yàn)的程序員,多半能從函數(shù)所回傳的結(jié)構(gòu),猜出這個函數(shù)實(shí)際的用途。而事實(shí)上,當(dāng)你已經(jīng)知道它是一個插件程序時,就應(yīng)該要明白,它可能采用的,就是許多系統(tǒng)都采用的相同架構(gòu)處理插件程序。
當(dāng)一個系統(tǒng)采用所謂插件形式的架構(gòu)時,它通常不會知道它的插件究竟會怎么實(shí)現(xiàn),實(shí)現(xiàn)什么功能。它只會規(guī)范插件程序需要滿足某個特定界面。當(dāng)系統(tǒng)初始化時,所有的插件都可以依循相同的方式,向系統(tǒng)注冊,合法宣示自己的存在。
雖然系統(tǒng)并不確切知道插件會有什么行為展現(xiàn),但是因?yàn)樗贫艘粋€標(biāo)準(zhǔn)的界面,所以系統(tǒng)仍然可以預(yù)期每個插件能夠處理的動作類型。這些動作具體上怎么執(zhí)行,對系統(tǒng)來說并不重要。這也正是面向?qū)ο蟪绦蛟O(shè)計中的“多態(tài)”觀念。
隨著實(shí)踐經(jīng)驗(yàn),歸納常見的架構(gòu)模式
我想表達(dá)的重點(diǎn),是當(dāng)你“涉世越深”之后,所接觸的架構(gòu)越多,就越能觸類旁通。只需要瞧上幾眼,就能明白系統(tǒng)所用的架構(gòu),自然就能夠直接聯(lián)想到其中可能存在的角色,以及角色間的關(guān)系。
像上述的插件程序手法,時常可以在許多允許“外掛”程序員的系統(tǒng)中看到。所以,有經(jīng)驗(yàn)的閱讀者,多半能夠立即反應(yīng),知道像這樣的系統(tǒng)的軟件,應(yīng)該是讓每個插件程序,都寫成DLL的函數(shù)庫。
而每個插件的DLL的函數(shù)庫中,都必須提供winampGetMediaLibraryPlugin()
這個函數(shù) 。如果你熟悉設(shè)計模式,你更會知道這是簡單工廠方法這個設(shè)計模式的運(yùn)用。
winampGetMediaLibraryPlugin()
所回傳的winampMediaLibraryPlugin
結(jié)構(gòu),正好就描述了每個AOL的Winamp插件的實(shí)現(xiàn)內(nèi)容。
善用名稱可加速了解
利用gtags
這個工具,我們立即發(fā)現(xiàn),這個插件它所定義的初始化,退出, PluginMessageProc
這三個名稱,都是函數(shù)名稱。這暗示在方法重載的作用下,它們都是在某些時間點(diǎn),會由AOL的Winamp核心本體調(diào)用的函數(shù)。
名稱及命名慣例是很重要的。看到 “初始化” ,我們會知道它的作用多半是進(jìn)行初始化的動作,而“退出”大概就是結(jié)束時處理函數(shù),而PluginMessageProc多半就是各種訊息的處理常式(過程通常是程序的簡寫,所以PluginMessagePro
c意指插件訊息程序)了。
“望文生義”很重要,我們看到函數(shù)的名稱,就可以猜想到它所代表的作用,例如:當(dāng)AOL的Winamp嘗試著初始化一個插件時,它會調(diào)用這個結(jié)構(gòu)中的初始化函數(shù),以便讓每個插件程序有機(jī)會初始化自己;當(dāng)AOL的Winamp打算結(jié)束自己或結(jié)束某個插件的執(zhí)行時,便會調(diào)用退出函數(shù)。當(dāng)AOL的Winamp要和插件程序溝通時,它會發(fā)送各種不同的訊息至插件,而插件程序必須對此做出回應(yīng)。
我們甚至不需要檢查這幾個函數(shù)的內(nèi)容,就可以做出推測,而這樣的假設(shè),事實(shí)上也是正確的。
閱讀的樂趣:透過程序員認(rèn)識作者
即便每個人的寫作模式多半受到他人的影響,程序通常還是會融合多種風(fēng)格,而成為自己獨(dú)有的特色,如果你知道作者程序設(shè)計的偏好,閱讀他的程序就更得心應(yīng)手。
閱讀程序時,多半會采取由上而下,抽絲剝繭的方式。透過記錄層層展開的樹狀結(jié)構(gòu),程序員可以逐步地建立起對系統(tǒng)的架構(gòu)觀,而且可以依照需要的粒度(粒度) ,決定展開的層次及精致程度。
建立架構(gòu)觀點(diǎn)的認(rèn)識是最重要的事情。雖然這一系列的文章前提為“閱讀他人的程序” ,但我們真正想做的工作,并不在于徹底地詳讀每一行程序員的細(xì)節(jié),而是想要透過重點(diǎn)式的程序“摘讀” ,達(dá)到對系統(tǒng)所需程度的了解。每個人在閱讀程序員的動機(jī)不盡相同,需要了解的程度也就有深淺的分別。只有極為少數(shù)的情況下,你才會需要細(xì)讀每一行程序。
閱讀程序是新時代程序員必備的重要技能
本文至此已近尾聲,回顧曾探討的主題,我們首先研究了閱讀程序的動機(jī)。尤其在開放源代碼的風(fēng)氣如此之盛的情況下,妥善利用開放源代碼所提供的資源,不僅能夠更快學(xué)習(xí)到新的技術(shù),同時在源代碼版權(quán)合適時,還可以直接利用現(xiàn)成的程序,大幅地提高開發(fā)階段的生產(chǎn)力。所以,閱讀程序儼然成為了新時代程序員必備的重要技能之一。
接著,我們提到了閱讀程序前的必要準(zhǔn)備,包括了對編程語言,命名慣例的了解等等。在此之后,我們反覆提起了“由上而下”的閱讀方向的重要性。
由上而下的閱讀方式,是因?yàn)槲覀冎匾暭軜?gòu)更勝于細(xì)節(jié)。從最外層的架構(gòu)逐一向內(nèi)探索,每往內(nèi)探索一層,我們了解系統(tǒng)的粒度就增加了一個等級。當(dāng)你識別出系統(tǒng)所用的架構(gòu)時,便能夠輕易了解在這個架構(gòu)下會有的角色,以及它們之間的動態(tài)及靜態(tài)的關(guān)系。如此一來,許多資訊便不言可喻,毋需額外花費(fèi)力氣,便能夠快速理解。
好的名稱能夠摘要性地指出實(shí)例的作用
追蹤源代碼時,固然可以用本來的方式,利用編輯器開啟所需的檔案,然后利用編輯器提供的機(jī)制閱讀,但是倘若能夠善用工具,閱讀程序員的效率及品質(zhì)都能大大提升。在本文中,我們介紹了一些工具,或許你還可以在坊間找到其他更有用的工具。
我在這一系列的文章中,實(shí)際帶著大家閱讀,追蹤了一個名為ml_pod的開放源代碼項目。它是一個AOL的Winamp的iPod的外掛程序。在追蹤的過程中,我們試著印證這一系列文中所提到的觀念及方法。我們采用逐漸開展的樹狀結(jié)構(gòu)來記錄追蹤的過程,并借以建立起對系統(tǒng)的概觀認(rèn)識。
就源代碼的閱讀來說,之前的討論涉及了工具面及技巧面。但還有一些主題不在這兩個范疇之內(nèi),例如,善用名稱賦予你的提示。名稱做為隱喻(隱喻)的作用很大,好的名稱能夠摘要性地點(diǎn)出實(shí)體的作用,例如我們看到autoDetectIpod()
,自然而然能夠想像它的作用在于自動(自動)偵測(檢測)的iPod的存在。
我們在展開樹狀結(jié)構(gòu)時,有時候需要預(yù)看一層,有時卻不需要這么做,便可得到印證。程序員都會有慣用的名稱以及組合名稱的方法,倘若能夠從名稱上理解,便毋需鉆進(jìn)細(xì)節(jié),可以省去相當(dāng)多的時間。例如,當(dāng)我們看到parseIpodDb ( )時,便可以輕易了解它是剖析(解析)的iPod的資料庫( DB )的,因此便不需要立即鉆進(jìn)parseIpodDb ( )中查看底細(xì)。
盡管如此,能否理解程序命名的用意,和自身的經(jīng)驗(yàn)以及是否了解原作者的文化背景,是息息相關(guān)的。
命名本身就是一種文化產(chǎn)物。不同的程序員文化,就會衍生出不同的命名文化。當(dāng)你自己的經(jīng)驗(yàn)豐富,看過及接觸過的程序員也多時,對于名稱的感受及聯(lián)想的能力自然會有不同。
這種感受和聯(lián)想的能力,究竟應(yīng)該如何精進(jìn),很難具體描述。就我個人的經(jīng)驗(yàn),多觀察不同命名體系的差異,并且嘗試歸納彼此之間的異同,有助于更快地提升對名稱的感受及聯(lián)想力。
轉(zhuǎn)換立場,理解作者的思考方式
除了工具及技巧之外, “想要閱讀程序,得先試著閱讀寫這個程序的程序員的心。 ”這句話說來十分抽象,或許也令人難以理解。
當(dāng)你在閱讀一段程序員時,或許可以試著轉(zhuǎn)換自己的立場,從旁觀者的角度轉(zhuǎn)換成為寫作者的心態(tài),揣摩原作者的心理及處境。當(dāng)你試著設(shè)身處地站在他的立場,透過他的思考方式來閱讀,追蹤他所寫下的程序員,將會感覺更加流暢。
許多軟件項目,都不是由一個程序員所獨(dú)力完成。因此,在這樣的項目中,便有可能呈現(xiàn)多種不同的風(fēng)格。
許多項目會由架構(gòu)師決定主體的架構(gòu)及運(yùn)作,有既定實(shí)施的命名慣例,及程序設(shè)計需要遵守方針。在多人開發(fā)的模式下,越是好的軟件項目,越看不出某程序片段究竟是由誰所寫下的。
不過,有些開放源代碼的項目,往往又整合了其他開放源代碼的項目。有的時候,也很難求風(fēng)格的統(tǒng)一,便會出現(xiàn)混雜的情況。好比之前提到的ml_pod項目,因?yàn)槌绦蛑谢旌狭瞬煌膩碓矗尸F(xiàn)風(fēng)格不一致的情況。
我在閱讀非自己所寫的程序時,會觀察原作者寫作的習(xí)慣,借以對應(yīng)到腦中所記憶的多種寫作模型。在閱讀的過程中,讀完幾行程序,我會試著猜想原作者在寫下這段程序時的心境。他寫下這段程序的用意是什么?為什么他會采取這樣的寫法?順著原作者的思考理路閱讀,自己的思考才能更貼近對方寫作當(dāng)時的想法。
當(dāng)你短暫化身為原作者時,才能更輕易的理解他所寫下的程序。 如果你能知道原作者的背景,程序設(shè)計時的偏好,閱讀他的程序,就更能得心應(yīng)手了。
從程序員著手認(rèn)識作者獨(dú)有的風(fēng)格,進(jìn)而見賢思齊
我在閱讀別人寫下的程序時,我會試著猜想,原作者究竟是屬于那一種“流派”呢?每個人都有自己獨(dú)特的寫作模式,即便每個人的寫作模式多半受到他人的影響─ ─不論是書籍的作者,學(xué)習(xí)過程中的指導(dǎo)者,或一同參與項目的同儕,但每個程序員通常會融合多種風(fēng)格,而成為自己獨(dú)有的風(fēng)格。
面向?qū)ο蟮幕窘塘x派,總是會以他心中覺得最優(yōu)雅的面向?qū)ο蠓绞絹碜珜懗绦颉6喿x慣用,善用設(shè)計模式的程序員所寫下的程序時,不難推想出他會在各種常見的應(yīng)用情境下,套用哪些模式。
有些時候,在閱讀之初,你并不知道原作者的習(xí)性跟喜好,甚至你也不知道他的功力。但是,在閱讀之后,你會慢慢地從一個程序員所寫下的程序,開始認(rèn)識他。
你或許會在閱讀他人的程序時,發(fā)現(xiàn)令人拍案叫絕的技巧或設(shè)計。你也有可能在閱讀的同時,發(fā)現(xiàn)原作者所留下的缺失或?qū)懽鲿r的缺點(diǎn),而暗自警惕于心。這也算是閱讀他人程序時的一項樂趣。
當(dāng)你從視閱讀他人的程序?yàn)槲吠荆D(zhuǎn)變成為可以從中獲取樂趣的時候,我想,你又進(jìn)到了另一個境界。