Диаграмма последовательности (UML Sequence Diagram)
В предыдущих уроках вы познакомились с программными интерфейсами. В этом уроке вы узнаете об одном из способов изображения вызовов между компонентами — диаграмме последовательности.
Диаграмма последовательности UML
Диаграмма последовательности UML — это способ графического отображения взаимодействия объектов, который делает акцент на временной последовательности этого взаимодействия.
Диаграмма последовательности содержит набор объектов, участвующих во взаимодействии, и сообщений, отправляемых и получаемых этими объектами.
Системный аналитик составляет диаграмму последовательности, чтобы объяснить команде разработки, в каком порядке и какими сообщениями обмениваются элементы системы.
Для составления диаграммы взаимодействия используется нотация UML.
Элементы диаграммы
Диаграмма последовательности имеет две оси:
- Горизонтальная ось — отображает взаимодействие между объектами.
- Вертикальная ось — отображает хронологический порядок взаимодействия.
Стандартная диаграмма компонентов состоит из следующих элементов:
- Акторы (Actors).
- Объекты (Objects).
- Линии жизни (Lifelines).
- Фокус управления (Focus of control).
- Сообщения (Messages).
Акторы (Actors)
Актор используется для того, чтобы отобразить на диаграмме пользователя-человека или внешнее ПО, которое взаимодействует с описываемой системой. Графически актора изображают в виде фигуры человека.
Акторы, которые включены в диаграмму взаимодействия, располагаются в верхней части диаграммы последовательности на горизонтальной оси.
Объекты (Objects)
Объекты на диаграмме отображают сущность с определёнными границами, состоянием и поведением. Например, на диаграмме могут быть отображены классы программы, сервисы приложения и даже базы данных.
Объекты изображаются на диаграмме в виде прямоугольника с именем внутри.
Объекты располагаются по горизонтальной оси в верхней части диаграммы последовательности. Объект или актор, который инициирует взаимодействие, располагается в самом начале горизонтальной оси.
Линии жизни (Lifelines)
Линия жизни отображает продолжительность жизни участника диаграммы (объекта или актора) внутри системы.
Линия жизни отображается как пунктирная линия, которая отходит вниз от объекта или актора по вертикальной оси.
Рассмотрим простой сайт развлекательного центра, у которого вся логика находится в монолите, а все данные хранятся в одной базе данных. Изображение актора (пользователь) и объектов (сайт, база данных) на диаграмме последовательности будет выглядеть так:
Фокус управления (Focus of control)
Фокус управления показывает период, в течение которого объект выполняет некоторое действие, например: вычисления или ожидание ответа от другой сущности.
Фокус управления изображается в виде вытянутого по вертикали прямоугольника, который располагается на линии жизни объекта.
Пока объект или актор выполняют действие или ожидают ответ от другого актора, на их линии жизни есть фокус управления.
Фокус управления также иногда называют активацией (Activation). Для сайта развлекательного центра фокус управления на диаграмме будет выглядеть так:
Фокус управления — необязательный компонент. Чаще всего в работе будут встречаться диаграммы без этого элемента.
Сообщения (Messages)
Сообщения — самый важный элемент диаграммы последовательности. Они обозначают передачу вызова от одного объекта к другому (или вызов самого себя). Сообщения также используются для того, чтобы обозначить ответы на вызовы.
Строить потоки сообщений нужно с левого верхнего объекта или актора. Затем необходимо спускаться вниз по вертикальной оси. Сообщения представлены на диаграмме как стрелки с подписями. Направление стрелки определяет сущность отправителя и сущность получателя.
Над стрелкой, как правило, подписывают название вызываемого API. Если названия API ещё неизвестны, нужно указать, что планируется запросить/передать в результате данного взаимодействия. В скобках после названия вызываемого метода указываются параметры, которые необходимо передать в данном сообщении. Например, для авторизации необходимо передать логин и пароль. На диаграмме последовательности это будет изображено так:
Сообщения в диаграмме последовательностей могут отображать различные виды взаимодействия.
Синхронное взаимодействие
Вы уже знаете о режимах взаимодействия из урока о стилях взаимодействия. Для отображения синхронного взаимодействия используют стрелки, изображённые сплошной линией с закрашенным наконечником.
Ответное сообщение
Ответ при синхронном взаимодействии обозначается стрелкой, изображённой пунктирной линией и с незакрашенным наконечником.
Асинхронное взаимодействие
Асинхронный вызов может изображаться на диаграмме двумя способами:
- Сплошной стрелкой с незакрашенным наконечником.
- Сплошной стрелкой с половиной наконечника.
При асинхронном вызове ответное сообщение не требуется.
Создание нового объекта
Один объект диаграммы может создавать другой объект. Например, клиент может размещать заказ, а класс в коде может создавать другой класс. На диаграмме это изображается как объект, в который входит закрашенная стрелка.
Удаление объекта
Одни объекты могут удалять с диаграммы другие объекты. После того, как один объект выполнил вызов удаления другого объекта, линия жизни удаленного объекта прерывается. Конец линии жизни обозначается крестом.
Фрагменты диаграммы
Помимо основных элементов, в диаграмму последовательности часто включают особые части — фрагменты. К фрагментам относят некоторые части диаграммы, которые обозначают альтернативные сценарии или повторяющиеся действия.
Фрагмент отделяется от остальной диаграммы рамкой с указанием оператора в левом верхнем углу.
Операторы обозначают, какие именно взаимодействия содержит фрагмент диаграммы:
К этой диаграмме добавлен фрагмент alt, который описывает два альтернативных сценария: авторизация может быть пройдена или не пройдена.
Второй фрагмент — опциональный — зависит от того, подключена ли у этого пользователя пользовательская рассылка.
Перед вам диаграмма последовательности для сервиса доставки еды. Выберите элементы, которые должны быть на месте пропусков.
Что должно быть на месте пропуска А?
Ответное сообщение
Без подтверждения авторизации пользователь не может продолжать работать с сервисом. Запрос авторизации — синхронное взаимодействие, которое требует ответа.
Что должно быть на месте пропуска Б?
Асинхронное взаимодействие
Сервис отправляет смс-оповещение и не ожидает никакого ответа — это асинхронное взаимодействие.
Что должно быть на месте пропуска С?
Синхронное взаимодействие
На диаграмме видно, что микросервис истории заказов возвращает в ответ историю заказов, а значит, взаимодействие синхронное.
Подведём итоги
Диаграмма последовательности UML — это способ графического отображения взаимодействия объектов, который делает акцент на временной последовательности этого взаимодействия.
Элементы нотации UML, которые используются для построения диаграммы последовательности:
- Акторы (Actors) — используются для отображения на диаграмме пользователя-человека или внешнего ПО, которое взаимодействует с описываемой системой.
- Объекты (Objects) — используются для отображения программ, сервисов приложения, классов, баз данных и так далее. Взаимодействуют с другими сущностями в рамках диаграммы.
- Линии жизни (Lifelines) — отображают продолжительность жизни участника диаграммы (объекта или актора) внутри системы.
- Фокус управления (Focus of control) — используется для отображения периода, в течение которого объект выполняет некоторое действие.
- Сообщения (Messages) — используются для обозначения передачи вызова от одного объекта к другому (или вызова самого себя).
Системный аналитик составляет диаграмму последовательности для того, чтобы объяснить команде разработки, в каком порядке и какими сообщениями обмениваются элементы системы.