什麼是時序圖?
時序圖是 UML 互動圖,顯示物件或系統如何隨時間相互通訊。它們按時間順序顯示不同參與者之間的訊息交換,使其在記錄 API 流程、系統互動和多步驟流程方面非常有價值。每個參與者由一條垂直生命線表示,水平箭頭顯示訊息交換。
編輯與預覽
使用 Mermaid 語法創建 時序圖,即時查看效果。
100%
常見使用場景
API 文件編寫
記錄 API 端點及其互動流程。視覺化請求-回應週期、認證流程、錯誤處理以及客戶端和伺服器之間的資料交換。
微服務架構
映射微服務、訊息佇列和資料庫之間的通訊模式。對於理解分散式系統行為和除錯整合問題至關重要。
認證與授權
建模多步驟認證過程,如 OAuth、SAML 或 JWT 令牌流程。顯示重新導向、令牌交換和驗證步驟的順序。
系統整合
視覺化不同系統在複雜整合場景中的互動方式。記錄 Webhook 回呼、事件驅動架構和第三方服務整合。
核心功能
參與者管理
定義多個參與者、系統或服務,使用別名和啟動框顯示元件何時處於活動處理狀態。
訊息類型
支援同步呼叫、非同步訊息、回傳值和自呼叫,使用不同的箭頭樣式以提高清晰度。
控制結構
使用直觀的語法對循環、條件分支(alt/else)、可選區塊和並行處理進行建模。
註釋與說明
在序列中的任何點新增解釋性註釋,以提供上下文、闡明業務邏輯或記錄邊緣情況。
最佳實踐
專注於單一場景
每個時序圖應代表一個使用案例或互動流程。為不同的場景創建單獨的圖表,而不是將所有內容組合在一起。
使用有意義的名稱
為參與者提供清晰、描述性的名稱。使用實際的服務名稱或角色標題,而不是「系統 A」或「元件 1」等通用標籤。
顯示錯誤路徑
不要只記錄正常路徑。包括錯誤條件、逾時和例外處理的替代流程。
保持時間從上到下
遵循時間從上到下流動的約定。較早的互動應出現在圖表中比較晚的互動更高的位置。