掌握 C4 容器圖:建模物聯網閘道架構

Read this post in: de_DEen_USen_USes_ESfr_FRid_IDjapl_PLpt_PTvizh_CN
VPasCode PlantUML C4 model of IoT Gateway System architecture diagram

VPasCode PlantUML C4 模型:物聯網閘道系統架構圖

在現代軟體架構中,理解實體硬體與雲端服務之間的互動至關重要。本教學探討一種特定的架構視覺化:「第二層容器圖」用於物聯網閘道系統。在 VPasCode 環境中運用 C4 模型方法論,我們將複雜的嵌入式系統、本機資料庫與外部資料串流,拆解為單一且統一的視覺呈現。

與將系統視為黑盒子的高階情境圖不同,第二層圖「打開了盒子」。它揭示了內部執行環境、程序邊界,以及驅動應用程式的具體技術(程式語言、資料庫)。以下,我們將逐步說明此圖的建構過程、所採用的具體建模選擇,以及關係背後的技術邏輯。

C4 模型:為何使用容器?

C4 模型是一種分層式的軟體架構文件化方法。它包含四個層級:

  • 第一層(情境):顯示系統及其使用者。
  • 第二層(容器):顯示構成系統的高階技術建構模組(容器)。
  • 第三層(元件):顯示容器的內部結構。
  • 第四層(程式碼):顯示實際的程式碼類別與相依性。

本教學聚焦於「第二層」。在提供的範例中,我們正在建模一個「物聯網閘道系統」。這是一個關鍵邊界,因為它代表網路的邊緣,在此處實體感測器與雲端相連。

逐步說明:建構圖表

為重現此架構,我們使用 PlantUML 程式碼。此程式碼由 VPasCode 編輯器解析,以在右側呈現視覺圖表。

1. 設定舞台:包含與佈局

首先,我們需要載入 C4 PlantUML 函式庫。此函式庫提供標準圖形(人物、容器、方塊)與樣式規則。

!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml

LAYOUT_WITH_LEGEND()

「LAYOUTWITHLEGEND()」指令是一項特定指示,告知渲染器自動組織元素,並生成圖例以說明各圖形的意義(例如:「人物」與「容器」之別)。

2. 定義參與者與外部系統

在定義網關內部內容之前,我們必須先定義誰與它互動,以及它與外部進行什麼樣的通訊。

Person(homeowner, "房東", "監控並控制居家氣候。")
System_Ext(weather_api, "國家氣象 API", "提供外部環境溫度預測。")
  • Person(homeowner…):代表人類使用者。標籤描述其角色。
  • 系統Ext(weatherapi…):代表我們邊界之外的系統。我們使用系統Ext而非標準的系統以表示原始碼不受我們控制(它是一個第三方 API)。

3. 系統邊界與容器

這是圖表的核心。我們定義一個系統邊界以將所有發生在 IoT 網關硬體內部的內容分組。

System_Boundary(gateway_boundary, "IoT 網關系統") {
    Container(firmware, "核心守護進程服務", "C++ / FreeRTOS", "透過 I2C 輪詢直接物理感測器硬體暫存器。)
    ContainerDb(local_db, "遙測快取", "SQLite 檔案", "在廣泛連線中斷期間暫時緩衝感測器指標。)
    Container(mqtt_client, "雲端同步客戶端", "Go 二進位檔", "透過安全的 WAN 連接埠將結構化遙測封包向上游推送。)
}

注意所使用的特定類型容器:

  1. Container(firmware…):這代表在微控制器上執行的韌體。描述強調了低階互動:透過I2C.
  2. ContainerDb(localdb…):我們使用ContainerDb專門用於資料庫。描述說明了「儲存並轉發」模式:在網路中斷時緩衝資料。
  3. 容器 (mqtt客戶端…):這代表一個客戶端進程(可能作為獨立執行緒或旁載進程運行),負責雲端連線。

4. 定義關係(「線條」)

最後,我們繪製箭頭。在 PlantUML 中,Rel指令代表「關係」。語法通常為Rel(來源,目標,"標籤", "協定").

Rel(homeowner, firmware, "透過本地控制", "BLE")
Rel(firmware, local_db, "將指標寫入", "SQL / IPC")
Rel(mqtt_client, local_db, "從中查詢滯留的框架", "SQL / IPC")
Rel(mqtt_client, weather_api, "透過 HTTPS 拉取環境狀態

從這些關係中得出的關鍵架構洞察:

  • BLE(藍牙低功耗):房主透過藍牙直接與韌體互動,而非透過雲端。
  • IPC(進程間通訊):請注意,韌體與 MQTT 客戶端透過SQL / IPC。這表示資料庫是一個本地檔案(SQLite),作為 C++ 韌體進程與 Go 客戶端進程之間的橋接。
  • HTTPS:雲端客戶端透過公共網際網路與天氣 API 通訊。

技術分析:儲存與轉發模式

此圖表說明了物聯網工程中的一個經典模式:儲存與轉發。在圖表中,遙測快取(SQLite)是關鍵組件。它將資料收集(韌體)與資料傳輸(MQTT 客戶端)解耦。

若無此容器,一旦網路中斷,感測器資料將會遺失。透過引入ContainerDb,系統確保了資料完整性。圖表清楚傳達了「雲端同步客戶端」必須具備邏輯,在發送新資料前先查詢資料庫以取得「滯留的框架」。

結論

透過運用 VPasCode 與 C4 PlantUML 函式庫,我們將複雜的硬體與軟體架構轉化為清晰易讀的圖表。第二層視圖不僅有效地傳達了「誰使用系統,以及「如何其內部運作方式——強調感測器輪詢、本地資料儲存與雲端同步之間的關注點分離。