Opanowanie diagramów kontenerów C4: Modelowanie architektury bramki IoT

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

Model VPasCode PlantUML C4 diagramu architektury systemu bramki IoT

We współczesnej architekturze oprogramowania zrozumienie interakcji między fizycznym sprzętem a usługami chmurowymi jest kluczowe. Ten samouczek omawia konkretną wizualizację architektoniczną: Diagram kontenerów poziomu 2 dla systemu bramki IoT. Korzystając z metodyki modelu C4 w środowisku VPasCode, rozkładamy na czynniki pierwsze sposób reprezentowania złożonych systemów wbudowanych, lokalnych baz danych i zewnętrznych strumieni danych w jednej, spójnej wizji.

W przeciwieństwie do diagramu kontekstowego wysokiego poziomu, który przedstawia system jako czarne pudełko, diagram poziomu 2 „otwiera pudełko”. Wykrywa wewnętrzne środowiska uruchomieniowe, granice procesów oraz konkretne technologie (języki, bazy danych) napędzające aplikację. Poniżej przejdziemy przez konstrukcję tego diagramu, konkretne wybory modelowania oraz logikę techniczną stojącą za relacjami.

Model C4: Dlaczego używać kontenerów?

Model C4 to hierarchiczne podejście do dokumentacji architektury oprogramowania. Składa się z czterech poziomów:

  • Poziom 1 (Kontekst):Pokazuje system i jego użytkowników.
  • Poziom 2 (Kontener):Pokazuje wysokie poziomy techniczne bloki budulcowe (kontenery), które tworzą system.
  • Poziom 3 (Komponent):Pokazuje wewnętrzną strukturę kontenera.
  • Poziom 4 (Kod):Pokazuje rzeczywiste klasy kodu i zależności.

Ten samouczek koncentruje się na poziomie 2. W podanym przykładzie modelujemy system bramki IoT. Jest to krytyczna granica, ponieważ reprezentuje krawędź sieci, gdzie fizyczne czujniki spotykają się z chmurą.

Krok po kroku: Konstrukcja diagramu

Aby odtworzyć tę architekturę, używamy kodu PlantUML. Kod ten jest parsowany przez edytor VPasCode, aby wyrenderować wizualny diagram po prawej stronie.

1. Przygotowanie sceny: Dołączania i układ

Po pierwsze, musimy załadować bibliotekę C4 PlantUML. Biblioteka ta dostarcza standardowych kształtów (ludzie, kontenery, pudełka) oraz reguł stylizacji.

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

LAYOUT_WITH_LEGEND()

Komenda LAYOUTWITHLEGEND() jest konkretną dyrektywą, która mówi renderowi o automatycznej organizacji elementów i wygenerowaniu klucza wyjaśniającego, co oznaczają kształty (np. „Osoba” vs „Kontener”).

2. Określanie aktorów i systemów zewnętrznych

Zanim zdefiniujemy, co znajduje się wewnątrz bramy, musimy określić, kto z nią interakcjonuje i z czym komunikuje się na zewnątrz.

Person(homeowner, "Właściciel domu", "Monitoruje i steruje klimatem w domu.")
System_Ext(weather_api, "Narodowa Aplikacja Pogodowa", "Dostarcza zewnętrznych prognoz temperatury otoczenia.")
  • Person(homeowner…): Reprezentuje użytkownika ludzkiego. Etykieta opisuje ich rolę.
  • SystemExt(weatherapi…): Reprezentuje system poza naszą granicą. Używamy SystemExt zamiast standardowego System aby wskazać, że kod źródłowy nie jest pod naszą kontrolą (jest to zewnętrzna aplikacja API).

3. Granica systemu i kontenery

To jest rdzeniem diagramu. Definiujemy SystemBoundary aby pogrupować wszystko, co dzieje się wewnątrz sprzętu bramy IoT.

System_Boundary(gateway_boundary, "System Bramy IoT") {
    Container(firmware, "Podstawowa usługa demona", "C++ / FreeRTOS", "Odpytuje bezpośrednie rejestry sprzętu czujników fizycznych przez I2C.")
    ContainerDb(local_db, "Pamięć podręczna telemetrii", "Plik SQLite", "Tymczasowo buforuje metryki czujników podczas długotrwałych awarii połączenia.")
    Container(mqtt_client, "Klient synchronizacji z chmurą", "Binarny Go", "Wysyła strukturalne pakiety telemetrii do góry przez bezpieczne gniazdo WAN.")
}

Zwróć uwagę na konkretne typy użytych kontenerów:

  1. Container(firmware…): Reprezentuje oprogramowanie układowe uruchomione na mikrokontrolerze. Opis podkreśla interakcję niskiego poziomu: odpytywanie rejestrów sprzętowych przez I2C.
  2. ContainerDb(localdb…): Używamy ContainerDb specyficznie dla baz danych. Opis wyjaśnia wzorzec “przechowuj i przesyłaj”: buforowanie danych, gdy internet jest niedostępny.
  3. Kontener(mqttklient…):Reprezentuje to proces klienta (prawdopodobnie działający jako osobny wątek lub proces sidecar) odpowiedzialny za łączność z chmurą.

4. Określanie relacji (“Linie”)

Na końcu rysujemy strzałki. W PlantUML polecenie Reloznacza “Relację”. Składnia jest ogólnie Rel(Źródło, Cel, "Etykieta", "Protokół").

Rel(homeowner, firmware, "Steruje lokalnie przez", "BLE")
Rel(firmware, local_db, "Zapisuje metryki do", "SQL / IPC")
Rel(mqtt_client, local_db, "Pobiera zaległe ramki z", "SQL / IPC")
Rel(mqtt_client, weather_api, "Pobiera status środowiskowy przez", "HTTPS")

Kluczowe wnioski architektoniczne wynikające z tych relacji:

  • BLE (Bluetooth Low Energy):Właściciel domu interaguje bezpośrednio z oprogramowaniem układowym za pomocą Bluetooth, a nie przez chmurę.
  • IPC (Komunikacja międzyprocesowa):Zauważ, że oprogramowanie układowe i klient MQTT interagują z bazą danych za pomocą SQL / IPC. Oznacza to, że baza danych to plik lokalny (SQLite), który działa jako most między procesem oprogramowania układowego w C++ a procesem klienta w Go.
  • HTTPS:Klient w chmurze komunikuje się z API pogodowym przez publiczny internet.

Analiza techniczna: Wzorzec Przechowywania i Przekazywania

Ten diagram ilustruje klasyczny wzorzec w inżynierii IoT: Przechowywania i Przekazywania. Na diagramie Pamięć podręczna telemetrii(SQLite) jest kluczowym komponentem. Rozdziela ono zbieranie danych (oprogramowanie układowe) od transmisji danych (Klient MQTT).

Bez tego kontenera, gdyby internet przestał działać, dane z czujników zostałyby utracone. Wprowadzając KontenerDb, system zapewnia integralność danych. Diagram wyraźnie komunikuje, że “Klient synchronizacji z chmurą” musi posiadać logikę do zapytania bazy danych o “zaległe ramki” przed wysłaniem nowych danych.

Podsumowanie

Wykorzystując VPasCode i bibliotekę C4 PlantUML, przekształciliśmy złożoną architekturę sprzętowo-software’ową w przejrzysty, czytelny diagram. Widok poziomu 2 skutecznie komunikuje nie tylko kto korzysta z systemu, ale jak działa wewnętrznie — podkreślając rozdzielenie obowiązków między pobieraniem danych z czujników, lokalnym przechowywaniem danych a synchronizacją z chmurą.