Składnia i przewodnik po układzie diagramu pakietu Mermaid.js

Diagram pakietu to specjalizowany komponent wizualizacji używany przez inżynierów sieciowych, analityków bezpieczeństwa i deweloperów systemów do mapowania dokładnej struktury binarnej protokołów sieciowych, alokacji pamięci lub niestandardowych nagłówków pakietów sprzętowych. Wprowadzony zgodnie z zasadami Mermaid.js, ten narzędzie zastępuje męczące ręczne rysowanie tabel, automatycznie generując odpowiedni, doskonale wyrównany siatkę poziomu bitów na podstawie czystego, opartego na tekście podziału pól.

Zrozumienie układu siatki pakietu

W przeciwieństwie do standardowych schematów przepływu o swobodnej formie, diagram pakietu opiera się na ściśle określonym, matematycznym systemie siatki, który bezpośrednio odzwierciedla RFC sieciowe:

  • Szerokość bitu (oś pozioma): Silnik układu domyślnie dzieli każdy wiersz na system siatki 32-bitowej (od bitu 0 do 31).
  • Automatyczne obliczanie bitów: Po prostu deklarujesz rozmiar długości bitów dla każdego pola. Silnik renderowania zajmuje się obliczeniami — automatycznie umieszcza sąsiednie pola w tym samym wierszu lub płynnie przenosi je do następnego wiersza, gdy suma rozmiarów przekracza próg 32-bitowy.

Podstawowa struktura składni

Każna mapa pakietu zaczyna się odpacket nagłówka deklaracji. Następują pola blokowe deklarowane jako kolejne pary zgodne z ściśle określonym wzorcem"Nazwa pola": RozmiarBitów na osobnych liniach.

packet
  0-3: "Wersja"
  4-7: "IHL"
  8-15: "Typ usługi"
  16-31: "Całkowita długość"

Odwołanie składniowe

Poniższa tabela rozkłada podstawowe parametry danych i zasady formatowania wymagane do stworzenia diagramu pakietu w Mermaid.js.

Element składni Wymóg typu Opis i zachowanie siatki wizualnej
Deklaracja Identyfikator słowa kluczowego Inicjuje obszar roboczy układu protokołu poziomu bitów. Należy użyć dokładniepacket bloku nagłówka.
Nazwa pola Ciąg w cudzysłowach Etykieta wyświetlana wewnątrz przestrzeni bloku. Zawsze musi być otoczona podwójnymi cudzysłowami.
Rozmiar bitów Liczba całkowita dodatnia Bezpośredni długość bitów pola (np. 1 dla flag jednobitowych, 8 dla bajtów, 16 dla krótkich). Ustawia szerokość wizualną.
Wyzwalacz przełamania wiersza Automatyczny śledzenie Występuje automatycznie za każdym razem, gdy łączna długość bitów osiąga wielokrotność 32 bitów.

Prawdziwy projekt: Strukturalna mapa nagłówka pakietu IPv4

Ten kompleksowy projekt śledzi standardową strukturę pakietu routingu internetowego (IPv4). Pokazuje, jak pola wielobitowe, flagi jednobitowe oraz większe bloki 16-bitowe są montowane sekwencyjnie w standardowej siatce poziomej 32-bitowej. Pola osiągające 32-bitowy próg automatycznie przechodzą do następnego wiersza.

pakiet
  0-3: "Wersja"
  4-7: "IHL"
  8-15: "Typ usługi"
  16-31: "Całkowita długość"
  32-47: "Identyfikacja"
  48-50: "Flagi"
  51-63: "Przesunięcie fragmentu"
  64-71: "TTL"
  72-79: "Protokół"
  80-95: "Suma kontrolna nagłówka"


Wskazówka składni: Jeśli pojedyncze zadeklarowane pole ma więcej niż 32 bitów (np. 64-bitowy sol kryptograficzny lub znacznik czasu), silnik renderowania płynnie zawinięcie i rozciągnie ten blok w pionie na kilku kolejnych wierszach, używając czystych wskaźników połączeń, aby zachować czytelność.


Typowe błędy składniowe i ograniczenia systemowe

Podczas projektowania bardzo dokładnych map dokumentacji na poziomie bajtów, pamiętaj o tych parametrach diagnostycznych, aby uniknąć błędów kompilacji:

  • Wymuszające otoczki cudzysłowami: Każda pojedyncza ciąg znaków opisujący pole musi być otoczona podwójnymi cudzysłowami. Pominięcie nawiasów cudzysłowu spowoduje natychmiastowy błąd analizy składni.
  • Nieprawidłowe rozmiary bitów ciągu: Przypisanie grubości wartości następujące po separatorze dwukropka musi być surową, nieotoczoną cudzysłowami liczbą całkowitą. Przekazywanie liczb dziesiętnych lub rozmiarów alfabetowych (np. "Dane": 8bitów) zatrzyma kompilację diagramu.
  • Wyrównanie krawędzi siatkiUpewnij się, że suma Twoich pól wynosi dokładnie wielokrotność 32, jeśli chcesz uzyskać jednolite, prostokątne schematy nagłówków. Pozostawienie wiersza z nieprzypisanymi bitami może spowodować nieregularne wyglądające bloki końcowe.
  • Ograniczenia widoku skali:Choć silnik dynamicznie oblicza szerokości układu, wpychanie bardzo długich opisów tekstowych do małych bloków 1-bitowych lub 2-bitowych może spowodować obcinanie czcionki lub zbyt dużą gęstość wizualną. Zachowaj krótkie etykiety dla małych bitów.
Przewijanie do góry