记录应用程序模块
通过ApplicationModules可用于创建文档片段，以包含在用 Asciidoc 编写的开发人员文档中。
Spring Modulith 的Documenter抽象可以生成两种不同类型的代码片段：
-
描述各个应用程序模块之间关系的 C4 和 UML 组件图
-
所谓的应用程序模块画布，关于模块和其中最相关元素的表格概述（Spring Bean、聚合根、发布和监听的事件以及配置属性）。
此外Documenter可以生成一个聚合的 Asciidoc 文件，其中包含所有现有的组件图和画布。
生成应用程序模块组件图
文档片段可以通过将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.java)
@Test
fun writeDocumentationSnippets() {
Documenter(modules)
.writeModulesAsPlantUml()
.writeIndividualModulesAsPlantUml()
}
}第一次调用Documenter将生成包含系统内所有模块的 C4 组件图。
第二次调用将创建仅包含单个模块及其直接依赖于画布的模块的其他图表。
生成应用程序模块画布
应用程序模块画布可以通过调用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.java)
@Test
fun writeDocumentationSnippets() {
Documenter(modules)
.writeModuleCanvases()
}
}默认情况下，文档将生成为spring-modulith-docs文件夹。
生成的画布如下所示：
基本包 |
|
|---|---|
弹簧组件 |
服务业
存储 库
事件侦听器
配置属性
别人
|
聚合根 |
|
已发布的事件 |
|
已监听的事件 |
|
性能 |
|
它由以下部分组成：
-
应用程序模块的基本包。
-
应用程序模块公开的 Spring Bean，按构造型分组。— 换句话说，位于 API 包或任何命名接口包中的 bean。 这将检测由 jMolecules 架构抽象定义的组件构造型，以及标准的 Spring 构造型注释。
-
公开的聚合根 — 我们通过 jMolecules 找到存储库或显式声明为聚合的任何实体。
-
模块发布的应用程序事件 — 这些事件类型需要使用 jMolecules 进行划分
@DomainEvent或实现其DomainEvent接口。 -
模块监听的应用程序事件 — 派生自用 Spring 的
@EventListener,@TransactionalEventListener、jMolecules'@DomainEventHandler或实现的 beanApplicationListener. -
配置属性 — 应用程序模块公开的 Spring Boot 配置属性。 需要使用
spring-boot-configuration-processorartifact 以提取附加到属性的元数据。
生成聚合文档
使用时Documenter.writeDocumentation(…)一all-docs.adoc将生成文件，链接所有生成的图表和应用程序模块画布。
我们可以通过调用Documenter.writeAggregatingDocument():
Documenter-
Java
-
Kotlin
class DocumentationTests {
ApplicationModules modules = ApplicationModules.of(Application.class);
@Test
void writeDocumentationSnippets() {
new Documenter(modules)
.writeAggregatingDocument();
}
}class DocumentationTests {
private val modules = ApplicationModules.of(Application::class.java)
@Test
fun writeDocumentationSnippets() {
Documenter(modules)
.writeAggregatingDocument()
}
}聚合文档将包括任何现有的应用程序模块组件图和应用程序模块画布。 如果没有，则此方法将不会生成输出文件。