Posted on 2012-05-22 23:12
dennis 閱讀(25589)
評(píng)論(9) 編輯 收藏 所屬分類:
模式與架構(gòu) 、
源碼解讀
你有個(gè)任務(wù)，需要用到某個(gè)開源項(xiàng)目;或者老大交代你一個(gè)事情，讓你去了解某個(gè)東西。怎么下手呢？如何開始呢？我的習(xí)慣是這樣：
1.首先，查找和閱讀該項(xiàng)目的博客和資料，通過google你能找到某個(gè)項(xiàng)目大體介紹的博客，快速閱讀一下就能對(duì)項(xiàng)目的目的、功能、基本使用有個(gè)大概的了解。
2.閱讀項(xiàng)目的文檔，重點(diǎn)關(guān)注類似Getting started、Example之類的文檔，從中學(xué)習(xí)如何下載、安裝、甚至基本使用該項(xiàng)目所需要的知識(shí)。
3.如果該項(xiàng)目有提供現(xiàn)成的example工程，首先嘗試按照開始文檔的介紹運(yùn)行example，如果運(yùn)行順利，那么恭喜你順利開了個(gè)好頭;如果遇到問題，首先嘗試在項(xiàng)目的FAQ等文檔里查找答案，再次，可以將問題（例如異常信息）當(dāng)成關(guān)鍵詞去搜索，查找相關(guān)的解決辦法，你遇到了，別人一般也會(huì)遇到，熱心的朋友會(huì)記錄下解決的過程;最后，可以將問題提交到項(xiàng)目的郵件列表，請(qǐng)大家?guī)湍憧纯础?strong>在沒有成功運(yùn)行example之前，不要嘗試修改example。
4.運(yùn)行了第一個(gè)example之后，嘗試根據(jù)你的理解和需要修改example，測(cè)試高級(jí)功能等。
5.在了解基本使用后，需要開始深入的了解該項(xiàng)目。例如項(xiàng)目的配置管理、高級(jí)功能以及最佳實(shí)踐。通常一個(gè)運(yùn)作良好的項(xiàng)目會(huì)提供一份從淺到深的用戶指南，你并不需要從頭到尾閱讀這份指南，根據(jù)時(shí)間和興趣，特別是你自己任務(wù)的需要，重點(diǎn)閱讀部分章節(jié)并做筆記（推薦evernote）。
6.如果時(shí)間允許，嘗試從源碼構(gòu)建該項(xiàng)目。通常開源項(xiàng)目都會(huì)提供一份構(gòu)建指南，指導(dǎo)你如何搭建一個(gè)用于開發(fā)、調(diào)試和構(gòu)建的環(huán)境。嘗試構(gòu)建一個(gè)版本。
7.如果時(shí)間允許并且有興趣，可以嘗試閱讀源碼：
（1）閱讀源碼之前，查看該項(xiàng)目是否提供架構(gòu)和設(shè)計(jì)文檔，閱讀這些文檔可以了解該項(xiàng)目的大體設(shè)計(jì)和結(jié)構(gòu)，讀源碼的時(shí)候不會(huì)無(wú)從下手。
（2）閱讀源碼之前，一定要能構(gòu)建并運(yùn)行該項(xiàng)目，有個(gè)直觀感受。
（3）閱讀源碼的第一步是抓主干，嘗試?yán)砬逡淮握＿\(yùn)行的代碼調(diào)用路徑，這可以通過debug來(lái)觀察運(yùn)行時(shí)的變量和行為。修改源碼加入日志和打印可以幫助你更好的理解源碼。
（4）適當(dāng)畫圖來(lái)幫助你理解源碼，在理清主干后，可以將整個(gè)流程畫成一張流程圖或者標(biāo)準(zhǔn)的UML圖，幫助記憶和下一步的閱讀。
（5）挑選感興趣的“枝干”代碼來(lái)閱讀，比如你對(duì)網(wǎng)絡(luò)通訊感興趣，就閱讀網(wǎng)絡(luò)層的代碼，深入到實(shí)現(xiàn)細(xì)節(jié)，如它用了什么庫(kù)，采用了什么設(shè)計(jì)模式，為什么這樣做等。如果可以，debug細(xì)節(jié)代碼。
（6）閱讀源碼的時(shí)候，重視單元測(cè)試，嘗試去運(yùn)行單元測(cè)試，基本上一個(gè)好的單元測(cè)試會(huì)將該代碼的功能和邊界描述清楚。
（7）在熟悉源碼后，發(fā)現(xiàn)有可以改進(jìn)的地方，有精力、有意愿可以向該項(xiàng)目的開發(fā)者提出改進(jìn)的意見或者issue，甚至幫他修復(fù)和實(shí)現(xiàn)，參與該項(xiàng)目的發(fā)展。
8.通常在閱讀文檔和源碼之后，你能對(duì)該項(xiàng)目有比較深入的了解了，但是該項(xiàng)目所在領(lǐng)域，你可能還想搜索相關(guān)的項(xiàng)目和資料，看看有沒有其他的更好的項(xiàng)目或者解決方案。在廣度和深度之間權(quán)衡。
以上是我個(gè)人的一些習(xí)慣，我自己也并沒有完全按照這個(gè)來(lái)，但是按照這個(gè)順序，基本上能讓你比較高效地學(xué)習(xí)和使用某個(gè)開源項(xiàng)目。