PlantUML 語法基礎

在深入探討 C4 模型或序列時間軸等特定架構佈局之前,理解規範所有內容的基礎規則至關重要PlantUML 實務手冊。PlantUML 依賴於清晰且高度直覺的文字標記系統。一旦你理解了引擎如何開啟文件、命名結構元件以及路由連接線,撰寫任何複雜系統佈局都會變得完全自然。

本快速入門介紹了適用於 VPasCode 工作區內幾乎所有 PlantUML 圖表類型的全局結構語法機制。

1. 必需的文件包裝

每一段 PlantUML 程式碼都必須以明確的框架標籤開始並結束。這些標籤會告訴 VPasCode 解析器在預覽畫布中啟動正確的渲染引擎:

  • @startuml — 此行必須精確地放置在你的腳本最頂端。其前不應有任何其他內容。
  • @enduml — 此行必須精確地放置在你的腳本最底端,標示圖表資料區塊的結束。

任何位於這兩個標記之外撰寫的程式碼,將被編譯器安全地忽略,或可能在工作區診斷面板中觸發語法驗證警告。

2. 宣告元件:ID 與顯示標籤

在建模軟體系統時,你將建立各種結構元件,例如元件、資料庫、參與者或微服務。在 PlantUML 中,你可以透過定義其類型、內部簡稱 ID,以及用引號包覆的使用者友善顯示名稱,明確宣告一個元件:

元件 microservice_id 作為 "付款處理 API"
資料庫 db_id 作為 "使用者交易 SQL"

為何這是最佳實務: 使用簡短且清晰的內部 ID(例如microservice_id)能讓後續繪製關係線時快得多。如果你需要將對客戶顯示的標籤從「付款處理 API」更改为「全球結帳服務」,你只需修改程式碼中的一行,而不是在整個腳本中更新數十行。

3. 掌握關係箭頭與方向性路由

系統節點之間的連接線是透過破折號(-)與箭頭括號(>)的組合來繪製。破折號的長度以及方向性關鍵字的使用,讓你隱式地控制自動佈局引擎如何縮放你的圖表:

  • 基本連接: A --> B會繪製一條標準的有向箭頭,從元件 A 直接指向元件 B。
  • 虛線依賴線: 將破折號替換為句點,會產生虛線,這是在業界中表示非同步依賴或網路呼叫的標準方式:A ..> B.
  • 強制配置方向:雖然佈局引擎會自動間隔框體,但您可透過直接在箭頭字串中插入方向關鍵字,明確地控制方向:
    • A -up-> B(強制 B 繪製在 A 上方)
    • A -down-> B(強制 B 繪製在 A 下方)
    • A -left-> B(強制 B 繪製在 A 左側)
    • A -right-> B(強制 B 繪製在 A 右側)

4. 內聯添加上下文:標籤與程式碼註釋

清晰的文件高度依賴於在您的視覺線條和文字腳本周圍放置適當的上下文:

標記連接線

您可透過在連接線後面附加冒號(”:)直接附加到您的關係映射之後:

client_id --> api_id : "HTTPS POST /v1/checkout"

撰寫程式碼註釋

如果您希望在腳本檔案中留下管理備註、設計致謝或架構說明,但又不想在畫布上渲染視覺框體,請使用單引號字元(”')。這會告訴引擎完全跳過該行的解析:

' TODO: 我們需要在 DevOps 迁移完成後更新此邊界框
[舊版單體] --> [新微服務]

現在您已熟悉 PlantUML 的全域語法包裝、組件宣告以及方向箭頭參數,已完全具備開始建立進階系統圖形的能力。請繼續前往下一頁,解鎖我們的 架構與高階設計圖!

返回頂端