Диаграмма последовательности (sequence diagrams)

Что такое диаграмма последовательности?

Диаграмма последовательности — это подвид диаграмм взаимодействия, который позволяет описать взаимодействие между объектами в системе в виде последовательности сообщений, действий и операций, отображая порядок выполнения действий и обмена информацией между объектами во времени.

Диаграммы последовательности отображают взаимодействия между объектами, порядок выполнения операций и обмена информацией во времени. Они помогают улучшить понимание функционирования системы, выявить потенциальные ошибки и проблемы в процессе взаимодействия объектов.

Элементы диаграммы последовательности

Диаграмма состоит из вертикальных линий жизни и горизонтальных стрелок. Линии представляют отдельные объекты, а горизонтальные стрелки — сообщения и операции, передаваемые между объектами или участниками.

При необходимости на диаграмме также указывают активации, фреймы, условные операторы, итерации и тайм-ауты. Они помогают уточнить логику взаимодействия объектов и участников системы. Кроме того, диаграмма может включать комментарии и примечания, чтобы объяснить процесс взаимодействия более подробно.

Объекты

В диаграмме объектами выступают участники системы, такие как акторы (Actor), границы (Boundary), контроллеры (Control) и сущности (Entity). Они называются участниками (Participants) и отображаются в виде пиктограмм или прямоугольника с названием.

Акторы (Actor) представляют пользователей или другие системы, взаимодействующие с системой, которая описывается на диаграмме. Они могут вызывать действия, которые система выполняет в ответ на их запросы. Например, актор может запросить у системы информацию и получить ответ.

Границы (Boundary) определяют внешние границы системы и представляют собой точки входа или выхода, через которые система взаимодействует с внешним миром. Например, граница может представлять интерфейс пользователя, через который пользователь взаимодействует с системой.

Контроллеры (Control) обрабатывают запросы и управляют потоком данных в системе. Они представляют собой узлы, через которые проходят данные и управляющие выполнением операций в системе. Например, контроллер может обрабатывать запросы, которые поступают от акторов и возвращать результаты.

Сущности (Entity) представляют данные и хранят состояние системы. Они могут быть представлены как базы данных или другие системы хранения данных. Например, сущность может обрабатывать запросы на чтение или запись данных.

Каждый объект на диаграмме представлен вертикальной линией жизни, отображающей период времени, когда объект существует и выполняет операции. Кроме того, объекты могут содержать дополнительную информацию, такую как поля или состояния объекта, которые передаются между объектами в сообщениях.

Линии жизни

Линия жизни (lifeline) — это вертикальная линия на диаграмме последовательности UML, которая представляет объект или участника взаимодействия и связывает его с сообщениями во времени. Линия жизни начинается с появления объекта на диаграмме и продолжается до его удаления или окончания взаимодействия.

На линии указываются различные элементы, такие как активности, состояния и метки времени, помогающие уточнить временные параметры взаимодействия объектов.

Линия жизни является основным элементом на диаграмме последовательности, который помогает визуализировать хронологию взаимодействия в системе.

Сообщения

Мгновенные и не мгновенные сообщения

Мгновенные сообщения применяются в тех случаях когда временем затраченным на доставку можно пренебречь. Они отображаются на диаграмме в виде горизонтальных стрелок, соединяющие объекты между собой. Стрелки направлены от отправителя к получателю, содержат метку с именем метода или функции.

Не мгновенные сообщения, как следует из их названия, не могут быть переданы мгновенно, а требуют определенного времени на передачу и обработку. Не мгновенные сообщения применяются в тех случаях, когда время, затраченное на передачу, имеет значение для последовательности действий. Например, в случае, когда передача данных между двумя системами занимает определенное время, необходимо учитывать это время при моделировании процесса.

Отображение не мгновенного сообщения на диаграмме последовательности происходит с помощью наклонной стрелки. Она показывает разницу во времени между отправкой и получением сообщения. Эта стрелка начинается с точки отправления сообщения на линии жизни отправителя и заканчивается на линии жизни получателя, смещенной вправо относительно точки отправления. Наклон стрелки показывает длительность, которая может быть задокументирована или не задокументирована.

Синхронные и асинхронные сообщения

Синхронные сообщения — это сообщения, блокирующие отправителя до тех пор, пока получатель не ответит на него. Они применяются в тех случаях, когда отправитель ожидает ответа от получателя, прежде чем продолжить выполнение своей работы. Синхронные сообщения отображаются на диаграмме с помощью сплошной линии с закрашенной стрелкой, которая начинается у отправителя и заканчивается у получателя. На этой стрелке указывается имя сообщения и/или аргументы.

Асинхронные сообщения — это сообщения, которые отправляются без ожидания ответа от получателя. Они используются, когда отправитель не должен блокировать свою работу, чтобы ждать ответа. Обычно они отображаются на диаграмме с помощью сплошной линии с открытой стрелкой.

При использовании асинхронных сообщений может возникнуть необходимость в других элементах для управления асинхронными процессами. Например, отправитель может активировать другую операцию или объект, который должен обработать сообщение, и затем продолжить свою работу независимо от того, завершится ли обработка в текущей операции или нет.

Активации

Активации на диаграмме используются для отображения времени выполнения операций и вызовов методов внутри системы. Они позволяют увидеть, какие объекты на диаграмме активны в тот момент, когда выполняется та или иная операция или вызывается метод.

Каждый объект имеет свою линию жизни, отображающую его существование во времени. Активация представляет собой область, ограниченную временной продолжительностью, которую занимает выполнение операции или вызов метода. Таким образом, активация показывает, когда и как долго объект активен в процессе выполнения операции.

Активации используются для моделирования последовательности взаимодействия внутри системы. Они позволяют лучше понять порядок выполнения операций и вызовов методов, а также определить возможные ошибки.

Фреймы

Фреймы — это структурированные блоки, которые используются для организации группы сообщений в логически связанные последовательности.

Фрейм Alt

На диаграмме последовательности фрейм alt используется для представления условного оператора, позволяющего определить две или более взаимоисключающие альтернативы выполнения действий в зависимости от условия. Он может содержать один или несколько блоков альтернатив.

Блок альтернативы представляет собой условный блок, содержащий один или несколько сообщений. Каждый блок альтернативы имеет свое условие, которое должно быть истинным для того, чтобы блок выполнился. Если условие блока не истинно, то блок пропускается.

На диаграмме фрейм alt строится с помощью ключевых слов alt, else и end и отображается в виде горизонтального прямоугольника, разделенным пунктирной линией на несколько блоков альтернатив. Код, расположенный между alt и else, описывает условие, при котором нужно выполнить определенный блок действий. Код, расположенный между else и end, описывает действия, которые нужно выполнить, если условие не выполнено.

Фрейм Opt

Фрейм opt (от «optional», на русском «необязательный») — позволяет указать, что определенные сообщения являются необязательными. Таким образом, если условие выполняется, то сообщение отправляется, а если нет, то сообщение не отправляется.

Фрейм opt используется, когда выполнение какой-то части последовательности необязательно и может быть пропущено, если не выполняется определенное условие. Например, процесс покупки товара онлайн,он может использоваться для отображения условия наличия купона на скидку. Если купон есть, то будет отправлено сообщение для применения скидки, а если нет, то этот шаг может быть пропущен.

На диаграмме он отображается как прямоугольник, содержащий условие в квадратных скобках. Если условие выполняется, то соответствующее сообщение будет отправлено, иначе он будет пропущен.

Фрейм Loop

Фрейм «loop» на диаграмме последовательности используется для описания повторяющегося процесса или цикла. Он указывает, что определенная последовательность действий должна быть выполнена несколько раз, пока не будет выполнено определенное условие.

Ключевое слово «loop» указывает на начало цикла, а «end loop» — на его конец. Условие, которое указывается в квадратных скобках, определяет, когда цикл должен завершиться.

Фрейм «loop» отображается в виде прямоугольника, внутри которого располагается последовательность действий, которые должны быть выполнены в рамках цикла. В верхней части прямоугольника указывается условие завершения цикла.

Фрейм Par

Фрейм par (parallel) используется на диаграммах для отображения параллельных процессов, которые происходят одновременно и независимо друг от друга. Он позволяет разделять диаграмму на несколько потоков выполнения, которые могут выполняться параллельно.

Фрейм par представляется как прямоугольник, внутри которого располагаются стрелки, отображающие процессы, выполняющиеся параллельно. Каждый из этих процессов представлен в виде своей собственной последовательности шагов и взаимодействий.

Фрейм Neg

Фрейм neg (или Negative Frame) на диаграмме используется для представления альтернативной сценарной ветки, которая не должна происходить в системе. То есть он используется для описания ошибок или невозможных сценариев.

На диаграмме фрейм neg отображается в виде прямоугольника, с диагональной чертой, разделяющей область выполнения на две части. Фрейм neg может содержать вложенные элементы, такие как сообщения, объекты, а также другие фреймы.

Фрейм Ref

На диаграмме фрейм Ref (Reference) используется для ссылки на другую диаграмму или фрагмент кода, который описывает детали процесса внутри данного фрейма. Он позволяет вынести подробную информацию на отдельную диаграмму, упрощая основную диаграмму и делая её более читабельной.

Фрейм SD

На диаграмме последовательности фрейм SD (Sequence Diagram) позволяет очертить всю диаграмму и указать ее имя. Обычно используется если на диаграмму ссылается другая диаграмма.

Комментарии

Объект «комментарии» — это специальный элемент, который используется для добавления дополнительной информации на диаграмму. Комментарии могут взаимодействовать с другими объектами на диаграмме. Они просто содержат текстовую информацию и могут использоваться для пояснения, объяснения или уточнения элементов диаграммы.

Комментарии изображаются в виде прямоугольника, внутри которого находится текст. Они связаны со своими целевыми элементами путем использования пунктирной линии или стрелки.

Комментарии используются в различных случаях. Например, для объяснения сложных элементов, для документирования принятых решений или для отображения дополнительной информации, которая не имеет места в структуре самой диаграммы.

Пример использования комментариев на диаграмме может быть связан с объяснением назначения или цели любого элемента на диаграмме. Комментарии также используются для пояснения временных ограничений или других деталей, связанных с последовательностью действий.

Как построить диаграмму последовательности

Диаграмма последовательности представляет собой визуальное представление потока событий, которые происходят в рамках конкретного сценария использования. Ее основа — это описание конкретного случая использования. Он определяет какие объекты участвовать в процессе и как они будут взаимодействовать.

Перед началом построения диаграммы важно подготовить сценарии использования. Как составить качественные сценарии использования (Use Case) я уже рассказывал в прошлой статье. Далее следует определить объекты или агенты, которые будут участвовать в процессе. Затем необходимо написать подробное описание того, что происходит в конкретном сценарии использования. На основе этого описания можно выявить взаимодействия, которые будут происходить в системе.

Для построения диаграммы последовательности не обязательно наличие use case. Однако, use cases могут быть полезны при определении актеров (внешних сущностей) и их взаимодействия с системой. Это может помочь в дальнейшем определении объектов и сообщений на диаграмме последовательности.

Но если вы уже провели анализ требований и определили основные функциональные требования к системе, включая актеров и их взаимодействие с системой, то можно перейти к построению диаграммы последовательности. Если же этого анализа ещё не было, то может иметь смысл сначала провести анализ требований и построить диаграмму прецедентов.

Распространенные ошибки в диаграммах последовательностей

Диаграммы последовательности – это удобный инструмент для моделирования взаимодействия в системе. Несмотря на то, что они являются довольно простыми в использовании, всегда есть вероятность допустить ошибки, которые могут привести к неправильному пониманию взаимодействия внутри системы.

Рассмотрим несколько самых распространенных ошибок, возникающих при создании диаграмм последовательности.

Отсутствие участников. Отсутствие всех участников, участвующих во взаимодействии может привести к тому, что сценарий будет неполным и непонятным для пользователей. Чтобы избежать этой ошибки, необходимо внимательно изучить взаимодействие между объектами и убедиться, что все участники, которые участвуют во взаимодействии, являются частью диаграммы последовательности.

Неверное использование стрелок. Стрелки на диаграмме используются для обозначения потока сообщений между участниками, и неправильное использование стрелок может привести к тому, что сценарий станет непонятным. Для избежания этой ошибки необходимо внимательно изучить поток сообщений между участниками и правильно использовать стрелки.

Неправильное порядка действий. Диаграмма представляет собой последовательность действий, выполняющихся в определенном порядке, и неправильное указание может привести к тому, что сценарий станет непонятным. Чтобы избежать этой ошибки, необходимо внимательно изучить сценарий и правильно указать последовательность действий, в которое выполняются действия на диаграмме последовательности.

Отсутствие альтернативных потоков. Диаграмма должна показывать все возможные пути выполнения сценария использования, включая альтернативные пути и исключения. Если на диаграмме отсутствуют альтернативные потоки, то это может привести к тому, что сценарий использования не будет полностью понятным, и его выполнение может быть затруднительным. Необходимо убедиться, что все эти потоки отображены на диаграмме последовательности и правильно описаны.

Неправильное описание сообщений. Каждое сообщение на диаграмме должно быть правильно описано, чтобы сценарий использования был понятным и легко воспринимаемым. Необходимо убедиться, что все сообщения правильно описаны и понятны.

Неправильное расположение. Если объекты на диаграмме расположены неправильно, то это может привести к тому, что сценарий использования станет непонятным, и его выполнение может быть затруднительным. Объекты должны быть расположены в порядке выполнения действий, и все соединения должны быть ясными и легко понятными.

Пример диаграммы последовательности