練習 1.2:執行結構分析程式碼複查
這個練習假設您已經完成練習 1.1:匯入所需的資源。在練習 1.2 中,請先閱讀使用者實務。然後您要擔負使用者實務中說明的軟體架構設計師角色,
並使用您在練習 1.1 匯入的專案,來完成練習。
使用者實務
架構設計師要複查剛寫好的程式碼,評定其品質,他要找出一般性的違反型樣問題。違反型樣 是在程式碼中發生的已知問題,並且未遵循最佳實務。設計型樣是應該遵循的好模式,違反型樣就是您應該避免的不良模式。某些特定的違反型樣包括下列類型:
- 容易中斷:程式碼中的物件有太多相依關係,導致在其他物件變更時,極容易中斷。
- 循環相依關係:一組物件的交互連接太密切,並且經常是循環性的,因此只要有任意一個物件做變更,
其他所有物件都會受到影響。亦稱為糾結。
- 集線器:物件有太多相依關係和關聯。只要其他物件一變更,該物件就會受到影響。同樣的,該物件一變更,其他物件也會受到影響。
在第一個練習中,架構設計師要執行程式碼複查,找出上述的違反型樣。
練習
在本練習中,您要執行下列作業:
- 選取要執行的程式碼複查。
- 檢視程式碼複查套用的規則。
- 選擇要針對哪一支程式碼執行複查。
- 執行程式碼複查。
- 檢視程式碼複查的發現項目。
- 選取一個發現項目,查看和其有關的下列資訊:
選取程式碼複查
若要選取結構分析程式碼複查:
- 在「程式碼複查」視圖的工具列上,按一下管理規則圖示
。

- 在選取程式碼複查清單中,按一下結構分析程式碼複查。
- 展開結構分析資料夾及子資料夾,查看程式碼複查中套用的規則,如以下所示。然後按一下確定。

選取要複查的程式碼庫
若要選取工作區作為要複查的程式碼庫:
- 在「程式碼複查」視圖的工具列上,按一下複查圖示
(
) > 複查工作區。
執行程式碼複查
當您選取要複查的程式碼庫之後,程式碼複查就會開始執行。您可以檢查位在視圖右下角的進度列,追蹤其執行狀態。
檢視程式碼複查發現項目
當程式碼複查完成時,就會在「程式碼複查」視圖中顯示發現項目,如下列畫面擷取所示:

「程式碼複查」視圖中會提供下列資訊。
- 程式碼複查統計資料:位在發現項目上方的一行,會顯示有關最新的程式碼複查資訊,
包括:名稱、範圍、包含的規則與檔案數目,以及發現項目的數目與嚴重性。
- 程式碼複查發現項目:程式碼複查找到的發現項目,會列出在「程式碼複查」視圖的資料夾內。每一個資料夾名稱都會指出程式碼複查名稱,以及種類和發現項目的數目。
取得程式碼複查發現項目的詳細資訊
若要在程式碼複查中取得有關發現項目的詳細資訊:
- 展開結構分析:循環相依關係資料夾。其中包含 4 個發現項目,如下列畫面擷取所示:

每一個發現項目前都會有一個圖示,指出其嚴重性層次。

如果圖示旁有一個燈泡 (
),
表示該發現項目有快速修正可用。快速修正是由系統針對特定的發現項目提供的自動化解決方案。快速修正圖示如下列圖例所示:

- 按兩下開頭為 Event.java 的發現項目。該發現項目的詳細資訊就會出現在兩個地方,如下列幾點及畫面擷取所示:
- 原始碼:顯示發現項目發生所在的程式碼,並強調顯示其確切的位置。
- 程式碼複查明細視圖:進一步說明發現項目,並提供範例及用於更正發現項目的解決方案。如果發現項目是循環的相依關係,
也會有一個區段顯示迴圈明細。

現在您已經完成「練習 1.2:執行結構分析程式碼複查」。
運用程式碼複查的威力
透過有效執行程式碼複查,可以提早看出問題並加以更正,避免它們引起下列問題:
- 影響您的應用程式效能、維護或延展性。
- 耗費公司財力、時間及資源。
在練習 1.4 中,您要運用您在練習 1.2 進行的工作,修正一個程式碼複查發現項目。
完成練習 1.2
現在您已經完成「練習 1.2:執行結構分析程式碼複查」。在這個練習中,您執行了下列作業:
- 選取要執行的程式碼複查。
- 檢視程式碼複查套用的規則。
- 選擇要執行複查的程式碼主體。
- 執行程式碼複查。
- 檢視程式碼複查的發現項目。
- 選取一個發現項目,查看和其有關的下列資訊:
現在,您可以開始進行練習 1.3:定義架構控制規則。