Diagrammi delle classi in Confluence

Un diagramma delle classi mostra i tipi di un sistema, i loro campi e metodi, e come sono collegati.

Ultimo aggiornamento

Quando usarlo

Usa un diagramma delle classi per documentare un modello di dominio o i livelli di un servizio: quali tipi esistono, che cosa contengono e chi dipende da chi. Ereditarietà, composizione e interfacce hanno ciascuna la propria freccia. Tieni un diagramma per argomento: un diagramma con tutte le classi del codice non aiuta nessuno.

Esempio

Questo è il codice del modello Domain model: clienti, ordini, righe d’ordine e prodotti con le loro relazioni.

classDiagram
  class Customer {
    +String name
    +String email
    +placeOrder()
  }
  class Order {
    +Date createdAt
    +OrderStatus status
    +total() Money
  }
  class OrderLine {
    +int quantity
    +Money unitPrice
  }
  class Product {
    +String sku
    +String name
    +Money price
  }
  Customer "1" --> "*" Order : places
  Order "1" *-- "1..*" OrderLine : contains
  OrderLine "*" --> "1" Product : refers to

Vellnar Diagrams lo disegna così:

Cambia una riga e il diagramma cambia con lei. A nessuno serve il file originale del disegno, perché non esiste: il codice è il diagramma.

Aggiungerlo a una pagina di Confluence

  1. Modifica una pagina di Confluence e scrivi /mermaid dove vuoi il diagramma.
  2. Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
  3. Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
  4. Scegli Save. Il diagramma compare nella pagina.

La documentazione spiega l’editor, le impostazioni e le esportazioni.

Modelli

Il pulsante Templates dell’editor ha 4 modelli pronti per questo tipo:

  • Domain model: Clienti, ordini, righe d’ordine e prodotti con le loro relazioni.
  • Service layers: Controller, servizio e repository dietro un’interfaccia.
  • Inheritance: Una notifica astratta con le varianti email, SMS e push.
  • Event system: Un event bus, i tipi di evento e gli handler che avvisa.

Sintassi

Il codice inizia con classDiagram. La documentazione di Mermaid (in inglese) descrive ogni elemento della sintassi. Vellnar Diagrams lo disegna con Mermaid 12.3; se una riga ha un errore, l’editor segna la riga e tiene a schermo l’ultimo diagramma valido.

Altro

  • Mermaid in Confluence: come funzionano i diagrammi scritti come codice in una pagina, e tutti i tipi di diagramma.
  • Sicurezza: l’app non chiede nessun permesso e non manda nulla fuori da Atlassian.