IDEA一鍵生成方法的序列圖神操作

Posted on by

在平時的學習/工作中，我們會經常面臨如下場景：

  • 閱讀別人的代碼

  • 閱讀框架源碼

  • 閱讀自己很久之前寫的代碼。

千萬不要覺得工作就是單純寫代碼，實際工作中，你會發現你的大部分時間實際都花在瞭閱讀和理解已有代碼上。

為瞭能夠更快更清晰地搞清對象之間的調用關系，我經常需要用到序列圖。手動畫序列圖還是很麻煩費時的，不過 IDEA 提供瞭一個叫做SequenceDiagram 的插件幫助我們解決這個問題。通過 SequenceDiagram 這個插件，我們一鍵可以生成時序圖。

何為序列圖？

網上對於序列圖的定義有很多，我覺得都不太好理解，太抽象瞭。最神奇的是，大部分文章對於序列圖的定義竟然都是一模一樣，看來大傢是充分發揮瞭寫代碼的“精髓”啊！

我還是簡單說一說我的理解吧！不過，說實話，我自己對於 Sequence Diagram 也不是很明朗。下面的描述如有問題和需要完善的地方，還請指出。

序列圖（Sequence Diagram），亦稱為循序圖，是一種UML行為圖。表示系統執行某個方法/操作（如登錄操作）時，對象之間的順序調用關系。

這個順序調用關系可以這樣理解：你需要執行系統中某個對象 a 提供的方法/操作 login（登錄），但是這個對象又依賴瞭對象 b 提供的方法 getUser(獲取用戶)。因此，這裡就有瞭 a -> b 調用關系之說。

再舉兩個例子來說一下！

下圖是微信支付的業務流程時序圖。這個圖描述瞭微信支付相關角色（顧客，商傢…）在微信支付場景下，基礎支付和支付的的順序調用關系。

在這裡插入圖片描述

下圖是我寫的一個 HTTP 框架中的執行某個方法的序列圖。這個圖描述瞭我們在調用 InterceptorFactory類的 loadInterceptors() 方法的時候，所涉及到的類之間的調用關系。

在這裡插入圖片描述

另外，國內一般更喜歡稱呼序列圖為"時序圖"。

  • 如果你按照純翻譯的角度來說， sequence 這個單詞並無"時間"的意思，隻有序列，順序等意思，因此也有人說“時序圖”的說法是不準確的。

  • 如果從定義角度來說，時序圖這個描述是沒問題的。因為 Sequence Diagram 中每條消息的觸發時機確實是按照時間順序執行的。

我覺得稱呼 Sequence Diagram 為時序圖或者序列圖都是沒問題的，不用太糾結。

哪些場景下需要查看類的時序圖?

我們在很多場景下都需要時序圖，比如說：

  • 閱讀源碼 ：閱讀源碼的時候，你可能需要查看調用目標方法涉及的相關類的調用關系。特別是在代碼的調用層級比較多的時候，對於我們理解源碼非常有用。（題外話：實際工作中，大部分時間實際我們都花在瞭閱讀理解已有代碼上。）

  • 技術文檔編寫 ：我們在寫項目介紹文檔的時候，為瞭讓別人更容易理解你的代碼，你需要根據核心方法為相關的類生成時序圖來展示他們之間的調用關系。

  • 梳理業務流程 ：當我們的系統業務流程比較復雜的時候，我們可以通過序列圖將系統中涉及的重要的角色和對象的之間關系可視化出來。

  • …

如何使用 IDEA 根據類中方法生成時序圖？

通過 SequenceDiagram 這個插件，我們一鍵可以生成時序圖。

並且，你還可以：

點擊時序圖中的類/方法即可跳轉到對應的地方。

從時序圖中刪除對應的類或者方法。

將生成的時序圖導出為 PNG 圖片格式。

安裝

我們直接在 IDEA 的插件市場即可找到這個插件。我這裡已經安裝好瞭。

如果你因為網絡問題沒辦法使用 IDEA 自帶的插件市場的話，也可以通過IDEA 插件市場的官網手動下載安裝。

在這裡插入圖片描述

簡單使用

選中方法名（註意不要選類名），然後點擊鼠標右鍵，選擇 Sequence Diagram 選項即可！

在這裡插入圖片描述

配置生成的序列圖的一些基本的參數比如調用深度之後，我們點擊 ok 即可！

在這裡插入圖片描述

你還可以通過生成的時序圖來定位到相關的代碼，這對於我們閱讀源碼的時候尤其有幫助！

在這裡插入圖片描述

時序圖生成完成之後，你還可以選擇將其導出為圖片。

在這裡插入圖片描述

推薦閱讀：