PlantUML on työkalu, jolla voi kuvata ja tuottaa UML-kaavioita kirjoittamalla yksinkertaista tekstipohjaista kuvauskieltä. Työkalu muuntaa tekstin automaattisesti kuviksi (esim. PNG, SVG) tai asiakirjoiksi.

• Luokkakaavio (Class Diagram)
• Järjestyskaavio (Sequence Diagram)
• Käyttötapauskaavio (Use Case)
• Tilakaavio (State)
• Toimintokaavio (Activity)
• Komponentti- ja sijoittelukaaviot (Component, Deployment)

• Nopea: kaaviot syntyvät tekstistä, helppo versioida.
• Yhteensopiva: toimii monissa editoreissa ja putkissa.
• Ylläpidettävä: pienet muutokset onnistuvat ilman piirto-ohjelmia.

1. Asenna Java koneellesi
2. Kirjoita kuvaus kielellä tiedostoon, jonka pääte yleensä puml.
3. Aja PlantUML (komentoriviltä, editorilaajennuksella tai CI:ssä).
4. Saat generaattuna kaaviokuvan ja voit liittää sen dokumentaatioon.

Esittelyvideo

1. Kirjoitetaan oheinen koodi tiedostoon esim.puml

   @startuml
   actor User
   User --> (Login)
   @enduml

2. Suoritetaan komento java -jar plantuml-1.2025.0.jar esim.puml
3. Saatiin kuva nimeltään esim1.png, joka on seuraavanlainen:
   

Esimerkki1 (luokka)

Koodi

@startuml

class Student {
- string firstname;
- string lastname;

+ setFirstname(string fname): void
+ getFirstname(): string

}

@enduml

Kaavio:

Esimerkki2: assosiaatio

Koodi

@startuml
class Doctor {
}

class Patient {
}

Doctor "1" -- "n" Patient : diagnose >
@enduml

Kaavio:

Esimerkki3: aggregaatio

Koodi

@startuml
class Team {
}

class Player {
}

Team o-- "many" Player : has >
@enduml

Kaavio:

Esimerkki4: kompositio

Koodi

@startuml
class Car {
}

class Engine {
}

Car *-- Engine : contains >
@enduml

Kaavio:

Esimerkki5: perintä

Koodi

@startuml
class Person {
}

class Student {
}

Person <|-- Student
@enduml

Kaavio: