IDEA一鍵生成方法的序列圖神操作
在平時的學習/工作中,我們會經(jīng)常面臨如下場景:
閱讀別人的代碼
閱讀框架源碼
閱讀自己很久之前寫的代碼。
千萬不要覺得工作就是單純寫代碼,實際工作中,你會發(fā)現(xiàn)你的大部分時間實際都花在了閱讀和理解已有代碼上。
為了能夠更快更清晰地搞清對象之間的調(diào)用關(guān)系,我經(jīng)常需要用到序列圖。手動畫序列圖還是很麻煩費時的,不過 IDEA 提供了一個叫做SequenceDiagram
的插件幫助我們解決這個問題。通過 SequenceDiagram 這個插件,我們一鍵可以生成時序圖。
何為序列圖?
網(wǎng)上對于序列圖的定義有很多,我覺得都不太好理解,太抽象了。最神奇的是,大部分文章對于序列圖的定義竟然都是一模一樣,看來大家是充分發(fā)揮了寫代碼的“精髓”?。?/p>
我還是簡單說一說我的理解吧!不過,說實話,我自己對于 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è)務流程時序圖。這個圖描述了微信支付相關(guān)角色(顧客,商家...)在微信支付場景下,基礎支付和支付的的順序調(diào)用關(guān)系。
下圖是我寫的一個 HTTP 框架中的執(zhí)行某個方法的序列圖。這個圖描述了我們在調(diào)用 InterceptorFactory
類的 loadInterceptors()
方法的時候,所涉及到的類之間的調(diào)用關(guān)系。
另外,國內(nèi)一般更喜歡稱呼序列圖為"時序圖"。
如果你按照純翻譯的角度來說, sequence 這個單詞并無"時間"的意思,只有序列,順序等意思,因此也有人說“時序圖”的說法是不準確的。
如果從定義角度來說,時序圖這個描述是沒問題的。因為 Sequence Diagram 中每條消息的觸發(fā)時機確實是按照時間順序執(zhí)行的。
我覺得稱呼 Sequence Diagram 為時序圖或者序列圖都是沒問題的,不用太糾結(jié)。
哪些場景下需要查看類的時序圖?
我們在很多場景下都需要時序圖,比如說:
閱讀源碼 :閱讀源碼的時候,你可能需要查看調(diào)用目標方法涉及的相關(guān)類的調(diào)用關(guān)系。特別是在代碼的調(diào)用層級比較多的時候,對于我們理解源碼非常有用。(題外話:實際工作中,大部分時間實際我們都花在了閱讀理解已有代碼上。)
技術(shù)文檔編寫 :我們在寫項目介紹文檔的時候,為了讓別人更容易理解你的代碼,你需要根據(jù)核心方法為相關(guān)的類生成時序圖來展示他們之間的調(diào)用關(guān)系。
梳理業(yè)務流程 :當我們的系統(tǒng)業(yè)務流程比較復雜的時候,我們可以通過序列圖將系統(tǒng)中涉及的重要的角色和對象的之間關(guān)系可視化出來。
...
如何使用 IDEA 根據(jù)類中方法生成時序圖?
通過 SequenceDiagram 這個插件,我們一鍵可以生成時序圖。
并且,你還可以:
點擊時序圖中的類/方法即可跳轉(zhuǎn)到對應的地方。
從時序圖中刪除對應的類或者方法。
將生成的時序圖導出為 PNG 圖片格式。
安裝
我們直接在 IDEA 的插件市場即可找到這個插件。我這里已經(jīng)安裝好了。
如果你因為網(wǎng)絡問題沒辦法使用 IDEA 自帶的插件市場的話,也可以通過IDEA 插件市場的官網(wǎng)手動下載安裝。
簡單使用
選中方法名(注意不要選類名),然后點擊鼠標右鍵,選擇 Sequence Diagram 選項即可!
配置生成的序列圖的一些基本的參數(shù)比如調(diào)用深度之后,我們點擊 ok 即可!
你還可以通過生成的時序圖來定位到相關(guān)的代碼,這對于我們閱讀源碼的時候尤其有幫助!
時序圖生成完成之后,你還可以選擇將其導出為圖片。
以上就是IDEA一鍵生成方法的序列圖神操作的詳細內(nèi)容,更多關(guān)于IDEA一鍵生成序列圖的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
ssm框架下web項目,web.xml配置文件的作用(詳解)
下面小編就為大家?guī)硪黄猻sm框架下web項目,web.xml配置文件的作用(詳解)。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-10-10Java畢業(yè)設計實戰(zhàn)之平行志愿管理系統(tǒng)的實現(xiàn)
這是一個使用了java+Springboot+Maven+mybatis+Vue+Mysql開發(fā)的圖片平行志愿管理系統(tǒng),是一個畢業(yè)設計的實戰(zhàn)練習,具有志愿管理該有的所有功能,感興趣的朋友快來看看吧2022-02-02Java中的排序與內(nèi)部比較器Compareable解析
這篇文章主要介紹了Java中的排序與內(nèi)部比較器Compareable解析,一般沒有特殊要求時,直接調(diào)用(底層默認的升序排列)就可以得到想要的結(jié)果,所謂的 sort 方法排序底層都是基于這兩種排序,故如果需要設計成所想要的排序就需要了解底層排序原理,需要的朋友可以參考下2023-11-11Java/Android 獲取網(wǎng)絡重定向文件的真實URL的示例代碼
本篇文章主要介紹了Java/Android 獲取網(wǎng)絡重定向文件的真實URL的示例代碼,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-11-11手擼一個Spring?Boot?Starter并上傳到Maven中央倉庫
本文主要介紹了手擼一個Spring?Boot?Starter并上傳到Maven中央倉庫,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-05-05SpringCloud服務的發(fā)現(xiàn)與調(diào)用詳解
在Java微服務越來越火的今天。幾乎什么公司都在搞微服務。而使用的比較多的就是Spring?Cloud技術(shù)棧。今天就來研究一下Spring?Cloud中服務發(fā)現(xiàn)與調(diào)用的基本原理2022-07-07