Zum Inhalt springen

Kostenloses Tool

Structurizr DSL als C4-Modell-Diagramm

Fügen Sie einen Structurizr-DSL-Workspace oder einen Workspace-JSON-Export ein und sehen Sie die Ansichten Ihres C4-Modells als bearbeitbare Diagramme: Personen, Softwaresysteme, Container, Komponenten und Deployment-Knoten, Beziehungen mit ihrer Beschreibung beschriftet. Wählen Sie eine Ansicht oder öffnen Sie alle als einzelne Diagramme.

Beispielausgabe

Beispieldiagramm aus einem Structurizr-Beispiel
Beispiel ausprobierenOnlinebanking (DSL)Paketverfolgung (JSON)

So funktioniert es

  1. Workspace einfügen oder ablegen

    Eine workspace.dsl-Datei, DSL aus dem Structurizr-Playground oder das JSON, das Structurizr exportiert. Gelesen werden die Blöcke model und views, styles darf im Text bleiben.

  2. Jede C4-Ansicht sehen

    Alle Ansichten des Workspace werden aufgelistet, von der Systemlandschaft bis zu Komponenten und Deployment. Wählen Sie eine, und die Vorschau zeichnet sie mit C4-Karten, Grenzen und beschrifteten Pfeilen neu.

  3. In Archboard öffnen

    Speichern Sie die Ansicht als neues Diagramm, um sie umzuordnen, zu kommentieren, per Link zu teilen oder als SVG und PNG zu exportieren. Für die Anmeldung genügt ein Google- oder GitHub-Konto.

Was aus einem Structurizr-Workspace gezeichnet wird

Die gewählte Ansicht entsteht aus diesen Teilen des Modells:

  • person

    Personen als C4-Personenkarten mit ihrer Beschreibung. Eine Person mit dem Tag External oder mit location External in einem JSON-Export wird zur externen Person.

  • softwareSystem

    Softwaresysteme als C4-Systemkarten mit ihrer Beschreibung. Systeme mit dem Tag External werden zu externen Systemkarten, die nur den Namen zeigen.

  • container

    Container als Karten mit Technologie und Beschreibung. Ein Container mit dem Tag Database wird zur Datenbankkarte, die nur den Namen zeigt. Ein Container mit dem Tag Queue, Container und Components mit dem Tag External und ein enterprise-Block werden mit eigenen C4-Typen gezeichnet: Queue-Container, External-Container- und -Component-Karten und eine Enterprise-Grenze.

  • component

    Komponenten als Karten mit ihrer Technologie, innerhalb des Containers, zu dem sie gehören.

  • ->

    Beziehungen als Pfeile, beschriftet mit ihrer Beschreibung und danach der Technologie in eckigen Klammern. Zeigt eine Ansicht nur die Eltern, wird eine Beziehung zwischen ihren Kindern einmal zwischen den Eltern gezeichnet.

  • container bankingcomponent banking.api

    Der Geltungsbereich einer Container- oder Komponentenansicht als Rahmen: das Softwaresystem in der Containeransicht, der Container in der Komponentenansicht.

  • group

    Gruppen als Rahmen um die Personen, Systeme oder Container, die sie enthalten. Leere Gruppen entfallen.

  • deploymentNodeinfrastructureNodecontainerInstance

    Deployment-Ansichten mit verschachtelten Deployment-Knoten als Rahmen, Container- und Softwaresystem-Instanzen als die Karten, für die sie stehen, und Infrastrukturknoten als Deployment-Knoten-Karten.

  • systemLandscapesystemContextdeployment

    Systemlandschaft, Systemkontext, Container-, Komponenten- und Deployment-Ansichten, jede als eigenes Diagramm. Ein Workspace ohne Ansichten erhält eine Landschaft, eine Kontextansicht pro System und eine Containeransicht pro System mit Containern.

  • autoLayout lrinclude *

    include * mit der Bedeutung, die es in der jeweiligen Ansichtsart hat, include- und exclude-Listen von Bezeichnern und die Richtung von autoLayout, ohne Angabe von oben nach unten.

Ein Workspace, viele Ansichten

Ein Workspace enthält meist mehrere Ansichten desselben Modells. Die erste Ansicht in der Datei wird zuerst gezeichnet, und eine Ansichtsauswahl über der Vorschau wechselt zu jeder anderen Ansicht desselben Texts. Um alle Ansichten zu behalten, legt Alle Ansichten öffnen in Ihrem Arbeitsbereich ein Diagramm pro Ansicht an, die gewählte zuerst. Im Free-Tarif werden Ansichten, die nicht mehr in Ihr Diagrammlimit passen, nicht einfach verworfen: Das Tool zeigt, wie viele geöffnet wurden und wie viele übrig sind.

Was ein Structurizr-Import auslässt

  • Dateien und Skripte, auf die der Workspace verweist: !include, !docs, !adrs, !script, !plugin und workspace extends werden weder verfolgt noch ausgeführt. Sie werden in einer Warnung gezählt, und alles, was im eingefügten Text steht, wird trotzdem gezeichnet.
  • Stile für Elemente und Beziehungen, Themes und Branding. Formen, Farben und Symbole stammen von den C4-Karten, und Sie können sie anpassen, sobald das Diagramm in Archboard geöffnet ist.
  • Dynamic-, Filtered-, Custom- und Image-Ansichten sowie include- oder exclude-Regeln, die als Ausdrücke geschrieben sind. Sie werden übersprungen und gezählt, die übrigen Ansichten bleiben in der Liste.
  • In einem JSON-Export gespeicherte Positionen von Elementen. Jede Ansicht wird neu automatisch angeordnet, weil die Größen in Structurizr nicht zu den C4-Karten passen.
  • Dokumentationsabschnitte, Entscheidungsprotokolle, Properties, Perspectives und URLs. Gelesen werden nur das Modell und seine Ansichten.

Fragen zu Structurizr

Welche C4-Ebenen kann ich aus Structurizr DSL zeichnen?

Jede Ebene, die ein Structurizr-Workspace modelliert: Systemkontext- und Systemlandschaftsansichten für Ebene 1, Containeransichten für Ebene 2 und Komponentenansichten für Ebene 3, dazu Deployment-Ansichten. Diagramme auf Code-Ebene gehören nicht zu einem Structurizr-Workspace, daher gibt es für sie nichts zu zeichnen.

Kann ich statt DSL einen Workspace-JSON-Export einfügen?

Ja. Das JSON, das Structurizr speichert oder exportiert, wird genauso gelesen: Gezeichnet werden die in jeder Ansicht aufgeführten Elemente und Beziehungen, Personen, Systeme, Container und Deployment-Knoten eingeschlossen. Gespeicherte Positionen werden ignoriert, und jede Ansicht erhält ein neues automatisches Layout.

Kann ich alle Ansichten auf einmal öffnen?

Ja. Hat ein Workspace zwei oder mehr Ansichten, legt Alle Ansichten öffnen für jede ein eigenes Diagramm an, beginnend mit der gewählten. Stoppt das Diagrammlimit Ihres Tarifs den Vorgang vorzeitig, bleiben die bereits geöffneten Ansichten erhalten, und die restlichen werden gezählt, damit nichts unbemerkt verloren geht.

Mein Workspace nutzt !include. Was kann ich tun?

Fügen Sie die eingebundenen Dateien an Stelle ihrer !include-Zeilen in dasselbe Textfeld ein. Die Direktive wird nicht verfolgt, sondern in einer Warnung gezählt, weil das Tool nur den Text liest, den Sie ihm geben.

Was wird gespeichert, wenn ich das Diagramm in Archboard öffne?

Die Vorschau wird nicht gespeichert. Wenn Sie In Archboard öffnen wählen, wird die angezeigte Ansicht mit ihren C4-Karten, Grenzen, Rahmen und beschrifteten Pfeilen als neues Diagramm in Ihrem Arbeitsbereich gespeichert. Spätere Änderungen an DSL oder JSON aktualisieren es nicht.

Ist das Tool für Structurizr-Diagramme kostenlos?

Ja. Einen Workspace einfügen und seine Diagramme ansehen geht ohne Konto. Um eine Ansicht oder alle in Archboard zu öffnen, brauchen Sie ein kostenloses Konto.

In einer Minute ein Canvas öffnen

Melden Sie sich mit Google oder GitHub an. Kostenlos für einen Sitzplatz. Upgraden Sie, wenn das Team dazukommt.