Полное руководство по диаграммам компонентов UML: Визуализация архитектуры системы

PlantUML Edit PlantUML in VPasCode

@startuml
skinparam componentStyle uml2
skinparam BackgroundColor white
skinparam DefaultFontName Arial

' Конфигурация стилей для соответствия синим цветам
skinparam component {
    BackgroundColor #66b3ff
    BorderColor #004d99
    FontColor black
}
skinparam interface {
    BackgroundColor #66b3ff
    BorderColor #004d99
}

' Компоненты
component "Система заказов" as OrderSystem
component "Хранилище клиентов" as CustomerRepo
component "Система инвентаризации" as InventorySystem

' Интерфейсы и соединения
interface "Поиск клиента" as CustomerLookup
interface "Доступ к продукту" as ProductAccessor

OrderSystem -( CustomerLookup
CustomerLookup - CustomerRepo

OrderSystem --( ProductAccessor
ProductAccessor -- InventorySystem

@enduml

Подсистемы

Подсистемаклассификатор подсистемы — это специализированная версия классификатора компонента. В связи с этим элемент нотации подсистемы наследует все те же правила, что и элемент нотации компонента. Единственное отличие заключается в том, что элемент нотации подсистемы имеет ключевое слово<<подсистема>> вместо <<компонент>>.

Порты

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

Связи

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

Связи	Обозначения	Описание
Ассоциация		Ассоциация определяет семантическую связь, которая может возникать между типизированными экземплярами. Она имеет как минимум два конца, представленных свойствами, каждое из которых связано с типом конца.
Композиция		Композитная агрегация — это сильная форма агрегации, требующая, чтобы экземпляр части входил не более чем в один композит одновременно. Если композит удаляется, все его части обычно удаляются вместе с ним.
Агрегация		Вид ассоциации, у которой один из концов помечен как разделяемая агрегация, что означает наличие разделяемой агрегации.
Ограничение		Условие или ограничение, выраженное в тексте на естественном языке или в языке, читаемом машиной, с целью объявления части семантики элемента.
Зависимость		Зависимость означает, что один или набор элементов модели требуют других элементов модели для их спецификации или реализации. Зависящие элементы семантически или структурно зависят от поставщика (поставщиков) элементов.
Обобщение		Таксономическая связь между более общим классификатором и более специфичным классификатором. Каждый экземпляр специфичного классификатора также является косвенным экземпляром общего классификатора, наследуя его характеристики.

Практические применения

1. Моделирование исходного кода

Как путем прямого, так и обратного инжиниринга определите набор интересующих файлов исходного кода и смоделируйте их как компоненты, стереотипизированные как<<file>>.
Для крупных систем используйте пакеты для отображения групп файлов исходного кода.
Рассмотрите возможность экспорта тегированного значения, указывающего на информацию, такую как номер версии файла исходного кода, его автор и дата последнего изменения. Используйте инструменты для управления значением этого тега.
Моделируйте зависимости компиляции между этими файлами с помощью зависимостей. Снова используйте инструменты для помощи в генерации и управлении этими зависимостями.

Пример компонента — исходный код Java

Пример диаграммы компонентов — код C++ с версионированием

Аналог PlantUML для моделирования исходного кода:

PlantUML Edit PlantUML in VPasCode

@startuml
skinparam componentStyle uml2
skinparam BackgroundColor white
skinparam DefaultFontName Arial

' Конфигурация стиля для соответствия синим цветам
skinparam component {
    BackgroundColor #66b3ff
    BorderColor #004d99
    FontColor black
}

' Ряд компонентов 1 (Версии)
component "signal.h (v3.5)" as signal35
component "signal.h (v4.0)" as signal40
component "signal.h (v4.1)" as signal41

' Ряд компонентов 2
component "interp.cpp" as interp
component "signal.h (v5.0)" as signal50

' Ряд компонентов 3
component "irq.h" as irq
component "device.cpp" as device

' Соединения и переопределения макета
' Родители верхнего ряда, указывающие влево
signal40 .left.> signal35 : <>
signal41 .left.> signal40 : <>

' Вертикальные зависимости
interp .up.> signal41
signal50 .up.> signal41

interp .down.> irq
device .up.> interp

@enduml

2. Моделирование исполняемого релиза

Определите набор компонентов, которые вы хотите смоделировать. Обычно это включает в себя некоторые или все компоненты, находящиеся на одном узле, или распределение этих наборов компонентов по всем узлам системы.
Рассмотрите стереотип каждого компонента в этом наборе. Для большинства систем вы обнаружите небольшое количество различных типов компонентов (например, исполняемые файлы, библиотеки, таблицы, файлы и документы). Вы можете использовать механизмы расширяемости UML для предоставления визуальных подсказок для этих стереотипов.
Для каждого компонента в этом наборе рассмотрите его связь с соседями. Чаще всего это будет включать интерфейсы, которые экспортируются (реализуются) определенными компонентами, а затем импортируются (используются) другими. Если вы хотите явно показать стыки в вашей системе, смоделируйте эти интерфейсы явно. Если вы хотите получить модель на более высоком уровне абстракции, опустите эти связи, показав только зависимости между компонентами.

Аналог PlantUML для исполняемого релиза:

PlantUML Edit PlantUML in VPasCode

@startuml
skinparam componentStyle uml2
skinparam BackgroundColor white
skinparam DefaultFontName Arial

' Современная синяя стилизация для соответствия стилю вашей диаграммы
skinparam component {
    BackgroundColor #5cadff
    BorderColor #2b7fff
    FontColor black
    RoundCorner 10
}
skinparam interface {
    BackgroundColor #5cadff
    BorderColor #2b7fff
}

' Компоненты
component "path.dll" as path
component "collision.dll" as collision
component "driver.dlln(version = "B.2.1.3")" as driver

' Интерфейсы
interface IDrive
interface ISelfTest

' Расположение и чистые соединения
path .right.> collision

' Использование скрытых макетов для принудительной вертикальной укладки интерфейсов
IDrive -[hidden]down- ISelfTest

' Чистое подключение драйвера к его интерфейсам слева
driver -left- IDrive
driver -left- ISelfTest

' Чистая прямая вертикальная линия зависимости
path .down.> IDrive

@enduml

3. Моделирование физической базы данных

Определите классы в вашей модели, которые представляют схему вашей логической базы данных.
Выберите стратегию отображения этих классов на таблицы. Вам также необходимо будет рассмотреть физическое распределение ваших баз данных. Ваша стратегия отображения будет зависеть от места, где вы хотите разместить ваши данные в развернутой системе.
Для визуализации, спецификации, построения и документирования вашего отображения создайте диаграмму компонентов, содержащую компоненты со стереотипом <<table>>.
По возможности используйте инструменты для помощи в преобразовании вашей логической схемы в физическую.

Аналог PlantUML для физической базы данных:

PlantUML

Редактировать Plantuml в VPasCode

PlantUML Edit PlantUML in VPasCode

@startuml
skinparam componentStyle uml2
skinparam BackgroundColor white
skinparam DefaultFontName Arial
skinparam linetype ortho

' Конфигурация стиля для соответствия синим цветам
skinparam component {
    BackgroundColor #66b3ff
    BorderColor #004d99
    FontColor black
}

' Родительский компонент
component "school.db" as school_db

' Дочерние компоненты
component "course" as course
component "department" as dept
component "instructor" as instructor
component "school" as school
component "student" as student

' Скрытые связи для обеспечения горизонтального выравнивания в ряд
course -[hidden]right- dept
dept -[hidden]right- instructor
instructor -[hidden]right- school
school -[hidden]right- student

' Отношения композиции (черный ромб)
school_db *-- course
school_db *-- dept
school_db *-- instructor
school_db *-- school
school_db *-- student

@endif