对于最新的稳定版本，请使用 Spring Modulith 1.3.0！spring-doc.cn

记录应用程序模块

通过创建的应用程序模块模型可用于创建文档片段，以包含在用 Asciidoc 编写的开发人员文档中。 Spring Modulith 的抽象可以产生两种不同类型的 snippets：ApplicationModulesDocumenterspring-doc.cn

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

生成应用程序模块 Component 图

可以通过将实例交给 .ApplicationModulesDocumenterspring-doc.cn

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

Javaspring-doc.cn
Kotlinspring-doc.cn

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.java)

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

第一次调用将生成一个包含系统内所有模块的 C4 组件图。Documenterspring-doc.cn

图 1.所有模块及其关系都呈现为 C4 组件图

第二次调用将创建其他图表，这些图表仅包含单个模块以及它们在画布上直接依赖的模块。spring-doc.cn

图 2.应用程序模块的子集及其关系，从呈现为 C4 组件图的 order 模块开始

使用传统的 UML 组件图

如果您更喜欢传统的 UML 样式组件图，请调整以改用该样式，如下所示：DiagramOptionsspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

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

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

这将使图表如下所示：spring-doc.cn

图 3.所有模块及其关系都呈现为 UML 组件图

图 4.应用程序模块的子集及其关系，从呈现为 UML 组件图的顺序模块开始

生成应用程序模块画布

可以通过调用来生成应用程序模块 Canvases：Documenter.writeModuleCanvases()spring-doc.cn

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

Javaspring-doc.cn
Kotlinspring-doc.cn

class DocumentationTests {

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

  @Test
  void writeDocumentationSnippets() {

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

class DocumentationTests {

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

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

默认情况下，文档将生成到构建系统的 build 文件夹中的文件夹中。生成的 canvas 如下所示：spring-modulith-docsspring-doc.cn

表 1.示例 Application Module Canvas
基础包spring-doc.cn	`com.acme.commerce.inventory`spring-doc.cn
弹簧组件spring-doc.cn	服务业spring-doc.cn `c.a.c.i.InventoryManagement`spring-doc.cn 存储库spring-doc.cn `c.a.c.i.Inventory`spring-doc.cn 事件侦听器spring-doc.cn `c.a.c.i.InternalInventoryListeners`听，`o.s.m.m.DayHasPassedc.a.c.i.QuantityReduced`spring-doc.cn `c.a.c.i.InventoryOrderEventListener`听，`c.a.c.o.OrderCanceledc.a.c.o.OrderCompleted`spring-doc.cn 配置属性spring-doc.cn `c.a.c.i.InventoryProperties`spring-doc.cn 别人spring-doc.cn `c.a.c.i.InventoryItemCreationListener`spring-doc.cn
聚集根spring-doc.cn	`c.a.c.i.InventoryItem`spring-doc.cn
已发布的事件spring-doc.cn	`c.a.c.i.QuantityReduced`创建者：spring-doc.cn `c.a.c.i.InventoryItem.decreaseQuantity(…)`spring-doc.cn `c.a.c.i.StockShort`创建者：spring-doc.cn `c.a.c.i.InternalInventoryListeners.on(…)`spring-doc.cn
侦听的事件spring-doc.cn	`c.a.c.o.OrderCompleted`spring-doc.cn `c.a.c.o.OrderCanceled`spring-doc.cn
性能spring-doc.cn	`acme.commerce.inventory.restock-threshold`— .在清单更新期间应触发 a 的阈值。`c.a.c.c.QuantityInventoryEvents.StockShort`spring-doc.cn

它由以下部分组成：spring-doc.cn

应用程序模块的基础包。spring-doc.cn
应用程序模块公开的 Spring bean，按构造型分组。— 换句话说，位于 API 包或任何命名接口包中的 bean。这将检测由 jMolecules 架构抽象定义的组件构造型，以及标准的 Spring 构造型 Comments。spring-doc.cn
公开的聚合根 — 我们为其找到存储库或通过 jMolecules 显式声明为聚合的任何实体。spring-doc.cn
模块发布的应用程序事件 — 这些事件类型需要使用 jMolecules 进行划分或实现其接口。@DomainEventDomainEventspring-doc.cn
模块侦听的应用程序事件 — 派生自使用 Spring 的、、 jMolecules 或 bean 实现的方法。@EventListener@TransactionalEventListener@DomainEventHandlerApplicationListenerspring-doc.cn
Configuration properties — 应用程序模块公开的 Spring Boot Configuration 属性。需要使用构件来提取附加到属性的元数据。spring-boot-configuration-processorspring-doc.cn