練習 1.2︰執行程式碼複查及套用快速修正
本練習假設您已完成練習 1.1︰匯入必要的資源。在練習中,首先您要閱讀一個使用者實務。然後,假設您扮演使用者實務中所描述的軟體開發人員角色。
使用者實務
大批位在各地的開發人員正在撰寫新的軟體應用程式。開發人員例行性執行程式碼複查來檢查程式碼是否有問題是很重要的。
其中一位開發人員想要執行程式碼複查來查看他的工作成果到底如何。為了複查新撰寫的程式碼以評估在多項範圍中的最佳作法遵守程度,開發人員執行自動快速程式碼複查。這項複查對程式碼套用多個提供的規則種類。每一個規則種類針對特定範圍來檢查程式碼的品質,例如效能。
當程式碼複查完成時,您會看到一份發現項目的清單。每一個發現項目代表未嚴格遵守套用規則的程式碼字串。針對其中一個發現項目會提供快速修正,讓開發人員能套用解決方案並立即更正問題。
在練習的第一個部分,您會執行下列作業來執行程式碼複查︰
- 選取要執行的程式碼複查。
- 檢視程式碼複查中所套用的規則。
- 選擇哪些程式碼要執行複查。
- 執行程式碼複查。
- 檢視程式碼複查的發現項目。
- 選取某個發現項目來查看關於該項目的下列資訊︰
接著,為了要套用快速修正到程式碼複查中的某個發現項目,您要執行下列作業︰
- 辨識何時可提供快速修正給發現項目。
- 查看快速修正將會對程式碼所做的變更清單。
- 套用快速修正之前,預覽原始與重構的程式碼。
- 套用快速修正來重構程式碼。
- 套用快速修正之後進行確認。
練習
選取程式碼複查
如果要選取快速程式碼複查︰
- 在「程式碼複查」視圖中的工具列上按一下管理規則圖示
。

- 在選取程式碼複查清單中,按一下快速程式碼複查。這時會顯示您選取之程式碼複查的規則資料夾,如下列畫面所示︰

- 如果要查看將套用於程式碼複查的其中一項規則,請展開 J2SE 最佳作法資料夾,再展開 Null 子資料夾。Null 資料夾顯示具有某個問題嚴重性層次的一項規則,如下列畫面所示︰

作為複查用途,下列圖例顯示嚴重性層次的圖示:

- 按一下確定以選擇「快速程式碼複查」。
選取要複查的程式碼庫
如果要選取專案做為要複查的程式碼庫︰
- 在「程式碼複查」視圖中的工具列上按一下複查圖示(
)> 專案 > 複查 CodeReview_Examples。
執行程式碼複查
一旦您選取要複查的程式碼庫,就會執行程式碼複查。您可以檢查視圖右下角的進度列來追蹤其狀態。
檢視程式碼複查發現項目
當程式碼複查完成時,「程式碼複查」視圖中會顯示發現項目,如下列畫面所示︰

「程式碼複查」視圖提供下列資訊︰
- 程式碼複查統計資料︰發現項目上方的字行顯示最近程式碼複查的相關資訊︰類型、範圍、內含的規則和檔案數,以及發現項目的數目和嚴重性。
- 程式碼複查發現項目︰從程式碼複查產生的發現項目列示在「程式碼複查」視圖中的資料夾內。每一個資料夾名稱告訴您套用的規則種類和發現項目的數目。
取得程式碼複查發現項目的詳細資訊
如果要取得程式碼複查中發現項目的詳細資訊︰
- 在「程式碼複查」視圖中,捲動至 J2SE 最佳作法︰比較資料夾。然後展開資料夾以顯示其中的發現項目,如下列畫面所示︰

- 開始的第一個發現項目是 EqualsHashCode_Example.java。套用的規則註記在項目之後︰
一律置換 java.lang.Object.equals() 及 java.lang.Object.hashCode()
- 按兩下第一個發現項目。相關的詳細資料會顯示在兩個地方,如下列的概要和畫面所示︰
- 程式碼︰顯示發現項目出現位置的程式碼並強調顯示正確的位置。
- 程式碼複查「詳細資料」視圖︰詳細說明發現項目並提供範例和解決方案來更正項目。

選取具有快速修正的發現項目
您可以利用圖示來分辨最佳作法︰比較資料夾中的發現項目是否有快速修正。作為複查用途,下列圖例顯示快速修正的圖示:

- 用滑鼠右鍵按一下清單中的第一個發現項目,如下一個畫面所示。
- 快速修正蹦現功能表選項會根據解決方案而改變。對於您選取的發現項目,修正是實作 hashCode 和 equals。

- 按一下快速修正︰實作 hashCode 和 equals。
套用快速修正
您選取之發現項目的快速修正是實作 hashCode 和 equals。
如果要複查並套用快速修正於發現項目︰
- 您會看到並列的的程式碼視圖,如下列畫面所示。左邊是原始的程式碼,右邊則是快速修正將會建立的重構程式碼。如果決定套用快速修正,將會附加強調顯示的遺漏程式行。

- 在欲執行的變更區段中,展開清單來查看快速修正會變更哪些內容及變更方式,如下列畫面所示︰

- 複查清單中的變更。然後按一下確定,套用快速修正到清單中的所有選取變更。
- 套用快速修正之後,您會看到已解決的發現項目旁邊會出現勾號。

在勾號旁邊您會看到下列資訊︰
- 您套用的快速修正
- 發現項目在程式碼中的行號
- 未遵守的程式碼複查規則
您已完成練習︰執行程式碼複查及套用快速修正。
練習整理
您已執行練習︰執行程式碼複查及套用快速修正中的所有作業。
執行程式碼複查的作業
當您執行這個程式碼複查時,您執行了下列作業︰
- 選取要執行的程式碼複查。
- 檢視程式碼複查中所套用的規則。
- 選擇要執行複查的程式碼主體。
- 執行程式碼複查。
- 檢視程式碼複查的發現項目。
- 選取某個發現項目來查看關於該項目的下列資訊︰
套用快速修正的作業
當您套用快速修正時,您執行了下列的作業︰
- 辨識何時可提供快速修正給發現項目。
- 查看快速修正將會對程式碼所做的變更清單。
- 預覽原始和重構的程式碼。
- 套用快速修正來重構程式碼。
- 確認已套用快速修正。
運用程式碼複查的能力
積極地執行程式碼複查,您可以早期分析發現項目。這表示您也可以早期處理,以免導致下列問題︰
- 影響應用程式的效能、維護性或可調整性
- 浪費公司的金錢、時間和資源
運用快速修正的能力
藉由套用提供的快速修正,您可以利用自動方式來解決一般的發現項目。快速修正可幫助您下列事項︰
- 每次都能一致地更正問題
- 免除修正錯誤的程式碼修改並減少花費時間
請檢視總結︰執行程式碼複查中的學習目標,完成此指導教學。