[Перевод] Structurizr, описание, перевод (часть 2/3)15.01.2024 09:15

Введение

В данной статье содержится вольный перевод документации по Structurizr.

Из-за большого объема информация разделена на три статьи:

Общая информация

Угловые скобки (<...>) показывают обязательные свойства.

Квадратные скобки ([…]) показывают необязательные свойства.

Большинство инструкций имеют вид: ключевое слово <обязательные свойства> [необязательные свойства].

workspace

workspace — языковая конструкция верхнего уровня и оболочка для модели и представлений. Рабочей области можно присвоить имя и описание:

workspace [name] [description] {
    ...
}

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

workspace extends  {
    ...
}

На базовую рабочую область можно ссылаться либо с помощью локального файла DSL/JSON, либо удаленного (через URL HTTPS) файла DSL/JSON. При расширении рабочей области на основе DSL все идентификаторы, определенные в этой рабочей области, доступны для использования в расширенной рабочей области.

Допустимые дочерние элементы:

• name,

• description,

• properties,

• ! docs,

• ! adrs,

• model,

• views,

• configuration.

model

Каждое рабочее пространство должно содержать блок model, внутри которого определены элементы и взаимосвязи.

model {
    ...
}

Допустимые дочерние элементы:

• group,

• person,

• softwareSystem,

• deploymentEnvironment,

• element,

• → (relationship).

enterprise

Конструкция устарела — вместо нее нужно использовать group.

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

enterprise [name] {
    ...
}

Допустимые дочерние элементы:

• group,

• person,

• softwareSystem,

• → (relationship).

group

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

group  {
    ...
}

Группы могут использоваться только для группировки элементов одного типа (одного и того же уровня абстракции) следующим образом:

person

Ключевое слово person определяет человека (пользователя, актера, роль или персону).

person  [description] [tags] {
    ...
}

По умолчанию добавляются следующие теги:

• Element,

• Person.

Допустимые дочерние элементы:

• description,

• tags,

• url,

• properties,

• perspectives,

• → (relationship).

softwareSystem

Ключевое слово определяет программную систему:

softwareSystem  [description] [tags] {
    ...
}

По умолчанию добавляются следующие теги:

• Element,

• Software System.

Допустимые дочерние элементы:

• ! docs,

• ! adrs,

• group,

• container,

• description,

• tags,

• url,

• properties,

• perspectives,

• → (relationship).

container

Ключевое слово определяет контейнер внутри программной системы.

container  [description] [technology] [tags] {
    ...
}

По умолчанию добавляются следующие теги:

• Element,

• Container.

Допустимые дочерние элементы:

• ! docs,

• ! adrs,

• group,

• component,

• description,

• technology,

• tags,

• url,

• properties,

• perspectives,

• → (relationship).

component

Ключевое слово определяет компонент внутри контейнера.

component  [description] [technology] [tags] {
    ...
}

По умолчанию добавляются следующие теги:

• Element,

• Component.

Допустимые дочерние элементы:

• ! docs,

• ! adrs,

• description,

• technology,

• tags,

• url,

• properties,

• perspectives,

• → (relationship).

deploymentEnvironment

Ключевое слово предоставляет способ определения среды развертывания (например, разработка, тестирование, промежуточная обработка, live и тому подобное).

deploymentEnvironment  {
    ...
}

Допустимые дочерние элементы:

• group,

• deploymentGroup,

• deploymentNode,

• → (relationship).

deploymentGroup

Ключевое слово предоставляет способ определения именованной группы развертывания.

deploymentGroup 

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

deploymentNode

Ключевое слово используется для определения узла развертывания.

deploymentNode  [description] [technology] [tags] [instances] {
    ...
}

По умолчанию добавляются следующие теги:

• Element,

• Deployment Node.

Допустимые дочерние элементы:

infrastructureNode

Ключевое слово определяет узел инфраструктуры, который обычно является чем-то вроде балансировщика нагрузки, брандмауэра, службы DNS и тому подобное.

infrastructureNode  [description] [technology] [tags] {
    ...
}

По умолчанию добавляются следующие теги:

• Element,

• Infrastructure Node.

Допустимые дочерние элементы:

• (relationship),

• description,

• technology,

• tags,

• url,

• properties,

• perspectives.

softwareSystemInstance

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

softwareSystemInstance  [deploymentGroups] [tags] {
    ...
}

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

В дополнение к тегам программной системы по умолчанию добавляется тег Software System Instance.

Допустимые дочерние элементы:

• (relationship),

• description,

• tags,

• url,

• properties,

• perspectives,

• healthCheck.

containerInstance

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

containerInstance  [deploymentGroups] [tags] {
    ...
}

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

В дополнение к тегам контейнера, по умолчанию добавляется тег Container Instance.

Допустимые дочерние элементы:

• (relationship),

• description,

• tags,

• url,

• properties,

• perspectives,

• healthCheck.

healthCheck

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

healthCheck   [interval] [timeout]

interval измеряется в секундах (по умолчанию 60 секунд), а timeout в миллисекундах (по умолчанию 0 мс).

element

Ключевое слово определяет пользовательский элемент (доступно только в облачном сервисе Structurizr/локальной установке/Lite).

element  [metadata] [description] [tags] {
    ...
}

По умолчанию добавляется тег Element.

Допустимые дочерние элементы:

• description,

• tags,

• url,

• properties,

• perspectives,

• → (relationship).

relationship

→ используется для определения однонаправленной связи между двумя элементами.

Существует два способа определения взаимосвязей. Первый — явно, где вы явно используете идентификатор источника:

 ->  [description] [technology] [tags] {
    ...
}

Например:

user -> softwareSystem "Uses"

Второй способ — неявно, когда источником отношения является элемент в области видимости:

->  [description] [technology] [tags]

Например:

person user {
    -> softwareSystem "Uses"
}

Это эквивалентно следующему коду, где специальный идентификатор this используется для ссылки на элемент в области видимости:

person user {
    this -> softwareSystem "Uses"
}

По умолчанию добавляется тег Relationship.

С помощью DSL можно создать следующие типы связей:

Допустимые дочерние элементы:

• tags,

• url,

• properties,

• perspectives.

tags

Используется для добавления тегов к элементу или взаимосвязи. Теги могут быть указаны через запятую или по отдельности.

tags "Tag 1"
tags "Tag 1,Tag 2"
tags "Tag 1" "Tag 2"

description

Используется для установки описания элемента или представления.

description "Description"

technology

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

technology "Technology"

instances

Используется для задания количества экземпляров узла развертывания. Это может быть либо статическое число, либо диапазон (например 0…1, 1…3, 5…10, 0… N, 0…, 1…N, 1… и тому подобное).

instances "4"
instances "1..N"

url

Используется для установки URL-адреса элемента или связи.

url 

properties

Блок properties используется для определения одного или нескольких свойств.

properties {
     
    ...
}

perspectives

Блок perspectives используется для определения одной или нескольких перспектив для элемента или взаимосвязи.

perspectives {
     
    ...
}

! ref

Ключевое слово предоставляет способ ссылки на ранее определенный элемент/взаимосвязь и предназначено для использования с функциями extends или ! include. Его можно использовать несколькими способами.

Первый сценарий использования заключается в ссылке на существующий элемент/взаимосвязь, которые были определены с помощью DSL. Это позволяет расширить элемент, на который ссылается данный идентификатор.

!ref  {
  ...
}

Или, если вы расширяете рабочее пространство на основе JSON, вы можете ссылаться на элемент по его «каноническому имени» и присваивать ему идентификатор.

 = !ref  {
  ...
}

views

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

views {
    ...
}

Блок views может содержать следующие элементы:

• systemLandscape,

• systemContext,

• container,

• component,

• filtered,

• dynamic,

• deployment,

• custom,

• image,

• styles,

• theme,

• themes,

• branding,

• terminology,

• properties.

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

!script groovy {
    workspace.views.createDefaultViews()
}

systemLandscape view

Ключевое слово используется для определения ландшафтного представления системы.

systemLandscape [key] [description] {
    ...
}

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

Допустимые дочерние элементы:

• include,

• exclude,

• autoLayout,

• default,

• animation,

• title,

• description,

• properties.

systemContext view

Ключевое слово используется для определения представления системного контекста указанной программной системы.

systemContext  [key] [description] {
    ...
}

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

Допустимые дочерние элементы:

• include,

• exclude,

• autoLayout,

• default,

• animation,

• title,

• description,

• properties.

container view

Ключевое слово для определения представления контейнера для указанной программной системы.

container  [key] [description] {
    ...
}

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

Допустимые дочерние элементы:

• include,

• exclude,

• autoLayout,

• default,

• animation,

• title,

• description,

• properties.

component view

Ключевое слово для определения представления компонентов для указанного контейнера.

component  [key] [description] {
    ...
}

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

Допустимые дочерние элементы:

• include,

• exclude,

• autoLayout,

• default,

• animation,

• title,

• description,

• properties.

filtered view

Ключевое слово для определения отфильтрованного представления поверх указанного представления.

filtered    [key] [description] {
    ...
}

Параметр baseKey определяет ключ системного ландшафта, системного контекста, контейнера или представления компонента, на котором должно основываться это отфильтрованное представление. Режим (include или exclude) определяет, должно ли представление включать или исключать элементы/взаимосвязи на основе предоставленных tags.

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

filtered  include "Element,Relationship" [key] [description]

Допустимые дочерние элементы:

• default,

• title,

• description,

• properties.

dynamic view

Ключевое слово определяет динамическое представление для указанной области.

dynamic <*|software system identifier|container identifier> [key] [description] {
    ...
}

Первое свойство определяет область видимости и то, что может быть добавлено к представлению:

• пользователи и программные системы;

• область внутри программной системы: пользователи, другие программные системы и контейнеры;

• область применения контейнера: пользователи, другие программные системы, другие контейнеры и компоненты.

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

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

 ->  [description] [technology]
 [description]

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

Допустимые дочерние элементы:

• autoLayout,

• default,

• title,

• description,

• properties.

deployment view

Ключевое слово определяет представление развертывания для указанной области и среды развертывания.

deployment <*|software system identifier>  [key] [description] {
    ...
}

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

• область применения: все узлы развертывания, узлы инфраструктуры и экземпляры контейнеров в среде развертывания;

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

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

Допустимые дочерние элементы:

• include,

• exclude,

• autoLayout,

• default,

• animation,

• title,

• description,

• properties.

custom view

Ключевое слово используется для определения пользовательского представления (доступно только в облачном сервисе Structurizr/локальной установке/Lite).

custom [key] [title] [description] {
    ...
}

Допустимые дочерние элементы:

• include,

• exclude,

• autoLayout,

• default,

• animation,

• title,

• description,

• properties.

image view

Ключевое слово используется для определения представления с изображениями (доступно только в облачном сервисе Structurizr/локальной установке/Lite).

image <*|element identifier> [key] {
    ...
}

Внутри блока можно указать источник изображения, используя один из вариантов:

• plantuml ,

• mermaid ,

• kroki  (где format — идентификатор формата, включенный в URL-путь; например http://url/{формат}/…),

• image .

При использовании этих сервисов нужно указать URL-адрес PlantUML/Mermaid/Kroki и формат: png или svg (необязательно). Эти данные могут быть указаны как свойства набора представлений:

views {
    properties {
        "plantuml.url" ""
        "plantuml.format" "svg"
        "mermaid.url" ""
        "mermaid.format" "svg"
        "kroki.url" ""
        "kroki.format" "svg"
    }
...

}

Ссылки PlantUML (https://plantuml.com/plantuml), Mermaid (https://mermaid.ink), и Kroki (https://kroki.io) могут работать, но при этом:

1. Информация отправляется стороннему сервису.

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

Допустимые дочерние элементы:

• default,

• title,

• description,

• properties.

include

Ключевое слово используется для включения элементов или связей.

Включение элементов

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

include <*|identifier|expression> [*|identifier|expression...]

Элементы могут быть указаны либо с помощью индивидуальных идентификаторов, подстановочного знака (*), либо выражения свойства. Включение элементов также будет включать в себя отношения между этими элементами.

Идентификатор подстановочного знака (*) работает по-разному в зависимости от типа диаграммы:

• представление системного ландшафта: включает всех пользователей и программные системы;

• представление системного контекста: программная система, плюс все пользователи и программные системы, которые непосредственно подключены к данной программной системе;

• представление контейнера: включает все контейнеры в рамках программной системы в области видимости; плюс пользователей и программные системы, которые непосредственно подключены к этим контейнерам;

• представление компонентов: включает все компоненты внутри контейнера в области видимости; плюс пользователей, программные системы и контейнеры (принадлежащие программной системе в области видимости), непосредственно подключенные к ним;

• Filtered view: неприменимо;

• Dynamic view: неприменимо;

• представление развертывания: включает в область действия все узлы развертывания, узлы инфраструктуры и экземпляры контейнеров, определенные в среде развертывания и (необязательно) программной системе.

Логика включения элементов по тегам:

• element.tag==,[tag]: включает элементы, имеющие все указанные теги;

• element.tag!=,[tag]: включает элементы, не имеющие все указанные теги.

Включение связей

Для включения связи в представление, нужно указать индивидуальный идентификатор связи или выражение:

include  [identifier|expression...]

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

exclude

Ключевое слово используется для исключения элементов или связей.

Исключение элементов

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

exclude  [identifier|expression...]

Исключение связей

Чтобы исключить связь в представлении, можно указать индивидуальный идентификатор связи или использовать выражение свойства:

exclude  [identifier|expression...]

Способы исключить отношения:

• relationship.tag==,[tag] — исключить отношения, имеющие все указанные теги;

• relationship.tag!=,[tag] — исключить отношения, не имеющие всех указанных тегов.

Как альтернативу можно использовать синтаксис выражения отношения следующим образом:

exclude "<*|identifier|expression> -> <*|identifier|expression>"

Комбинации параметров следующие:

• → * — все связи между всеми элементами;

• source → * — все связи от указанного элемента до любых элементов;

• → destination — все связи от любых элементов до указанного элемента;

• source → destination — все связи между указанными элементами.

Синтаксис выражения взаимосвязи работает только с элементами, существующими в представлении.

autoLayout

Включает режим автоматической компоновки диаграммы.

autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]

Первое свойство — направление ранжирования:

• tb — сверху вниз (по умолчанию),

• bt — снизу вверх,

• lr — слева направо,

• rl — справа налево.

Второе свойство — дистанция между рядами в пикселях (по умолчанию: 300); третье свойство — дистанция между узлами одного ряда в пикселях (по умолчанию: 300).

Если в рабочем пространстве DSL явно не определены представления, анализатор DSL автоматически создаст набор представлений по умолчанию с включенной автоматической компоновкой. Чтобы изменить такое поведение, можно (1) описать представления в явном виде, (2) использовать скрипт для отключения автоматической компоновки.

default

Устанавливает представление для отображения по умолчанию.

default

animation

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

animation {
     [identifier...]
     [identifier...]
}

title

Переопределяет заголовок представления.

title