練習 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。
若要複查及套用快速修正至發現項目:
- 您會看到程式碼的並列視圖,如下列畫面擷取所示。原始碼位在左邊,而快速修正將會建立之重新建構後的原始碼位在右邊。如果您決定要套用快速修正,它就會附加反白的遺漏程式碼行。

- 在要執行的變更區段中,展開清單,查看快速修正會變更什麼,以及如何變更,如下列畫面擷取所示:

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

在勾號旁可以看到下列資訊:
- 已套用的快速修正
- 發現項目在原始碼中的行號
- 在程式碼複查中尚未被符合的規則
您已完成「練習:執行程式碼複查,並套用快速修正」。
完成練習
現在您已執行過「練習:執行程式碼複查,並套用快速修正」中的所有作業。
執行程式碼複查的作業
當您執行此程式碼複查時,您會執行下列作業:
- 選取要執行的程式碼複查。
- 檢視程式碼複查套用的規則。
- 選擇要執行複查的程式碼主體。
- 執行程式碼複查。
- 檢視程式碼複查的發現項目。
- 選取一個發現項目,查看和其有關的下列資訊:
套用快速修正的作業
當您套用快速修正時,您會執行下一組作業:
- 檢查發現項目是否有快速修正可用。
- 查看快速修正會對程式碼做的變更清單。
- 預覽原始及重新建構的程式碼。
- 套用快速修正,重新建構程式碼。
- 套用快速修正之後,取得確認。
運用程式碼複查的威力
透過有效執行程式碼複查,您可以提早分析發現項目。這表示您也可以提早發現問題,以免它們導致下列問題:
- 影響您的應用程式效能、維護或延展性
- 耗費公司財力、時間及資源
運用快速修正的威力
套用所提供的快速修正時,您可以自動解決一般性的發現項目。快速修正可以在下列方面協助您:
- 持續一致地更正問題
- 讓您空出撰寫程式的時間,並減少修正錯誤的時間
請複查摘要:執行程式碼複查中的學習目標,完成指導教學。