Как правильно оформить актерский дизайн - PullRequest
0 голосов
/ 30 мая 2018

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

  • Первое - это статика"«иерархия создания», которая в основном определяет дочерние и родительские отношения между субъектами.
  • Вторым является динамический «поток сообщений / событий», который в основном определяет обмен сообщениями между субъектами.В качестве особого случая этот также включает в себя реализованные конечные автоматы.

Итак, мне интересно, есть ли распространенные передовые практики по документированию актерской системы:

  • Какие виды должны быть документированы?
  • Существуют ли рекомендуемые способы структурирования кода (например, отражение отношения родитель-потомок в качестве структуры пакета)?
  • Соглашения об именах?
  • Инструменты, которые могут проанализировать код и предоставить некоторую документацию?
  • ...

1 Ответ

0 голосов
/ 17 июня 2018

Поскольку я пока не могу комментировать, я хотел бы, по крайней мере, указать вам akka-viz с целью визуализации.

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

Также было бы интересно узнать о наилучшей практике, хотя, если она есть:)

...