
現代のソフトウェアアーキテクチャにおいて、物理ハードウェアとクラウドサービスの間の相互作用を理解することは極めて重要です。このチュートリアルでは、特定のアーキテクチャ可視化手法である「レベル 2 コンテナ図」を IoT ゲートウェイシステムに適用する方法を探ります。VPasCode 環境内で C4 モデルの手法を用いることで、複雑な組み込みシステム、ローカルデータベース、外部データストリームを、単一の統合されたビューとして表現する方法を詳しく解説します。
システムをブラックボックスとして示す高レベルのコンテキスト図とは異なり、レベル 2 図は「箱を開ける」ものです。これは、内部のランタイム環境、プロセスの境界、およびアプリケーションを支える具体的な技術(言語、データベース)を明らかにします。以下では、この図の構築方法、採用された具体的なモデリングの選択、および関係性背后的な技術的論理を順を追って解説します。
C4 モデル:なぜコンテナを使うのか?
C4 モデルは、ソフトウェアアーキテクチャのドキュメント化のための階層的アプローチです。4 つのレベルで構成されています:
- レベル 1(コンテキスト):システムとそのユーザーを示します。
- レベル 2(コンテナ):システムを構成する高レベルの技術的ビルディングブロック(コンテナ)を示します。
- レベル 3(コンポーネント):コンテナの内部構造を示します。
- レベル 4(コード):実際のコードクラスと依存関係を示します。
このチュートリアルでは「レベル 2」に焦点を当てています。提供された例では、「IoT ゲートウェイシステム」をモデリングしています。これは、物理センサーとクラウドが出会うネットワークの境界を表すため、極めて重要な境界です。
ステップバイステップ:図の構築
このアーキテクチャを再現するために、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…): 人間ユーザーを表します。ラベルはその役割を説明します。
- SystemExt(weatherapi…): 境界外のシステムを表します。私たちは「
SystemExt」を、標準的な「System」ではなく使用して、ソースコードが私たちの制御下になく(第三者の API である)ことを示します。
3. システム境界とコンテナ
これは図の核心です。私たちは「SystemBoundary」を定義して、IoT ゲートウェイハードウェア内で起こるすべてのものをグループ化します。
System_Boundary(gateway_boundary, "IoT ゲートウェイシステム") {
Container(firmware, "コアデーモンサービス", "C++ / FreeRTOS", "I2C を介して直接物理センサーハードウェアレジスタをポーリングする。")
ContainerDb(local_db, "テレメトリキャッシュ", "SQLite ファイル", "広範囲な接続停止時にセンサーメトリクスを一時的にスプールする。")
Container(mqtt_client, "クラウド同期クライアント", "Go バイナリ", "安全な WAN ソケットを介して構造化されたテレメトリパケットをアップストリームにプッシュする。")
}
使用されているコンテナの特定のタイプに注意してください:
- Container(firmware…): これはマイクロコントローラー上で実行されているファームウェアを表します。説明は、低レベルの相互作用を強調しています:ハードウェアレジスタを「
I2C. - ContainerDb(localdb…):」を介してポーリングする。私たちはデータベースには特に「
ContainerDb」を使用します。説明は、「保存して転送」パターンを説明しています:インターネットがダウンしているときにデータをバッファリングすること。 - コンテナ (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(Bluetooth Low Energy):ホームオーナーは、クラウドを介さずに、Bluetoothを介してファームウェアと直接対話します。
- IPC(プロセス間通信):ファームウェアとMQTTクライアントがデータベースと
SQL / IPCを介して対話している点に注意してください。これは、データベースがC++ファームウェアプロセスとGoクライアントプロセスの間の橋渡し役を果たすローカルファイル(SQLite)であることを意味します。 - HTTPS:クラウドクライアントは、パブリックインターネットを介してWeather APIと通信します。
技術的考察:ストア&フォワードパターン
この図は、IoTエンジニアリングにおける古典的なパターンであるストア&フォワードを示しています。図において、テレメトリキャッシュ(SQLite)が重要なコンポーネントです。これは、データ収集(ファームウェア)とデータ送信(MQTTクライアント)を分離します。
このコンテナがなければ、インターネットがダウンした場合、センサーデータは失われます。ContainerDbを導入することで、システムはデータの整合性を保証します。図は明確に、「クラウド同期クライアント」は新しいデータを送信する前に、データベースから「バックログフレーム」を照会するロジックを持つ必要があることを伝えています。
結論
VPasCode と C4 PlantUML ライブラリを活用することで、複雑なハードウェア・ソフトウェアアーキテクチャを明確で読みやすい図に変換しました。レベル 2 のビューは、単に「誰ががシステムを使用するかだけでなく、「どのように内部で動作するかを効果的に伝え、センサーポーリング、ローカルデータストレージ、クラウド同期の間の関心の分離を強調しています。










