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

更新時間：2022年01月22日 14:46:07 作者：Guide哥

為了能夠更快更清晰地搞清對象之間的調(diào)用關(guān)系，我經(jīng)常需要用到序列圖。手動畫序列圖還是很麻煩費(fèi)時的，不過?IDEA?提供了一個叫做SequenceDiagram?的插件幫助我們解決這個問題。通SequenceDiagram?這個插件，我們一鍵可以生成時序圖

在平時的學(xué)習(xí)/工作中，我們會經(jīng)常面臨如下場景：

閱讀別人的代碼
閱讀框架源碼
閱讀自己很久之前寫的代碼。

千萬不要覺得工作就是單純寫代碼，實(shí)際工作中，你會發(fā)現(xiàn)你的大部分時間實(shí)際都花在了閱讀和理解已有代碼上。

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

何為序列圖？

網(wǎng)上對于序列圖的定義有很多，我覺得都不太好理解，太抽象了。最神奇的是，大部分文章對于序列圖的定義竟然都是一模一樣，看來大家是充分發(fā)揮了寫代碼的“精髓”??！

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

序列圖（Sequence Diagram），亦稱為循序圖，是一種UML行為圖。表示系統(tǒng)執(zhí)行某個方法/操作（如登錄操作）時，對象之間的順序調(diào)用關(guān)系。

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

再舉兩個例子來說一下！

下圖是微信支付的業(yè)務(wù)流程時序圖。這個圖描述了微信支付相關(guān)角色（顧客，商家...）在微信支付場景下，基礎(chǔ)支付和支付的的順序調(diào)用關(guān)系。

在這里插入圖片描述

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

在這里插入圖片描述

另外，國內(nèi)一般更喜歡稱呼序列圖為"時序圖"。

如果你按照純翻譯的角度來說， sequence 這個單詞并無"時間"的意思，只有序列，順序等意思，因此也有人說“時序圖”的說法是不準(zhǔn)確的。
如果從定義角度來說，時序圖這個描述是沒問題的。因?yàn)?Sequence Diagram 中每條消息的觸發(fā)時機(jī)確實(shí)是按照時間順序執(zhí)行的。

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

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

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

閱讀源碼：閱讀源碼的時候，你可能需要查看調(diào)用目標(biāo)方法涉及的相關(guān)類的調(diào)用關(guān)系。特別是在代碼的調(diào)用層級比較多的時候，對于我們理解源碼非常有用。（題外話：實(shí)際工作中，大部分時間實(shí)際我們都花在了閱讀理解已有代碼上。）
技術(shù)文檔編寫：我們在寫項(xiàng)目介紹文檔的時候，為了讓別人更容易理解你的代碼，你需要根據(jù)核心方法為相關(guān)的類生成時序圖來展示他們之間的調(diào)用關(guān)系。
梳理業(yè)務(wù)流程：當(dāng)我們的系統(tǒng)業(yè)務(wù)流程比較復(fù)雜的時候，我們可以通過序列圖將系統(tǒng)中涉及的重要的角色和對象的之間關(guān)系可視化出來。
...