Введение

Диаграммы классов PlantUML описывают статическую структуру системы: её классы, атрибуты, операции и связи. Вы пишете текстовое описание и рендерите его в виде диаграммы, что делает исходный код удобным для редактирования и контроля версий.
1. Минимальная диаграмма
Диаграмма класса начинается с@startuml и заканчивается@enduml:

@startuml
class User
class Order
User --> Order : places
@enduml
PlantUML может выводить классы из объявлений связей, но явное объявление классов упрощает сканирование и поддержку более крупных диаграмм.
2. Классы, атрибуты и методы
Размещайте атрибуты и операции в фигурных скобках. Двоеточие отделяет имя члена от его типа; скобки обозначают операцию.

@startuml
class User {
-id: int
-email: String
+login(password: String): boolean
+logout(): void
}
@enduml
Маркеры видимости:
-
+public -
-private -
#protected -
~package-private
Вы также можете записать тип перед именем члена — например, +String email или +void logout(). PlantUML поддерживает как привычную нотацию членов, похожую на код, так и эти маркеры видимости.
Статические и абстрактные члены
Используйте {static} или {classifier} для статических членов и {abstract} для абстрактных членов:

@startuml
abstract class PaymentMethod {
{abstract} +authorize(amount: Decimal): boolean
{static} +supportedCurrencies: String[]
}
class CardPayment {
+authorize(amount: Decimal): boolean
}
PaymentMethod <|-- CardPayment
@enduml
Абстрактный класс также может быть объявлен с помощью abstract class.
3. Связи
Форма стрелки указывает тип связи. Направление линии определяется порядком имён; используйте подписи для уточнения её смысла.
| Связь | Обозначение PlantUML | Типичное значение |
|---|---|---|
| Наследование / обобщение | `Parent < | — Child` |
| Реализация интерфейса | `Interface < | .. Class` |
| Композиция | Целое *-- Часть |
Жизненный цикл части принадлежит целому |
| Агрегация | Целое o-- Часть |
Целое группирует или ссылается на части, которые могут существовать независимо |
| Направленная ассоциация | A --> B |
A имеет навигируемую связь с B |
| Зависимость | A ..> B |
A использует или зависит от B |
Это стандартные обозначения связей в PlantUML.

@startuml
interface Repository
class SqlRepository
class OrderService
class Order
class OrderLine
Repository <|.. SqlRepository
OrderService ..> Repository : uses
Order *-- "1..*" OrderLine : содержит
@enduml
Выбирайте внимательно:Композиция и агрегация выражают различные семантики жизненного цикла. Используйте композицию только тогда, когда часть осмысленно принадлежит целому; используйте обычную ассоциацию, когда ни одна из интерпретаций принадлежности не подходит.
4. Множественность, имена ролей и метки
Множественность определяет, сколько объектов может участвовать на каждом конце ассоциации. Распространённые формы включают "1", "0..1", "*", и "1..*".

@startuml
class Customer
class Order
Customer "1" --> "0..*" Order : размещает
@enduml
Здесь каждый Заказ связан с одним Клиентом, в то время как Клиентом может размещать ноль или более заказов. Считывайте кратности с противоположного конца: число рядом с “Заказ описывает, сколько заказов может быть связано с клиентом.
Для большей точности добавьте имена ролей или ограничения:

@startuml
class Team
class Player
Team "1" o-- "0..*" Player : members
note on link
Игрок может переходить между командами.
end note
@enduml
5. Интерфейсы, перечисления, стереотипы и пакеты
PlantUML поддерживает объявления, такие как интерфейс, перечисление, абстрактный класс, а также стереотипы, записанные между << и >>.

@startuml
package "Ordering" {
interface PaymentGateway {
+charge(amount: Decimal): PaymentResult
}
enum OrderStatus {
NEW
PAID
CANCELLED
}
class Order <<Entity>> {
+id: UUID
+status: OrderStatus
}
class CheckoutService <<Service>> {
+checkout(order: Order): PaymentResult
}
CheckoutService ..> PaymentGateway : calls
Order --> OrderStatus
}
@enduml
Пакеты визуально группируют связанные типы. Используйте стереотипы, такие как “<<Entity>> или “<<Service>> когда они добавляют полезный контекст; избегайте добавления меток, которые лишь повторяют то, что уже сказано в имени класса.
6. Примечания, псевдонимы и компоновка
Примечания могут объяснять проектные решения или уточнять ограничения, не перегружая имена классов. Псевдонимы полезны, когда отображаемое имя содержит пробелы или знаки препинания.

@startuml
class "External Payment API" as PaymentApi
class CheckoutService
CheckoutService ..> PaymentApi : submits payment
note right of CheckoutService
Retries transient failures.
Does not retry declined payments.
end note
left to right direction
@enduml
направление слева направо изменяет общее направление компоновки; по умолчанию используется направление сверху вниз. Вы также можете использовать направления связей, такие как “-left-> или “-up-|> для управления локальным размещением.
7. Более полный пример
Этот пример объединяет видимость, типы, методы, перечисления, кратности, композицию и зависимости:

@startuml
left to right direction
package "Sales" {
class Customer {
-id: UUID
+name: String
+placeOrder(): Order
}
class Order {
-id: UUID
-status: OrderStatus
+addLine(product: Product, quantity: int): void
+total(): Decimal
}
class OrderLine {
-quantity: int
+lineTotal(): Decimal
}
class Product {
+sku: String
+price: Decimal
}
enum OrderStatus {
NEW
PAID
CANCELLED
}
interface PaymentGateway {
+charge(amount: Decimal): PaymentResult
}
class CheckoutService {
+checkout(order: Order): PaymentResult
}
Customer "1" --> "0..*" Order : places
Order *-- "1..*" OrderLine : contains
OrderLine "*" --> "1" Product : refers to
Order --> OrderStatus
CheckoutService ..> PaymentGateway : uses
}
@enduml
8. Инструментарий: Visual Paradigm VPasCode
VPasCode — это браузерный редактор для преобразования текста в диаграммы от Visual Paradigm. Он поддерживает диаграммы классов PlantUML и предоставляет редактор кода с предпросмотром в реальном времени, что позволяет писать или вставлять код PlantUML и сразу просматривать результат рендеринга по мере работы.

Типичный рабочий процесс:
-
Откройте VPasCode и выберите редактор PlantUML или пример PlantUML.
-
Замените исходный текст своей диаграммой, включая
@startumlи@enduml. -
Проверьте предпросмотр в реальном времени; если рендеринг не удался, проанализируйте выделенную ошибку синтаксиса и соответствующую строку.
-
Уточните диаграмму, затем экспортируйте или поделитесь ею при необходимости. VPasCode описывает варианты экспорта в форматах SVG, PNG и PDF.
VPasCode также предоставляет интерфейс выбора тем для PlantUML, включая темы Visual Paradigm и Rose. Для обеспечения единообразия результатов в команде храните исходный код PlantUML вместе с документацией или кодом, а не полагайтесь исключительно на экспортированное изображение.
9. Типичные ошибки и лучшие практики

-
Не путайте ассоциацию с зависимостью.Зависимость обычно означает «использует»; ассоциация часто представляет более устойчивую структурную связь.
-
Избегайте чрезмерного использования композиции.Она подразумевает более строгую связь жизненных циклов, чем простое соединение.
-
Подписывайте кратности с противоположного конца.Число рядом с одним классом указывает, сколько экземпляров этого класса могут быть связаны с одним экземпляром на противоположном конце.
-
Держите диаграммы сфокусированными.Разделите очень большую модель на пакеты или отдельные диаграммы для различных аспектов.
-
Показывайте детали, которые полезны для аудитории.Концептуальный обзор может требовать только названий классов и связей; диаграмма уровня проектирования может потребовать типов, видимости и операций.
-
Рассматривайте исходный код как поддерживаемый артефакт.Проверяйте изменения в тексте, выполняйте рендеринг после правок и регенерируйте экспортированные файлы при изменении исходного кода.
Быстрая справка

@startuml
class A {
+publicField: String
-privateField: int
#protectedMethod(): void
~packageMember(): boolean
}
interface I
abstract class Base
enum State { READY; DONE }
Base <|-- A
I <|.. A
A *-- B : composition
A o-- C : aggregation
A --> D : association
A ..> I : dependency
@enduml
PlantUML поддерживает дополнительные возможности диаграмм классов, включая группировку членов, заметки, цвета и многое другое, когда диаграмма требует дальнейшей доработки.










