Итак, начинаем.
Класс и его элементы в PlantUML можно задать двумя способами: указав имя класса и через
двоеточие член класса или указав перед именем ключевое слово class:
Первый способ избыточен (нам для каждого свойства придется указывать к какому классу оно относится), да и когда мы хотим промоделировать отношения классов без их внутреннего устройства — неприменим. Поэтому далее я буду использовать нотацию с применением ключевого слова class. Для того чтобы редактору дать понять какие члены относятся к классу используются фигурные скобки. Дальше редактор определяет данные или метод находятся перед ним на основе круглых скобок. Пусть у нас есть самолет, который умеет взлетать, и у него есть некоторая коллекция двигателей. Текст такой диаграммы может иметь вид:
В редакторе такому коду будет соответствовать следующая диаграмма:
Это последняя картинка, когда я делаю скриншот с Visual Studo Code, дальше буду показывать текст разметки и результирующую диаграмму.
Члены класса
Как я написал выше, методы и поля PlantUML отличает по круглым скобкам. Для задания модификатора доступа используются те же значки, что и в нотации UML, по умолчанию, они заменяются значками:
Т.е. мы можем задать для нашего самолета, что двигатели являются приватными, запуск двигателей доступен в потомках, техобслуживание является доступным только в рамках сборки, а команда на взлет — публичной:
В этом случае диаграмма будет выглядеть вот так:
Если лень запоминать значки, то можно вернуть отображение к стандартной UML нотации, для этого достаточно добавить в файл строку:
После этого, отображение вернется к стандартным значкам UML:
Кроме модификаторов доступа можно как и в UML помечать статические члены класса (подчеркнутые) и абстрактные (выделяются курсивом). Для этого используются ключевые слова static и abstract указываемые перед именем члена. Давайте добавим статическую переменную Count для хранения общего количества самолетов и абстрактный метод Fly:
Вот так это будет выглядеть на диаграмме:
Абстрактные классы и интерфейсы
Для отображения абстрактных классов и интерфейсов, что логично, используются ключевые слова abstract и interface:
Отображаться эти элементы будут аналогично классам, только будет отличаться буква перед именем класса и имя класса будет курсивом:
Связи
1. Обобщение, оно же — наследование. Изображается стрелкой с треугольником на конце. Для задания связи между объектами в PlantUML применяется синтаксис состояний из имен двух элементов диаграммы и стрелки между ними. Для треугольной стрелки со сплошной линией отношение будет заданно следующим образом:
Внешний вид такой связи на диаграмме:
2. Реализация — классом некоторого интерфейса. Изображается как наследование, только линия пунктирная. Для задания такой линии необходимо минусы заменить на точки:
Выглядит связь следующим образом:
3. Зависимость — показывает, что при изменении одного класса, должен измениться и зависимый. Связь отличается от предыдущие отсутствием вертикальной черты, также обратите внимание, что направление стрелки можно задать и в противоположную сторону:
Выглядит:
4. Ассоциация — ссылка одного класса на другой. Изображается обычной стрелкой с названием отношения:
Внешний вид такой связи на диаграмме:
5. Агрегация — белее жесткое уточнение ассоциации, задающее отношение часть-целое. Причем часть может быть отделена и использована сама по себе (например, мы можем снять двигатель и переставить на другой самолет). Задается такое отношение указанием вместо стрелки латинской буквы o:
Выглядит:
6. Композиция — более жесткое уточнение ассоциации, задающее отношение часть-неотделимое целое. Если в предыдущем примере мы не моделируем снятие двигателя с самолета, и уничтожение самолета повлечет за собой уничтожение двигателя, в этом случае заменяем o на *:
Выглядит связь аналогично предыдущей, только ромб будет закрашен:
Пример
В заключении давайте посмотрим, как будет выглядеть итератор в виде кода PlantUML и диаграммы UML соответственно.
Код:
Обратите внимание на три строки перед @enduml, они позволяют задать расположение элементов относительно друг друга, я потом отдельно о этих связях расскажу, а то и так уже много получилось. Ну и внешний вид получившейся диаграммы:
Статический метод Sort добавил для примера, на самом деле у Array еще много чего еще есть, но все перечислять лень 🙂