如何有意义地记录演员设计

Han*_*ier 5 java actor akka akka-actor

我对akka/actor系统很陌生,并尝试理解同事编写的代码.
这样做,我问自己哪种文档有助于更快地理解已实现的"actor系统".
据我所知,到目前为止,您需要了解系统的至少两个不同视角才能理解它.

  • 第一个是静态"创建层次结构",它主要定义了actor之间的子父关系.
  • 第二个是动态"消息/事件流",它主要定义了参与者之间交换的消息.作为特殊情况,这个还包括已实现的有限状态机.

所以,我想知道如何记录演员系统的常见最佳实践:

  • 应该记录什么样的观点?
  • 是否有关于如何构造代码的推荐方法(例如将父子关系反映为包结构)?
  • 命名约定?
  • 能够解析代码并提供一些文档的工具?
  • ...

Rea*_*and 1

由于我还无法发表评论,我至少想向您指出akka-viz以便进行可视化。

我最近还想知道包结构......以及是否应该以这种方式描述参与者层次结构。然后我继续应用 DDD 视图,其中参与者只不过是作用于实体的服务。当试图理解应用程序的功能时,这并没有强调实现细节 akka 。后者是包结构应该使人们能够做的事情。

如果有的话,也会对最佳实践感兴趣:)