安利一個(gè)IDEA騷操作:一鍵生成方法的序列圖

在平時(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)指出铜靶。
    ![image.png](https://upload-images.jianshu.io/upload_images/13489956-7c994f5af2d13f32.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

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

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


image.png

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


image.png

另外涩笤,國(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)下載安裝苏遥。

image.png

簡(jiǎn)單使用

1.選中方法名(注意不要選類(lèi)名),然后點(diǎn)擊鼠標(biāo)右鍵赡模,選擇 Sequence Diagram 選項(xiàng)即可田炭!


image.png

2.配置生成的序列圖的一些基本的參數(shù)比如調(diào)用深度之后,我們點(diǎn)擊 ok 即可漓柑!


image.png

你還可以通過(guò)生成的時(shí)序圖來(lái)定位到相關(guān)的代碼教硫,這對(duì)于我們閱讀源碼的時(shí)候尤其有幫助!


image.png

時(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)注明出處景用。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市惭蹂,隨后出現(xiàn)的幾起案子伞插,更是在濱河造成了極大的恐慌,老刑警劉巖盾碗,帶你破解...
    沈念sama閱讀 222,681評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件媚污,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡廷雅,警方通過(guò)查閱死者的電腦和手機(jī)耗美,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)航缀,“玉大人商架,你說(shuō)我怎么就攤上這事∶危” “怎么了甸私?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,421評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀(guān)的道長(zhǎng)飞傀。 經(jīng)常有香客問(wèn)我皇型,道長(zhǎng)诬烹,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,114評(píng)論 1 300
  • 正文 為了忘掉前任弃鸦,我火速辦了婚禮绞吁,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘唬格。我一直安慰自己家破,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,116評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布购岗。 她就那樣靜靜地躺著汰聋,像睡著了一般。 火紅的嫁衣襯著肌膚如雪喊积。 梳的紋絲不亂的頭發(fā)上烹困,一...
    開(kāi)封第一講書(shū)人閱讀 52,713評(píng)論 1 312
  • 那天,我揣著相機(jī)與錄音乾吻,去河邊找鬼髓梅。 笑死,一個(gè)胖子當(dāng)著我的面吹牛绎签,可吹牛的內(nèi)容都是我干的枯饿。 我是一名探鬼主播,決...
    沈念sama閱讀 41,170評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼诡必,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼奢方!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起爸舒,我...
    開(kāi)封第一講書(shū)人閱讀 40,116評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤袱巨,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后碳抄,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,651評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡场绿,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,714評(píng)論 3 342
  • 正文 我和宋清朗相戀三年剖效,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片焰盗。...
    茶點(diǎn)故事閱讀 40,865評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡璧尸,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出熬拒,到底是詐尸還是另有隱情爷光,我是刑警寧澤,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布澎粟,位于F島的核電站蛀序,受9級(jí)特大地震影響欢瞪,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜徐裸,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,211評(píng)論 3 336
  • 文/蒙蒙 一遣鼓、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧重贺,春花似錦骑祟、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,699評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至潜圃,卻和暖如春缸棵,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背秉犹。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,814評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工蛉谜, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人崇堵。 一個(gè)月前我還...
    沈念sama閱讀 49,299評(píng)論 3 379
  • 正文 我出身青樓型诚,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親鸳劳。 傳聞我的和親對(duì)象是個(gè)殘疾皇子狰贯,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,870評(píng)論 2 361