原文網址：http://www.ibm.com/developerworks/cn/java/j-lo-agile/index.html
敏捷開發中高質量 Java 代碼開發實踐
簡介： 本文將介紹在敏捷開發過程中如何通過採取一系列的步驟來保證和提高整個項目的代碼質量，闡述了每一步可以利用的工具和最佳實踐，從而使開發過程更加規範化，成就高質量的代碼。
<!-- <p class="ibm-no-print"> <div id="dw-tag-this" class="ibm-no-print"></div> <div id="interestShow" class="ibm-no-print"></div> </p> -->發佈日期： 2010 年 2 月 11 日
級別： 初級 <!-- <br /><b>建議:</b> <span id="nCmts"><img alt="" src="//www.ibm.com/developerworks/i/circle-preloader.gif" mce_src="http://www.ibm.com/developerworks/i/circle-preloader.gif" height="12" width="50" /><img alt="" src="//www.ibm.com/i/gif" mce_src="http://www.ibm.com/i/gif" height="14" width="1" /></span> --><!-- Rating_Area_Begin --><!-- Ensure that div id is based on input id and ends with -widget -->
平均分 （共 39 個評分 ）
<!-- dW_Summary_Area_END --><!-- CONTENT_BODY -->
Java 項目開發過程中，由於開發人員的經驗、代碼風格各不相同，以及缺乏統一的標準和管理流程，往往導致整個項目的代碼質量較差，難於維護，需要較大的測試投入和週期等問題。這些問題在一個項目組初建、需求和設計均具有不完全可預期性和完備性的全新項目中將尤爲突出。本文將結合敏捷開發週期短，變化快等特點，介紹如何通過在開發過程中採取一系列步驟來保證和提高整個開發團隊的代碼質量，並闡述了每一步可以利用的工具和最佳實踐，從而使開發過程更加規範化，成就高質量的代碼，減少測試的投入，並促進整個團隊的技能提高，最終提高開發效率和質量。
如圖 1 所示，敏捷開發過程經歷需求調研，用例分析和用例分解，進入開發迭代階段。在每個迭代過程中，可以採用以下五個步驟來保證和提高整個項目的代碼質量：統一編碼規範、代碼樣式；靜態代碼分析（static code review）；單元測試；持續集成；代碼評審和重構（Review & Refactor）。下文將針對每個步驟和其所使用的工具、方法進行詳細描述。
圖 1. 敏捷開發中的 Java 代碼質量保證步驟
圖 1. 敏捷開發中的 Java 代碼質量保證步驟
規範統一的編碼會增加項目代碼的可讀性和可維護性，但實際情況往往是項目組內的 Java 代碼開發人員的編碼風格常常各不相同，這可能是由於不同的經驗習慣或者缺乏編碼規範方面的學習造成的。這樣一來，其他項目成員或者維護人員在閱讀項目代碼時就需要花費更多的時間來理解代碼作者的意圖，所以制定並採取統一的編碼規範就顯得很重要。編碼規範主要應包含以下幾個方面：
- 一般規則和格式規範。例如代碼縮進、程序塊規範、每行最大代碼長度等。
- 命名規則。例如包名、類名、變量、方法、接口、參數等命名規範
- 文檔規範。例如類文件頭聲明、類註釋、成員變量和方法註釋等規範。
- 編程規範。例如異常、併發、多線程等方面的處理方式。
- 其他規範。例如日誌格式、屬性文件格式，返回值和消息格式。
項目的編碼規範可以參考已有的一些 Java 編程規範書籍和其他相關資料並結合項目的本身來制定，可供參考的書籍有《 Java 編程風格》（英文書名爲：The Elements of Java Style）。編碼規範要形成文檔，而且要簡潔明瞭，並組織項目成員一起學習，確保所有成員正確理解所有條目。
一旦編碼規範確定，就可以利用 Eclipse 自身提供的功能來控制代碼樣式和格式。具體做法是，點擊 Eclipse 的 Windows -> Preference 菜單項，在打開的 Preferences 對話框的左側欄中找到 Java 節點下的子項 Code Style（如圖 2），該項和它的子項允許您對 Java 代碼的樣式進行控制。
圖 2. Eclipse 代碼樣式設置窗口
例如，爲了使用自動格式化工具，可以在 Eclipse 提供的默認代碼格式配置的基礎上建立自定義的格式。在 Formatter 面板中，點擊 New，輸入新的名字並選擇一個默認的配置作爲初始化格式，如圖 3 所示。
圖 3. 創建新的代碼格式配置
單擊 OK 後就可以在新打開的窗口中進行修改定製自己需要的格式。如圖 4 所示。
圖 4. 創建新的代碼格式配置
修改完成後點擊 Apply 保存所作修改。同時可以點擊 Export 將當前的格式定義導出成一個 XML 文件，這樣項目組的其他成員就可以很方便通過點擊圖 3 中的 Import 按鈕來導入該 XML 文件來使用同一個代碼格式定義。
這樣每次在提交代碼到版本控制服務器前就可以通過 Eclipse 界面裏的 Source->Format 菜單來對代碼進行格式化，從而使整個項目的代碼具有相同的格式。同樣可以通過對 Code Style 下的其他項目進行設置來幫助對 Java 代碼的樣式進行控制。將所有這些樣式文件導出成 XML 文件後，同編碼規範一起歸檔，供所有項目成員使用。
在完成源代碼的開發以後，下面要進行的工作就是審視和測試代碼。除了通過運行測試代碼來檢查功能之外，還能利用一些靜態分析工具來快速、直接地提高代碼質量。靜態代碼分析工具並不需要運行代碼，可以直接對 Java 文件和 Class 文件進行分析，通過一些檢查條件的設置，快速找到代碼中的錯誤和潛在缺陷。現在的靜態分析工具很多，有 FindBugs、PMD、IBM Rational Tool，等等。在這裏，選擇 FindBugs 作爲靜態代碼分析工具。FindBugs 可以和日常開發工具 Eclipse 進行集成，在開發過程中，就可以方便的開始靜態代碼的檢查。通過檢查 Class 文件或者 JAR 文件，將字節碼和一組缺陷模式進行對比，來發現可能存在的代碼問題。在 Eclipse 的開發環境中，用插件安裝的方式安裝了 Findbugs 後，在 Eclipse 的配置選項中就會多出來 FindBugs 的配置選項。可以對自己的項目進行配置，選擇需要的 Detector 檢查代碼。
圖 5. FindBugs 的配置選項
設置好自己的規則後，在需要檢查的代碼文件夾上點擊右鍵，就可以啓動 FindBugs 檢查。代碼可以是一個項目，也可以只是幾個文件。
圖 6. 運行 FindBugs
檢查完畢後，會出現 FindBugs 視圖，把所有檢查的結果根據錯誤分組展示。點擊結果裏面的每一個錯誤，會自動打開對應的代碼。當根據規則改正了所有的錯誤，或者說潛在錯誤，這些代碼也就通過了靜態代碼檢查。FindBugs 的檢查結果可以是 XML 文件，也可以是文本文件，便於項目的集成管理和檢查保存。
圖 7. FindBugs 檢查結果
單元測試是軟件開發過程中重要的質量保證環節，在此環節中，設計和評審對於保證整個單元測試過程的完整性和有效性來說十分重要。設計階段需要具體考慮要對哪些代碼單元進行測試，被測單元之間的關係，測試策略，以及單元測試用例設計等，並最終輸出《單元測試用例設計》文檔，用來指導具體的單元測試執行。在用例設計中，通過對代碼單元輸入和期待輸出的定義來保證該單元的功能正確性，邊界值的測試和異常測試非常重要。同時也配合測試用例和功能塊的匹配方法來衡量用例設計的完整性。
在用例設計完成之後，下一步的工作就是進行測試用例的評審。個人的理解和經驗始終是有限的，用例評審可以借集體之力，對用例設計進入查漏補缺，進一步保證測試用例的有效性。由於單元測試屬於白盒測試範疇，它主要通過對代碼的邏輯結構進行分析來設計測試用例，因此，評審員的選擇最好以理解代碼邏輯結構爲前提，如果評審員來自相關模塊，還能夠有效的發現模塊相關性和依賴性所帶來的問題。
在實際項目中，開發人員自己的代碼往往需要和其他的代碼模塊或系統進行交互，但在測試的過程中，這些需要被調用的真實對象常常很難被實例化，或者這些對象在某些情況下無法被用來測試，例如，真實對象的行爲無法預測，真實對象的行爲難以觸發，或者真實對象的運行速度很慢。這時候，就需要使用模擬對象技術（Mock），利用一個模擬對象來模擬我們的代碼所依賴的真實對象，來幫助完成測試，提高測試覆蓋率，從而提高代碼質量。模擬對象技術利用了在面向接口的編程中，由於代碼直接對接口進行調用，所以代碼並不知道引用的是真實對象還是模擬對象，這樣就可以順利的完成對代碼的測試。
模擬技術有很多種，如 jMock，EasyMock，Mockito，PowerMock 等等。其中 Mockito 消除了對期望行爲的需求，避免了這些代碼的大量初始化。
圖 8. Mockito 示例
在模擬對象過程中，先模擬一個需要調用的 List 對象 LinkedList，再設定這個對象的行爲，當調用 get(0) 的時候，返回”first”。這樣，測試代碼就可以利用這個對象來測試我們的功能代碼，需要調用和返回值的時候，可以順利的得到模擬對象的返回值。也需要對模擬對象進行錯誤情況的模擬，保證代碼對錯誤的處理的正確性。
爲了衡量單元測試的質量和覆蓋的範圍，需要對單元測試的代碼進行測試覆蓋分析。常用的衡量測試覆蓋率的指標主要有語句覆蓋率、分支覆蓋率、路徑覆蓋率、條件覆蓋率和方法覆蓋率等。具體採用哪些指標可以根據項目的實際情況來定，以避免因過高的指標增加了代碼開發人員的工作量而影響了項目整體的進度。
EMMA 是一款比較流行的開源 Java 測試覆蓋率分析工具，支持類、方法、代碼行、基本代碼塊等多種類型的測試覆蓋率分析，支持將覆蓋率分析結果導出爲多種格式的報告，並採用多種顏色來高亮顯示不同的覆蓋率狀態。EclEmma 是一款基於 EMMA 的 Eclipse 插件，方便在 Eclipse IDE 中進行測試覆蓋率分析。如圖 9，在測試用例寫好後，可以在右鍵點擊測試類，選擇 Coverage As -> JUnit Test.
圖 9. 運行測試覆蓋分析
單元測試跑完後，Coverage視圖中會顯示所選擇的測試的覆蓋率。雙擊打開某一具體的類後，可以看到高亮顯示的覆蓋分析結果，如圖 10 所示。紅色代表測試沒有覆蓋到該行，黃色表示部分覆蓋，綠色的行表示該行在本次測試中被覆蓋到。
圖 10. 查看測試覆蓋分析結果
在 Coverage 視圖中可以通過點擊鼠標右鍵將測試覆蓋分析的結果導出成需要的格式，例如 HTML。
圖 11. 導出測試覆蓋分析結果
圖 12 顯示了導出的 report。
圖 12. 測試覆蓋分析報告
爲了保證單元測試的有效性和質量，可以規定一個測試覆蓋率的下限，例如所有的包和類的覆蓋率必須達到 80% 以上。不過值得注意的是，不要單純追求高覆蓋率，要同時注意測試用例的質量，如果測試用例本身就寫的有錯誤，那麼即使測試覆蓋率很高也沒有意義。
持續集成（Continuous Integration）是利用一系列的工具，方法和規則，做到快速的構建開發代碼，自動的測試化，來提高開發代碼的效率和質量。利用自動構建工具，隨時都能把提交的代碼構建出來，提供一個可以測試使用的版本，讓用戶和開發人員同時看到相同的功能，儘早的發現問題和錯誤，也可以儘快的得到測試人員和用戶的反饋。
要做到持續集成，就要利用一系列工具，把開發過程中的重複工作自動化。搭建自動的構建服務器，自動的進行單元測試和發佈新版本，一個集成的服務器可以提供構建過程的結果報告，自動通知開發人員構建結果，並且保存歷史數據。IBM Rational Team Concert (RTC) 可以提供工作任務的管理，項目計劃的安排，代碼版本管理控制，自動構建可用版本，生成構建結果報告。這些過程構成了項目的持續集成過程，其中，版本的自動構建和代碼的自動單元測試是持續集成的關鍵過程，RTC 在這些過程上提供了有力的支持。
RTC 提供了 build engine 來負責構建 build，首選，啓動 build engine，並和 RTC 服務器建立了連接。再創建項目的 build 定義。在這個定義中，需要設定編譯哪些模塊的代碼，需要跳動哪個 ANT 文件來啓動編譯，和一些編譯過程中的參數的設定。當這些都準備好了，編譯對於項目而言，就變成一個簡單的事情。
可以看到，通過在 build 定義上，點擊請求構建，就可以觸發一次構建過程。選擇需要的構建參數，這個過程就會在後臺運行。每一個開發人員，做了稍許的代碼改變和提交，都可以觸發新的構建過程，來保證我們代碼的有效性。申請一個新的構建的過程如圖 13、圖 14 所示。
圖 13. 申請一個新的構建
圖 14. 構建申請界面
當構建結束後。RTC 服務器會提供構建結果報告。開發人員可以查詢到這次構建的詳細信息。
圖 15. 構建結果
整個開發過程中，構建版本的過程應該是無數次的，通過每次構建，都可以得到當時代碼的編譯情況，並且可以得到一個可運行的軟件版本。在構建定義上，RTC 支持設置構建計劃。定時自動的觸發一次構建。
圖 16. 構建定義
構建可以自動了，重點提高代碼質量的單元測試呢？如果每一天的代碼，每一個版本的代碼，都已經通過了我們的單元測試，這樣我們就能對代碼的質量有了基本的保證。在構建腳本的自動調用過程中，通過 ANT 的腳本，可以加上 JUnit，EMMA，FindBugs 的 ANT 腳本調用，每一次的構建，都可以把這些檢查工作自動的進行一遍測試。這些測試都要生成測試結果報告， RTC 不能提供這些報告的展示，就可以利用 Hudson 這個開源工具，集成測試報告來方便查閱。
圖 17. 自動測試報告
代碼評審（Code Review）是 Java 項目開發過程中的一個重要步驟，代碼評審可以幫助發現靜態代碼分析過程中無法發現的一些問題，例如代碼的編寫是否符合編碼規範，代碼在邏輯上或者功能上是否存在錯誤，代碼在執行效率和性能上是否有需要改進的地方，代碼的註釋是否完整正確，代碼是否存在冗餘和重複。代碼評審還可以幫助新進入項目組的成員快速學習和了解項目，促進經驗分享，同時也能保證項目成員的良好溝通。代碼評審主要包括兩種形式，同級評審（Peer Review）和小組評審（Group Review）。同級評審主要指項目成員間的互相評審，小組評審是指通過召開評審會議，項目成員一起對項目代碼進行評審。
爲了提高代碼評審的有效性和效率，可以藉助一些外部工具，比較常用的代碼評審工具有 Jupiter 和 Code Striker。Jupiter 是一款開源的 Eclipse 插件，允許成員將評審意見定位到真實代碼的具體行，由於代碼評審的結果以 XML 文件的形式保存，所以可以把結果提交到版本管理服務器進行共享。圖 18 顯示了使用 Jupiter 進行代碼評審的界面。
圖 18. Jupiter 代碼評審界面
在代碼評審任務創建後，Jupiter 將代碼評審分成三個階段，個人評審階段 (Individual Phase)、團隊評審階段（Team Phase）和問題修復階段（Rework Phase）。在個人評審階段，評審成員將發現的代碼問題或者缺陷記錄下來，每個問題都會作爲一個記錄保存在評審表格中。在團隊評審階段，團隊的全部或者部分成員會一起對個人評審階段發現的問題進行定性，如果問題確實存在，就將該問題分配給某個成員去解決，並在 Jupiter 中將該問題設置成相應的狀態。在問題修復階段，團隊成員會修復屬於自己的問題，並將相應的記錄設置成已解決等正確的狀態。
Codestriker 是一款基於 Web 的常用代碼評審工具，對代碼的評審可以針對某一具體行，也可以針對整個代碼文件，評審意見會被保存在數據庫中。評審人員可以同時看到其他人的評論，代碼作者也可以針對某一具體的評論回覆。Codestriker 支持郵件通知，還可以同版本控制服務器進行集成，以跟蹤和顯示文件內容的改變。圖 19 顯示了 Codestriker 的界面。
圖 19. Codestriker 報告界面
在實踐中對所有代碼進行小組評審會比較費時，所以可以根據實際情況來挑選一些核心代碼進行小組評審，或者在項目的前期安排較多的小組評審，等項目組的成員對代碼評審的標準和要求有較好的理解，進行代碼評審的經驗提高後，就可以逐漸減少小組評審的次數，從而達到大部分代碼即使只進行同級評審也能保證很好的質量。
通過代碼評審發現的問題要通過代碼重構及時解決掉，較小的不涉及多人代碼的重構可以由項目成員自己藉助 Eclipse 的重構功能完成，不同項目成員寫的實現相同功能的不同代碼要通過討論整合成公共的類或者方法。比較複雜的或者比較高層次的重構工作，例如整個項目層面的代碼組織形式的改變需要由整個項目組共同討論完成。
軟件開發沒有一成不變、萬能通用的流程和方法，希望大家能從本文得到啓發和收益，結合您的實際項目特點，實踐以上步驟和方法，並加以完善和改進，共同打造高效高質量的 Java 代碼，爲您的項目成功奠定堅實的基礎。
<!-- CMA ID: 467802 --><!-- Site ID: 10 --><!-- XSLT stylesheet used to transform this file: dw-article-6.0-beta.xsl -->學習
- “敏捷開發空間”（developerWorks，2009 年 11 月）：在這一敏捷開發空間裏，討論的主題將涉及敏捷開發、敏捷測試、敏捷軟件配置管理、敏捷項目管理等與時下流行的敏捷浪潮相關的敏捷技術。
- “敏捷軟件開發基礎：持續集成環境的構建”（developerWorks，2005 年 6 月）：本文中，作者將介紹如何構建持續集成所需要的環境。
- “確定組織是否真正敏捷的五種方法”（developerWorks，2007 年 12 月）：通過本文了解如何通過使用五個關鍵預測指標，檢驗組織是否缺乏真正的敏捷性。
- 訪問 Eclipse 站點，查看 Eclipse 相關信息。
- 參考 EMMA 和 EclEmma 站點，瞭解更多關於 EMMA 和 EclEmma 的信息。
- 訪問 FindBugs 首頁，瞭解更多關於 FindBugs 的信息。
- 訪問 IBM Rational Team Concert 產品專區，瞭解更多關於 Rational Team Concert 的信息。
- 查看 jupiter-eclipse-plugin 站點，獲得更多使用 Jupiter 進行代碼審查的信息。
- 參考 Codestriker 主頁，瞭解如何使用 Codestriker 進行代碼審查。
- 訪問 Hudson 站點，學習如何利用 Hudson 進行持續集成。
-
技術書店：瀏覽關於這些和其他技術主題的圖書。
-
developerWorks Java 技術專區：數百篇關於 Java 編程各個方面的文章。
討論
- 加入 developerWorks 社區。
- 查看 developerWorks 博客 的最新信息。