四、望文生義，進而推敲組件的作用?

先建立系統的架構性認識，然后透過名稱及命名慣例，就可以推測出各組件的作用。例如：當Winamp嘗試著初始化一個Plug-In時，它會呼叫這個結構 中的init函式，以便讓每個Plug-In程序有機會初始化自己。當Winamp打算結束自己或結束某個Plug-In的執行時，便會呼叫quit函 式。?

在閱讀程序代碼的細節之前，我們應先試著捕捉系統的運作情境。在采取由上至下的方式時，系統性的架構是最頂端的層次，而系統的運作情境，則是在它之下的另一個層次。?

好的說明文件難求，拼湊故事的能力很重要?

有些系統提供良善的說明文件，也許還利用UML充分描述系統的運作情境。那么對于閱讀者來說，從系統的分析及設計文件著手，便是快速了解系統運作情境的一個途徑。?

但是，并不是每個軟件項目都伴隨著良好的系統文件，而許多極具價值的開放原始碼項目，也時常不具備此類的文件。對此，閱讀者必須嘗試自行捕捉，并適度地記錄捕捉到的運作情境。?

我喜歡將系統的運作情境，比擬成系統會上演的故事情節。在閱讀細節性質的程序代碼前，先知道系統究竟會發生那些故事，是必備的基本功課。你可以利用熟悉或 者自己發明的表示工具，描述你所找到的情境。甚至可以只利用簡單的列表，直接將它們列出。只要能夠達到記錄的目的，對程序代碼閱讀來說，都能夠提供幫助。 或者，你也可以利用UML中的類別圖、合作圖、循序圖之類的表示方法，做出更詳細的描述。?

當你能夠列出系統可能會有的情境，表示你對系統所具備的功能，以及在各種情況下的反應，都具備概括性的認識。以此為基礎，便可在任何需要的時候，鉆進細節處深入了解。?

探索架構的第一步──找到程序的入口?

在之前，我們在一個開發項目中，曾經需要將系統所得到的MP3音訊文件，放至iPod這個極受歡迎的播放設備中。?

雖然iPod本身也可以做為可移動式的儲存設備，但并不是單純地將MP3檔案放到iPod中，就可以讓iPod的播放器認得這個檔案，甚至能夠加以播放。?

這是因為iPod利用一個特殊的檔案結構（iTunes DB），記錄播放器中可供播放的樂曲、播放列表以及樂曲信息（例如專輯名稱、樂曲長度、演唱者等）。為了了解并且試著重復使用既有的程序代碼，我們找到了一個Winamp的iPod插件（Plug-In）。?

Winamp是個人計算機上極受歡迎的播放軟件，而我們找到的插件，能讓Winamp直接顯示連接至計算機的iPod中的歌曲信息，并且允許Winamp直接播放。?

我們追蹤與閱讀這個插件的思路及步驟如下，首先，我們要先了解插件的系統架構。很明顯的，大概瀏覽過原始碼后，我們注意到它依循著WinAmp為 Plug-In程序所制定的規范，也就是說，它是實作成Windows上的DLL，并且透過一個叫做 winampGetMediaLibraryPlugin的DLL函式，提供一個名為winampMediaLibraryPlugin的結構。?

當我們不清楚系統的架構究竟為何時，我們會試著探索，而第一步，便是找到程序的入口。如何找到呢？這會依程序的性質不同而有所差別。?

對一個本身就是可獨立執行的程序來說，我們會找啟動程序的主要函式，例如對C/C++來說就是main()，而對Java來說，便是static void main()。在找到入口后，再逐一追蹤，摸索出系統的架構。?

但有時，我們所欲閱讀的程序代碼是類別庫或函式庫，它只是用來提供多個類別或函式供客戶端程序（Client Program）使用，本身并不具單一入口，此類的程序代碼具有多重的入口──每個允許客戶端程序呼叫的函式或類別，都是它可能的入口。?

例如，對WinAmp的iPod Plug-In來說，它是一個DLL形式的函式庫，所以當我們想了解它的架構時，必須要先找出它對外提供的函式，而對Windows DLL來說，對外提供的函式，皆會以dllexport這個關鍵詞來修飾。所以，不論是利用grep或gtags之類的工具，我們可以很快從原始碼中，找 到它只有一個DLL函式（這對我們而言，真是一個好消息），而這個函式便是上述的winampGetMediaLibraryPlugin。?

系統多會采用相同的架構處理Plug-In程序?

如果經驗不夠的話，也許無法直接猜出這個函式的作用。?

不過，如果你是個有經驗的程序人，多半能從函式所回傳的結構，猜出這個函式實際的用途。而事實上，當你已經知道它是一個Plug-In程序時，就應該要明白，它可能采用的，就是許多系統都采用的相同架構處理Plug-In程序。?

當一個系統采用所謂Plug-In形式的架構時，它通常不會知道它的Plug-In究竟會怎么實作、實作什么功能。它只會規范Plug-In程序需要滿足某個特定接口。當系統初始化時，所有的Plug-In都可以依循相同的方式，向系統注冊，合法宣示自己的存在。?

雖然系統并不確切知道Plug-In會有什么行為展現，但是因為它制定了一個標準的接口，所以系統仍然可以預期每個Plug-In能夠處理的動作類型。這些動作具體上怎么執行，對系統來說并不重要。這也正是面向對象程序設計中的「多型」觀念。?

隨著實務經驗，歸納常見的架構模式?

我想表達的重點，是當你「涉世越深」之后，所接觸的架構越多，就越能觸類旁通。只需要瞧上幾眼，就能明白系統所用的架構，自然就能夠直接聯想到其中可能存在的角色，以及角色間的關系。?

像上述的Plug-In程序手法，時常可以在許多允許「外掛」程序代碼的系統中看到。所以，有經驗的閱讀者，多半能夠立即反應，知道像Winamp這樣的系統，應該是讓每個Plug-In程序，都寫成DLL函式庫。?

而每個Plug-In的DLL函式庫中，都必須提供winampGetMediaLibraryPlugin()這個函式（如果你熟悉Windows的程 序設計，你會知道這是利用LoadLibrary()和GetProcAddress()來達成的一種多型手法）。如果你熟悉設計模式，你更會知道這是 Simple Factory Method這個設計模式的運用。?

winampGetMediaLibraryPlugin()所回傳的winampMediaLibraryPlugin結構，正好就描述了每個Winamp Plug-In的實作內容。?

善用名稱可加速了解?

利用gtags這個工具，我們立即發現，這個Plug-In它所定義的init、quit、PluginMessageProc這三個名稱，都是函式名稱。這暗示在多型的作用下，它們都是在某些時間點，會由Winamp核心本體呼叫的函式。?

名稱及命名慣例是很重要的。看到「init」，我們會知道它的作用多半是進行初始化的動作，而「quit」大概就是結束時處理函式，而 PluginMessageProc多半就是各種訊息的處理程序（Proc通常是procedure的簡寫，所以PluginMessageProc意指 Plugin Message Procedure）了。?

「望文生義」很重要，我們看到函式的名稱，就可以猜想到它所代表的作用，例如：當Winamp嘗試著初始化一個Plug-In時，它會呼叫這個結構中的 init函式，以便讓每個Plug-In程序有機會初始化自己；當Winamp打算結束自己或結束某個Plug-In的執行時，便會呼叫quit函式。當 Winamp要和Plug-In程序溝通時，它會發送各種不同的訊息至Plug-In，而Plug-In程序必須對此做出回應。?

我們甚至不需要檢視這幾個函式的內容，就可以做出推測，而這樣的假設，事實上也是正確的。?

五、找到程序入口，再由上而下抽絲剝繭?

根據需要決定展開的層數，或展開特定節點，并記錄樹狀結構，然后適度忽略不需要了解的細節─這是一個很重要的態度。因為你不會一次就需要所有的細節，閱讀都是有目的的，每次的閱讀也許都在探索程序中不同的區域。?

探索系統架構的第一步，就是找到程序的入口點。找到入口點后，多半采取由上而下（Top-Down）的方式，由最外層的結構，一層一層逐漸探索越來越多的細節。?

我們的開發團隊曾針對Winamp的iPod plug-in進行閱讀及探索，不僅找到入口點，也找出、并理解它最根本的基礎架構。從這個入口點，可以往下再展開一層，分別找到三個重要的組成及其意義：?

● init()：初始化動作?

● quit()：終止化動作?

● PluginMessageProc()：以訊息的方式處理程序所必須處理的各種事件?

展開的同時，隨手記錄樹狀結構?

當我們從一個入口點找到三個分支后，可以順著每個分支再展開一層，所以分別繼續閱讀init、quit、以及PluginMessageProc的內容，并試著再展開一層。閱讀的同時，你可以在文件中試著記錄展開的樹狀結構。?

● init()：初始化動作?

● itunesdb_init_cc()：建立存取iTunes database的同步對象?

● 初始化數據結構?

● 初始化GUI元素?

● 加載設定?

● 建立log檔?

● autoDetectIpod()：偵測iPod插入的線程?

● quit()：終止化動作?

● itunesdb_del_cc()：終止存取iTunes database的同步對象?

● 關閉log檔?

● 終止化GUI元素?

● PluginMessageProc()：以訊息的方式處理程序所必須面臨的各種事件?

● 執行所連接之iPod的MessageProc()?

這部分必須要留意幾個重點。首先，應該一邊閱讀，一邊記錄文件。因為人的記憶力通常有限，對于陌生的事物更是容易遺忘，因此邊閱讀邊記錄，是很好的輔助。?

再者，因為我們采取由上而下的方式，從一個點再分支出去成為多個點，因此，通常也會以樹狀的方式記錄。除此之外，每次只試著往下探索一層。從init()來看你便會明白。以下試著摘要init()的內容：?

int init() {?

itunesdb_init_cc();?

currentiPod=NULL;?

iPods = new C_ItemList;?

…略?

conf_file=(char*)SendMessage(plugin.hwndWinampParent,WM_WA_IPC,0,IPC_GETINIFILE);?

m_treeview = GetDlgItem(plugin.hwnd LibraryParent,0x3fd);?

//this number is actually magic

…略?

g_detectAll = GetPrivateProfileInt("ml_ipod", "detectAll",0,conf_file)!=0;?

…略?

g_log=GetPrivateProfileInt("ml_ipod","log",0,conf_file)!=0;?

…略?

g_logfile=fopen(g_logfilepath,"a");?

…略?

autoDetectIpod();?

return 0;?

}?

因為我們只試著多探索一層，而目的是希望發掘出下一層的子動作。所以在init()中看到像「itunesdb_init_cc();」這樣的函數調用動作時，我們知道它是在init()之下的一個獨立子動作，所以可以直接將它列入。但是當看到如下的程序行：?

currentiPod=NULL;?

iPods = new C_ItemList;?

我們并不會將它視為init()下的一個獨立的子動作。因為好幾行程序，才構成一個具有獨立抽象意義的子動作。例如以上這兩行構成了一個獨立的抽象意義，也就是初始化所需的數據結構。?

理論上，原來的程序撰寫者，有可能撰寫一個叫做init_data_structure()的函式，包含這兩行程序代碼。這樣做可讀性更高，然而基于種種 理由，原作者并沒有這么做。身為閱讀者，必須自行解讀，將這幾行合并成單一個子動作，并賦予它一個獨立的意義──初始化數據結構。?

無法望文生義的函式，先試著預看一層?

對于某些不明作用的函式叫用，不是望其文便能生其義的。當我們看到「itunesdb_init_cc()」這個名稱時，我們或許能從 「itunesdb_init」的字眼意識到這個函式和iPod所采用的iTunes database的初始化有關，但「cc」卻實在令人費解。為了理解這一層某個子動作的真實意義，有時免不了要往前多看一層。?

原來它是用來初始化同步化機制用的對象。作用在于這程序一定是用了某個內部的數據結構來儲存iTunes database，而這數據結構有可能被多線程存取，所以必須以同步對象（此處是Windows的Critical Section）加以保護。?

所以說，當我們試著以樹狀的方式，逐一展開每個動作的子動作時，有時必須多看一層，才能真正了解子動作的意義。因為有了這樣的動作，我們可以在展開樹狀結 構中，為itunesdb_init_cc()附上補充說明：建立存取itunes database的同步對象。這么一來，當我們在檢視自己所寫下的樹狀結構時，就能輕易一目了然的理解每個子動作的真正作用。

根據需要了解的粒度，決定展開的層數?

我們究竟需要展開多少層呢？這個問題和閱讀程序代碼時所需的「粒度（Granularity）」有關。如果我們只是需要概括性的了解，那么也許展開兩層或三層，就能夠對程序有基礎的認識。倘若需要更深入的了解，就會需要展開更多的層次才行。?

有時候，你并不是一視同仁地針對每個動作，都展開到相同深度的層次。也許，你會基于特殊的需求，專門針對特定的動作展開至深層。例如，我們閱讀 Winamp iPod plug-in的程序目錄，其實是想從中了解究竟應該如何存取iPod上的iTunes DB，使我們能夠將MP3歌曲或播放列表加至此DB中，并于iPod中播放。?

當我們層層探索與分解之后，找到了parseIpodDb()，從函式名稱判斷它是我們想要的。因為它代表的正是parse iPod DB，正是我們此次閱讀的重點，也就達成閱讀這程序代碼的目的。?

我們強調一種不同的做法：在閱讀程序代碼時，多半采取由上而下的方式；而本文建議了一種記錄閱讀的方式，就是試著記錄探索追蹤時層層展開的樹狀結構。你可 以視自己需要，了解的深入程度，再決定要展開的層數。你更可以依據特殊的需要，只展開某個特定的節點，以探索特定的細目。?

適度地忽略不需要了解的細節，是一個很重要的態度，因為你不會一次就需要所有的細節，閱讀都是有目的的。每次的閱讀也許都在探索程序中不同的區域；而每次探索時，你都可以增補樹狀結構中的某個子結構。漸漸地，你就會對這個程序更加的了解。?

六、閱讀的樂趣：透過程序代碼認識作者?

即便每個人的寫作模式多半受到他人的影響，程序人通常還是會融合多種風格，而成為自己獨有的特色，如果你知道作者程序設計的偏好，閱讀他的程序代碼就更得心應手。?

閱讀程序代碼時，多半會采取由上而下、抽絲剝繭的方式。透過記錄層層展開的樹狀結構，程序人可以逐步地建立起對系統的架構觀，而且可以依照需要的粒度（Granularity），決定展開的層次及精致程度。?

建立架構觀點的認識是最重要的事情。雖然這一系列的文章前提為「閱讀他人的程序代碼」，但我們真正想做的工作，并不在于徹底地詳讀每一行程序代碼的細節， 而是想要透過重點式的程序代碼「摘讀」，達到對系統所需程度的了解。每個人在閱讀程序代碼的動機不盡相同，需要了解的程度也就有深淺的分別。只有極為少數 的情況下，你才會需要細讀每一行程序代碼。?

閱讀程序代碼是新時代程序人必備的重要技能?

這一系列的文章至此已近尾聲，回顧曾探討的主題，我們首先研究了閱讀程序代碼的動機。尤其在開放原始碼的風氣如此之盛的情況下，妥善利用開放原始碼所提供 的資源，不僅能夠更快學習到新的技術，同時在原始碼版權合適時，還可以直接利用現成的程序代碼，大幅地提高開發階段的生產力。所以，閱讀程序代碼儼然成為 了新時代程序人必備的重要技能之一。?

接著，我們提到了閱讀程序代碼前的必要準備，包括了對程序語言、命名慣例的了解等等。在此之后，我們反復提起了「由上而下」的閱讀方向的重要性。?

由上而下的閱讀方式，是因為我們重視架構更勝于細節。從最外層的架構逐一向內探索，每往內探索一層，我們了解系統的粒度就增加了一個等級。當你識別出系統 所用的架構時，便能夠輕易了解在這個架構下會有的角色，以及它們之間的動態及靜態的關系。如此一來，許多信息便不言可喻，毋需額外花費力氣，便能夠快速理 解。?

好的名稱能夠摘要性地點出實體的作用?

追蹤原始碼時，固然可以用本來的方式，利用編輯器開啟所需的檔案，然后利用編輯器提供的機制閱讀，但是倘若能夠善用工具，閱讀程序代碼的效率及質量都能大大提升。在本系列文章中，我們介紹了一些工具，或許你還可以在坊間找到其他更有用的工具。?

我在這一系列的文章中，實際帶著大家閱讀、追蹤了一個名為ml_pod的開放原始碼項目。它是一個Winamp的iPod plug-in程序。在追蹤的過程中，我們試著印證這一系列文中所提到的觀念及方法。我們采用逐漸開展的樹狀結構來記錄追蹤的過程，并藉以建立起對系統的 概觀認識。?

就原始碼的閱讀來說，之前的討論涉及了工具面及技巧面。但還有一些主題不在這兩個范疇之內，例如，善用名稱賦予你的提示。名稱做為隱喻 （Metaphor）的作用很大，好的名稱能夠摘要性地點出實體的作用，例如我們看到autoDetectIpod()，自然而然能夠想象它的作用在于自 動（Auto）偵測（Detect）iPod的存在。?

我們在展開樹狀結構時，有時候需要預看一層，有時卻不需要這么做，便可得到印證。程序人都會有慣用的名稱以及組合名稱的方法，倘若能夠從名稱上理解，便毋 需鉆進細節，可以省去相當多的時間。例如，當我們看到parseIpodDb()時，便可以輕易了解它是剖析（Parse）iPod的數據庫（DB），因 此便不需要立即鉆進parseIpodDb()中查看底細。?

盡管如此，能否理解程序人命名的用意，和自身的經驗以及是否了解原作者的文化背景，是息息相關的。?

命名本身就是一種文化產物。不同的程序人文化，就會衍生出不同的命名文化。當你自己的經驗豐富，看過及接觸過的程序代碼也多時，對于名稱的感受及聯想的能力自然會有不同。?

這種感受和聯想的能力，究竟應該如何精進，很難具體描述。就我個人的經驗，多觀察不同命名體系的差異，并且嘗試歸納彼此之間的異同，有助于更快地提升對名稱的感受及聯想力。?

轉換立場，理解作者的思考方式?

除了工具及技巧之外，「想要閱讀程序代碼，得先試著閱讀寫這個程序代碼的程序人的心?！惯@句話說來十分抽象，或許也令人難以理解。?

當你在閱讀一段程序代碼時，或許可以試著轉換自己的立場，從旁觀者的角度轉換成為寫作者的心態，揣摩原作者的心理及處境。當你試著設身處地站在他的立場，透過他的思考方式來閱讀、追蹤他所寫下的程序代碼，將會感覺更加流暢。?

許多軟件項目，都不是由單一程序人所獨力完成。因此，在這樣的項目中，便有可能呈現多種不同的風格。?

許多項目會由架構師決定主體的架構及運作，有既定實施的命名慣例，及程序設計需要遵守方針。在多人開發的模式下，越是好的軟件項目，越看不出某代碼段究竟是由誰所寫下的。?

不過，有些開放原始碼的項目，往往又整合了其他開放原始碼的項目。有的時候，也很難求風格的統一，便會出現混雜的情況。好比之前提到的ml_pod項目，因為程序代碼中混合了不同的來源，而呈現風格不一致的情況。?

我在閱讀非自己所寫的程序代碼時，會觀察原作者寫作的習慣，藉以對應到腦中所記憶的多種寫作模型。在閱讀的過程中，讀完幾行程序代碼，我會試著猜想原作者 在寫下這段程序代碼時的心境。他寫下這段程序代碼的用意是什么？為什么他會采取這樣的寫法？順著原作者的思考理路閱讀，自己的思考才能更貼近對方寫作當時 的想法。?

當你短暫化身為原作者時，才能更輕易的理解他所寫下的程序代碼。?

如果你能知道原作者的背景，程序設計時的偏好，閱讀他的程序代碼，就更能得心應手了。?

從程序代碼著手認識作者獨有的風格，進而見賢思齊?

我在閱讀別人寫下的程序代碼時，我會試著猜想，原作者究竟是屬于那一種「流派」呢？每個人都有自己獨特的寫作模式，即便每個人的寫作模式多半受到他人的影 響──不論是書籍的作者、學習過程中的指導者，或一同參與項目的同儕，但每個程序人通常會融合多種風格，而成為自己獨有的風格。?

面向對象的基本教義派，總是會以他心中覺得最優雅的面向對象方式來撰寫程序。而閱讀慣用、善用設計模式的程序人所寫下的程序代碼時，不難推想出他會在各種常見的應用情境下，套用哪些模式。?

有些時候，在閱讀之初，你并不知道原作者的習性跟喜好，甚至你也不知道他的功力。但是，在閱讀之后，你會慢慢地從一個程序人所寫下的程序代碼，開始認識他。?

你或許會在閱讀他人的程序代碼時，發現令人拍案叫絕的技巧或設計。你也有可能在閱讀的同時，發現原作者所留下的缺失或寫作時的缺點，而暗自警惕于心。這也算是閱讀他人程序代碼時的一項樂趣。?

?? 當你從視閱讀他人的程序代碼為畏途，轉變成為可以從中獲取樂趣的時候，我想，你又進到了另一個境界。

?提問/互動請留言，可直接在最底右下方"寫留言即可"

?如果覺得寫得不錯請點擊“訂閱”，每天更新全新的內容！

?你們的喜歡和關注就是我最大的動力支撐！！！

轉載于:https://www.cnblogs.com/lxxl1234/p/9267921.html

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的如何快速理解读懂他人代码（下）——技巧学习篇的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。