记录应用程序模块

通过 ApplicationModules 创建的应用程序模块模型可用于创建文档片段，以包含在 Asciidoc 编写的开发人员文档中。Spring Modulith 的 Documenter 抽象可以生成两种不同类型的片段

C4 和 UML 组件图，描述各个应用程序模块之间的关系
所谓的“应用程序模块画布”，一个关于模块和其中最相关元素的表格概述（Spring bean、聚合根、发布和监听的事件以及配置属性）。

生成应用程序模块组件图

通过将 ApplicationModules 实例传递给 Documenter，可以生成文档片段。

使用 Documenter 生成应用程序模块组件图

Java
Kotlin

class DocumentationTests {

  ApplicationModules modules = ApplicationModules.of(Application.class);

  @Test
  void writeDocumentationSnippets() {

    new Documenter(modules)
      .writeModulesAsPlantUml()
      .writeIndividualModulesAsPlantUml();
  }
}

class DocumentationTests {
    private val modules = ApplicationModules.of(Application::class)

    @Test
    fun writeDocumentationSnippets() {
        Documenter(modules)
            .writeModulesAsPlantUml()
            .writeIndividualModulesAsPlantUml()
    }
}

对 Documenter 的第一次调用将生成一个 C4 组件图，其中包含系统中的所有模块。

All modules and their relationships rendered as C4 component diagram

图 1. 所有模块及其关系，以 C4 组件图形式呈现

第二次调用将创建额外的图表，这些图表仅包含单个模块及其在画布上直接依赖的模块。

A subset of application modules and their relationships starting from the order module rendered as C4 component diagram

图 2. 从订单模块开始的应用程序模块子集及其关系，以 C4 组件图形式呈现

使用传统的 UML 组件图

如果您更喜欢传统的 UML 风格组件图，请调整 DiagramOptions 以使用以下样式

Java
Kotlin

DiagramOptions.defaults()
  .withStyle(DiagramStyle.UML);

DiagramOptions.defaults()
  .withStyle(DiagramStyle.UML)

这将导致图表看起来像这样

All modules and their relationships rendered as UML component diagram

图 3. 所有模块及其关系，以 UML 组件图形式呈现

A subset of application modules and their relationships starting from the order module rendered as UML component diagram

图 4. 从订单模块开始的应用程序模块子集及其关系，以 UML 组件图形式呈现

生成应用程序模块画布

可以通过调用 Documenter.writeModuleCanvases() 来生成应用程序模块画布

使用 Documenter 生成应用程序模块画布

Java
Kotlin

class DocumentationTests {

  ApplicationModules modules = ApplicationModules.of(Application.class);

  @Test
  void writeDocumentationSnippets() {

    new Documenter(modules)
      .writeModuleCanvases();
  }
}

class DocumentationTests {

  private val modules = ApplicationModules.of(Application::class)

  @Test
  fun writeDocumentationSnippets() {
    Documenter(modules)
        .writeModuleCanvases()
  }
}

默认情况下，文档将生成到构建系统构建文件夹中的 spring-modulith-docs 文件夹中。生成的画布如下所示

表 1. 应用程序模块画布示例
基本包	`com.acme.commerce.inventory`
Spring 组件	服务 `c.a.c.i.InventoryManagement` 存储库 `c.a.c.i.Inventory` 事件监听器 `c.a.c.i.InternalInventoryListeners` 监听 `o.s.m.m.DayHasPassed`、`c.a.c.i.QuantityReduced` `c.a.c.i.InventoryOrderEventListener` 监听 `c.a.c.o.OrderCanceled`、`c.a.c.o.OrderCompleted` 配置属性 `c.a.c.i.InventoryProperties` 其他 `c.a.c.i.InventoryItemCreationListener`
聚合根	`c.a.c.i.InventoryItem`
发布的事件	`c.a.c.i.QuantityReduced` 由 `c.a.c.i.InventoryItem.decreaseQuantity(…)` `c.a.c.i.StockShort` 由 `c.a.c.i.InternalInventoryListeners.on(…)`
监听的事件	`c.a.c.o.OrderCompleted` `c.a.c.o.OrderCanceled`
属性	`acme.commerce.inventory.restock-threshold` — `c.a.c.c.Quantity`。在库存更新期间应触发 `InventoryEvents.StockShort` 的阈值。

它包含以下部分

应用程序模块的基本包。
应用程序模块公开的 Spring Bean，按原型分组。 — 换句话说，位于 API 包或任何命名接口包中的 Bean。这将检测由 jMolecules 架构抽象定义的组件原型，但也包括标准的 Spring 原型注解。
公开的聚合根 — 我们为其找到存储库或通过 jMolecules 显式声明为聚合的任何实体。
模块发布的应用程序事件 — 这些事件类型需要使用 jMolecules 的 @DomainEvent 进行标记，或实现其 DomainEvent 接口。
模块监听的应用程序事件 — 从使用 Spring 的 @EventListener、@TransactionalEventListener、jMolecules 的 @DomainEventHandler 注解的方法或实现 ApplicationListener 的 Bean 中派生。
配置属性 — 应用程序模块公开的 Spring Boot 配置属性。需要使用 spring-boot-configuration-processor 工件来提取附加到属性的元数据。