在平時(shí)的學(xué)習(xí)/工作中枝秤,我們會(huì)經(jīng)常面臨如下場(chǎng)景:
1.閱讀別人的代碼
2.閱讀框架源碼
3.閱讀自己很久之前寫(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)指出铜靶。

再舉兩個(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í)序圖"嚼吞。
1.如果你按照純翻譯的角度來(lái)說(shuō), sequence 這個(gè)單詞并無(wú)"時(shí)間"的意思辆它,只有序列誊薄,順序等意思,因此也有人說(shuō)“時(shí)序圖”的說(shuō)法是不準(zhǔn)確的锰茉。
2.如果從定義角度來(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ō):
1.閱讀源碼 :閱讀源碼的時(shí)候,你可能需要查看調(diào)用目標(biāo)方法涉及的相關(guān)類(lèi)的調(diào)用關(guān)系全谤。特別是在代碼的調(diào)用層級(jí)比較多的時(shí)候肤晓,對(duì)于我們理解源碼非常有用。(題外話(huà):實(shí)際工作中认然,大部分時(shí)間實(shí)際我們都花在了閱讀理解已有代碼上补憾。)
2.技術(shù)文檔編寫(xiě) :我們?cè)趯?xiě)項(xiàng)目介紹文檔的時(shí)候,為了讓別人更容易理解你的代碼卷员,你需要根據(jù)核心方法為相關(guān)的類(lèi)生成時(shí)序圖來(lái)展示他們之間的調(diào)用關(guān)系盈匾。
3.梳理業(yè)務(wù)流程 :當(dāng)我們的系統(tǒng)業(yè)務(wù)流程比較復(fù)雜的時(shí)候,我們可以通過(guò)序列圖將系統(tǒng)中涉及的重要的角色和對(duì)象的之間關(guān)系可視化出來(lái)毕骡。
4.......
如何使用 IDEA 根據(jù)類(lèi)中方法生成時(shí)序圖削饵?
通過(guò) SequenceDiagram 這個(gè)插件岩瘦,我們一鍵可以生成時(shí)序圖。
并且窿撬,你還可以:
1.點(diǎn)擊時(shí)序圖中的類(lèi)/方法即可跳轉(zhuǎn)到對(duì)應(yīng)的地方启昧。
2.從時(shí)序圖中刪除對(duì)應(yīng)的類(lèi)或者方法。
3.將生成的時(shí)序圖導(dǎo)出為 PNG 圖片格式劈伴。
安裝
我們直接在 IDEA 的插件市場(chǎng)即可找到這個(gè)插件密末。我這里已經(jīng)安裝好了。
如果你因?yàn)榫W(wǎng)絡(luò)問(wèn)題沒(méi)辦法使用 IDEA 自帶的插件市場(chǎng)的話(huà)宰啦,也可以通過(guò)IDEA 插件市場(chǎng)的官網(wǎng)手動(dòng)下載安裝苏遥。
簡(jiǎn)單使用
1.選中方法名(注意不要選類(lèi)名),然后點(diǎn)擊鼠標(biāo)右鍵赡模,選擇 Sequence Diagram 選項(xiàng)即可田炭!
2.配置生成的序列圖的一些基本的參數(shù)比如調(diào)用深度之后,我們點(diǎn)擊 ok 即可漓柑!
你還可以通過(guò)生成的時(shí)序圖來(lái)定位到相關(guān)的代碼教硫,這對(duì)于我們閱讀源碼的時(shí)候尤其有幫助!
時(shí)序圖生成完成之后辆布,你還可以選擇將其導(dǎo)出為圖片瞬矩。
作者:JavaGuide
鏈接:https://juejin.im/post/6887719053931053064
來(lái)源:掘金
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)锋玲,非商業(yè)轉(zhuǎn)載請(qǐng)注明出處景用。