CodeReview簡介

1、Code Review簡介1 Code Review的目的凡事知其然還要知其所以然，我們首先需要知道什么是Code Review和我們使用它的目的是什么。Code Review是一種用來確認(rèn)方案設(shè)計和代碼實現(xiàn)的質(zhì)量保證機制，通過這個機制我們可以對代碼，測試過程和注釋進行檢查。Code Review主要用來在軟件工程過程中改進代碼質(zhì)量，通過Code Review可以達到如下目的：在項目早期就能夠發(fā)現(xiàn)代碼中的BUG幫助初級開發(fā)人員學(xué)習(xí)高級開發(fā)人員的經(jīng)驗，達到知識共享避免開發(fā)人員犯一些很常見，很普通的錯誤保證項目組人員的良好溝通項目或產(chǎn)品的代碼更容易維護2 Code Review的前提知道了Code

2、 Review的目的，我們就可以看看如何做Code Review了，但在做Code Review前我們還有事要做，所謂預(yù)則立，不預(yù)則廢，就是說如果在進入Code Review之前我們不做些準(zhǔn)備工作，Code Review很容易就變得沒有意義或是流于形式，這在我們周圍是有很多例子的啊。進入Code Review需要檢查的條件如下：a)       Code Review人員是否理解了Code Review的概念和Code Review將做什么如果做Code Review的人員不能理解Code Review對項目成敗和代碼質(zhì)量的重要程度，

3、他們的做法可能就會是應(yīng)付了事。b)      代碼是否已經(jīng)正確的build，build的目的使得代碼已經(jīng)不存在基本語法錯誤我們總不希望高級開發(fā)人員或是主管將時間浪費在檢查連編譯都通不過的代碼上吧。c)      代碼執(zhí)行時功能是否正確Code Review人員也不負(fù)責(zé)檢查代碼的功能是否正確，也就是說，需要復(fù)查的代碼必須由開發(fā)人員或質(zhì)量人員負(fù)責(zé)該代碼的功能的正確性。d)      Review人員是否理解了代碼做復(fù)查的人員需要對該代碼有一個基本的了

4、解，其功能是什么，是拿一方面的代碼，涉及到數(shù)據(jù)庫或是通訊，這樣才能采取針對性的檢查e)       開發(fā)人員是否對代碼做了單元測試這一點也是為了保證Code Review前一些語法和功能問題已經(jīng)得到解決，Code Review人員可以將精力集中在代碼的質(zhì)量上。3 Code Review需要做什么好了，進入條件準(zhǔn)備好了，有人在這些條件中看到Code Review這也不負(fù)責(zé)，那也不檢查，不禁會問，Code Review到底做什么？其實Code Review主要檢查代碼中是否存在以下方面問題：代碼的一致性、編碼風(fēng)格、代碼的安全問題、代碼冗余

5、、是否正確設(shè)計以滿足需求（性能、功能等等），下邊我們一一道來。以下內(nèi)容參考了Software Quality Assurance: Documentation and Reviews一文中的代碼檢查部分。31完整性檢查（Completeness）代碼是否完全實現(xiàn)了設(shè)計文檔中提出的功能需求代碼是否已按照設(shè)計文檔進行了集成和Debug代碼是否已創(chuàng)建了需要的數(shù)據(jù)庫,包括正確的初始化數(shù)據(jù)代碼中是否存在任何沒有定義或沒有引用到的變量、常數(shù)或數(shù)據(jù)類型32一致性檢查（Consistency）代碼的邏輯是否符合設(shè)計文檔代碼中使用的格式、符號、結(jié)構(gòu)等風(fēng)格是否保持一致33正確性檢查（Correctness）代碼是

6、否符合制定的標(biāo)準(zhǔn)所有的變量都被正確定義和使用所有的注釋都是準(zhǔn)確的所有的程序調(diào)用都使用了正確的參數(shù)個數(shù)34可修改性檢查（Modifiability）代碼涉及到的常量是否易于修改(如使用配置、定義為類常量、使用專門的常量類等)代碼中是否包含了交叉說明或數(shù)據(jù)字典，以描述程序是如何對變量和常量進行訪問的代碼是否只有一個出口和一個入口（嚴(yán)重的異常處理除外）35可預(yù)測性檢查（Predictability）代碼所用的開發(fā)語言是否具有定義良好的語法和語義是否代碼避免了依賴于開發(fā)語言缺省提供的功能代碼是否無意中陷入了死循環(huán)代碼是否是否避免了無窮遞歸36健壯性檢查（Robustness）代碼是否采取措施避免運行時

7、錯誤（如數(shù)組邊界溢出、被零除、值越界、堆棧溢出等）37結(jié)構(gòu)性檢查（Structuredness）程序的每個功能是否都作為一個可辯識的代碼塊存在循環(huán)是否只有一個入口38可追溯性檢查（Traceability）代碼是否對每個程序進行了唯一標(biāo)識是否有一個交叉引用的框架可以用來在代碼和開發(fā)文檔之間相互對應(yīng)代碼是否包括一個修訂歷史記錄，記錄中對代碼的修改和原因都有記錄是否所有的安全功能都有標(biāo)識39可理解性檢查（Understandability）注釋是否足夠清晰的描述每個子程序是否使用到不明確或不必要的復(fù)雜代碼，它們是否被清楚的注釋使用一些統(tǒng)一的格式化技巧（如縮進、空白等）用來增強代碼的清晰度是否在定義

8、命名規(guī)則時采用了便于記憶，反映類型等方法每個變量都定義了合法的取值范圍代碼中的算法是否符合開發(fā)文檔中描述的數(shù)學(xué)模型310可驗證性檢查(Verifiability)代碼中的實現(xiàn)技術(shù)是否便于測試二、Code Review經(jīng)驗檢查項以下是在實踐中建立的檢查列表（checklist），通過分類和有針對性的檢查項，保證了Code Review可以有的放矢。1 JAVA編碼規(guī)范方面檢查項檢查項參照J(rèn)AVA編碼規(guī)范執(zhí)行，見JAVA編碼規(guī)范(Java Code Conventions)2 面向?qū)ο笤O(shè)計方面檢查項這幾點的范圍都很大，不可能在本文展開討論，有專門的書籍介紹這方面問題，當(dāng)然在Code Review中

9、主要靠經(jīng)驗來判斷。A)       類設(shè)計和抽象是否合適B)        是否符合面向接口編程的思想C)       是否采用合適的設(shè)計范式3 性能方面檢查項性能檢查在大多數(shù)代碼中都是需要嚴(yán)重關(guān)注的方面，也是最容易出現(xiàn)問題的方面，常常有程序員寫出了功能和語法沒有絲毫問題的代碼后，正式運行時卻在性能上表現(xiàn)不佳，從而不得不做大量的返工，甚至是推倒重來。A)    

10、60;  在海量數(shù)據(jù)出現(xiàn)時,隊列,表,文件,在傳輸,upload等方面是否會出現(xiàn)問題,有無控制,如分配的內(nèi)存塊大小,隊列長度等控制參數(shù)B)       對hashtable,vector等集合類數(shù)據(jù)結(jié)構(gòu)的選擇和設(shè)置是否合適，如正確設(shè)置capacity,load factor等參數(shù)，數(shù)據(jù)結(jié)構(gòu)的是否是同步的C)       有無濫用String對象的現(xiàn)象D)       是否采用通用的線程池、對象池模塊等cac

11、he技術(shù)以提高性能E)       類的接口是否定義良好，如參數(shù)類型等，避免內(nèi)部轉(zhuǎn)換F)       是否采用內(nèi)存或硬盤緩沖機制以提高效率G)       并發(fā)訪問時的應(yīng)對策略H)       I/O方面是否使用了合適的類或采用良好的方法以提高性能（如減少序列化，使用buffer類封裝流等）I)     &#

12、160;   同步方法的使用是否得當(dāng),是否過度使用J)         遞歸方法中的疊代次數(shù)是否合適，應(yīng)該保證在合理的?？臻g范圍內(nèi)K)       如果調(diào)用了阻塞方法，是否考慮了保證性能的措施L)        避免過度優(yōu)化，對性能要求高的代碼是否使用profile工具，如Jprobe等4 資源泄漏處理方面檢查項 對于JAVA來說由于存在垃圾收集機制，所以內(nèi)存泄漏不是

13、太明顯，但使用不當(dāng)，仍然存在內(nèi)存泄漏的問題。而對于其它的語言，如C+等在這方面就要嚴(yán)重關(guān)注了。當(dāng)然數(shù)據(jù)庫連接資源不釋放的問題也是廣大程序員最常見的，相信有很多的PM被這個問題折磨的死去活來。A)       分配的內(nèi)存是否釋放，尤其在錯誤處理路徑上（對非JAVA類）B)        錯誤發(fā)生時是否所有的對象被釋放，如數(shù)據(jù)庫連接、Socket、文件等C)       是否同一個對象被釋放多次（對非JAVA類

14、）D)       代碼是否保存準(zhǔn)確的對象reference計數(shù)（對非JAVA類）5 線程安全方面檢查項線程安全問題實際涉及兩個方面，一個是性能，另一個是資源的一致性，我們需要在這兩方面做個權(quán)衡，現(xiàn)在就是到了權(quán)衡利弊的時候了。A)       代碼中所有的全局變量是否是線程安全的B)        需要被多個線程訪問的對象是否線程安全，檢查有無通過同步方法保護C)   

15、0;   同步對象上的鎖是否按相同的順序獲得和釋放以避免死鎖，注意錯誤處理代碼D)       是否存在可能的死鎖或是競爭，當(dāng)用到多個鎖時，避免出現(xiàn)類似情況：線程A獲得鎖1，然后鎖2，線程B獲得鎖2，然后鎖1E)        在保證線程安全的同時，要注意避免過度使用同步，導(dǎo)致性能降低6 程序流程方面檢查項A)       循環(huán)結(jié)束條件是否準(zhǔn)確B)   &#

16、160;    是否避免了死循環(huán)的產(chǎn)生C)       對循環(huán)的處理是否合適，如循環(huán)變量，局部對象，循環(huán)次數(shù)等能夠考慮到性能方面的影響7 數(shù)據(jù)庫處理方面很多Code Review人員在面對代碼中涉及到的數(shù)據(jù)庫可移植性和提高數(shù)據(jù)庫性能方面的沖突時表現(xiàn)的無所適從，凡事很難兩全其美的啊。A)       數(shù)據(jù)庫設(shè)計或SQL語句是否便于移植（注意和性能方面會存在沖突）B)       數(shù)據(jù)庫資源

17、是否正常關(guān)閉和釋放C)       數(shù)據(jù)庫訪問模塊是否正確封裝，便于管理和提高性能D)       是否采用合適的事務(wù)隔離級別E)       是否采用存儲過程以提高性能F)        是否采用PreparedStatement以提高性能8 通訊方面檢查項A)       socket

18、通訊是否存在長期阻塞問題B)       發(fā)送接收的數(shù)據(jù)流是否采用緩沖機制C)       socket超時處理，異常處理D)       數(shù)據(jù)傳輸?shù)牧髁靠刂茊栴}9 JAVA對象處理方面檢查項這個檢查項的基礎(chǔ)是對JAVA對象有較深的理解，但現(xiàn)實是很多看過Thinking in Java的程序員，仍然在程序中無法區(qū)分傳值和傳引用，以及對象和reference的區(qū)別。這或許就是理論和實踐難以結(jié)合的問題啊。正所謂知而不行，

19、非真知也。A)       對象生命周期的處理,是否對象的reference已經(jīng)失效,能夠設(shè)置為null,并被回收B)       在對象的傳值和傳參方面有無問題,對象的clone方法使用是否過度C)       是否大量經(jīng)常的創(chuàng)建臨時對象D)       是否盡量使用局部對象(堆棧對象)E)     

20、60;  在只需要對象reference的地方是否創(chuàng)建了新的對象實例10 異常處理方面檢查項JAVA中提供了方便的異常處理機制，但普遍存在的是異常被捕獲，但并沒有得到處理。我們可以打開一段代碼，最常見的現(xiàn)象是進入某個方法后，一個大的try/catch將所有代碼行括住，然后在catch中將異常打印到控制臺，而且該異常是Exception對象。A)       每次當(dāng)方法返回時是否正確處理了異常，如最簡單的處理，記錄日志到日志文件中B)        是否對數(shù)

21、據(jù)的值和范圍是否合法進行校驗，包括采用斷言（assertion）C)       在出錯路徑上是否所有的資源和內(nèi)存都已經(jīng)釋放D)       所有拋出的異常都得到正確的處理，特別是對子方法拋出的異常，在整個調(diào)用棧中必須能夠被捕捉并處理E)        當(dāng)調(diào)用導(dǎo)致錯誤發(fā)生時，方法的調(diào)用者應(yīng)該得到一個通知F)        不要忘了對錯誤處理部分的代碼進行測試，很多代碼在正常情況下執(zhí)行良好，而一旦出錯，整個系統(tǒng)就崩潰了11 方法（函數(shù)）方面檢查項A)       方法的參數(shù)是否都做了校驗B)