快捷導(dǎo)航

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

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

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

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

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

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

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

何為序列圖？

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

我還是簡(jiǎn)單說(shuō)一說(shuō)我的理解吧！不過(guò)，說(shuō)實(shí)話(huà)，我自己對(duì)于 Sequence Diagram 也不是很明朗。下面的描述如有問(wèn)題和需要完善的地方，還請(qǐng)指出。

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

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

再舉兩個(gè)例子來(lái)說(shuō)一下！

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

在這里插入圖片描述

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

在這里插入圖片描述

另外，國(guó)內(nèi)一般更喜歡稱(chēng)呼序列圖為"時(shí)序圖"。

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

我覺(jué)得稱(chēng)呼 Sequence Diagram 為時(shí)序圖或者序列圖都是沒(méi)問(wèn)題的，不用太糾結(jié)。

哪些場(chǎng)景下需要查看類(lèi)的時(shí)序圖?

我們?cè)诤芏鄨?chǎng)景下都需要時(shí)序圖，比如說(shuō)：

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