PyCharm 中的 UML 類圖

在上一節里，當我們在做代碼重構時，第一步要選擇重構對象，可能是類，也可能是個變量，對于選擇對象，我們可以通過 Project 或者 Structure 工具欄選擇，也可以直接在編輯器內選擇，實際上，PyCharm 支也持使用 UML 類圖來分析 Python 類以及數據庫和表的結構，這也就意味著可以通過UML類圖去選擇重構對象。本節將主要講述ULM 類圖的相關功能與使用。

1. 什么是 UML

UML是統一建模語言，Unified Modeling Language 的縮寫。綜合了面向對象的建模語言、方法和過程，是一個支持模型化和軟件系統開發的圖形化語言，為軟件開發的所有階段提供模型化和可視化支持。關于UML更詳細信息，請參考官網。

UML 主要包括：

• 類圖(class diagram)；
• 用例圖(use case diagram)；
• 時序圖(sequence diagram)；
• 協作圖(collaboration diagram)；
• 狀態圖(statechart diagram)；
• 活動圖(activity diagram)；
• 構件圖(component diagram)；
• 部署圖(deployment diagram)。

Tips：在PyCharm 中， 只支持 class diagram。

2. 配置 UML 類圖

主菜單依次點擊：PyCharm/File -> Preference /Settings -> Tools -> Diagrams?？啥x要在關系圖中顯示的元素、節點元素和成員的可見性級別、布局等。這些設置適用于任何新創建的 UML 類關系圖。

3. 查看類圖

PyCharm 使用捆綁插件實現 UML 圖表功能，所以要保證該插件可用。主菜單 PyCharm/File -> Preference /Settings -> Plugins：

step1： 選擇文件在 Project 工具欄，或在編輯器選擇一個類（比如：Solver 類）。
step2： 在選擇的上下文菜單上，單擊 Diagrams ，在子菜單上，選擇要查看模型的方式：Show Diagram 或者 Show Diagram Popup （二者的區別是：前者是以單獨的TAB頁顯示，后者以彈出框顯示）：

step3：選擇 Show Diagram，關系圖顯示在編輯器選項卡中：

選擇其中的對象，右鍵點擊，在其上下文菜單中可以控制顯示的內容

4. 編輯類圖

添加元素節點到關系圖中：如下圖所示，源文件原有四個類定義： Skills、SkillsNew、Junior 與 JuniorNew, 如果增加了新類，可以通過下文菜單操作將新加節點元素添加到 UML 類關系圖中。

回車確定后，新生成的類圖如下所示：

Tips：如果想刪除某個元素節點， 選中節點， 然后點擊鍵盤上的刪除按鈕就可以了。

5. 導航

從類圖導航到源代碼： 在上下文菜單中選擇 Jump to Source 或者 按F4, 就可以跳轉源代碼了。

如果關系圖比較復雜，可以使用結構視圖瀏覽關系圖。按 ?F12(Ctrl + F12), 將彈出關系圖元素的菜單。

6. 小結

本節主要講述了 UML 類圖在 IDE 中的使用，功能相對比較簡單，但需要對 UML 有一定的了解，能看懂 UML 圖。當類的繼承關系比較復雜，通過 UML 類圖比直接讀代碼更能快速準確的理順各個類之間的關系，這也是最常用的應用場景。另外當我們讀第三方源代碼時，可以直接通過顯示整個包的 UML 類圖，快速了解代碼結構。