Spring Modulith 运行时支持

前面章节中描述的功能，无论是用于验证和文档目的的测试场景，还是帮助松散耦合模块但没有直接使用应用程序模块结构的通用支持功能，都使用了应用程序模块的排列方式。在本节中，我们将描述 Spring Modulith 对应用程序运行时模块初始化的支持。

为应用程序模块设置运行时支持

要启用 Spring Modulith 的运行时支持，请确保在项目中包含 spring-modulith-runtime JAR。

  • Maven

  • Gradle

<dependency>
  <groupId>org.springframework.modulith</groupId>
  <artifactId>spring-modulith-runtime</artifactId>
  <scope>runtime</scope>
</dependency>
dependencies {
  runtimeOnly 'org.springframework.modulith:spring-modulith-runtime'
}
值得注意的是，使用 Spring Modulith 的运行时支持意味着您将在应用程序中包含 ArchUnit 和 JGraphT（用于对应用程序模块进行拓扑排序）库。

添加此 JAR 将导致 Spring Boot 自动配置运行，并在您的应用程序中注册以下组件

  • 一个 ApplicationModulesRuntime，允许访问 ApplicationModules。

  • 一个 SpringBootApplicationRuntime 来支持前一个 bean 以检测主应用程序类。

  • 一个针对 ApplicationStartedEvent 的事件监听器，它将调用在应用程序上下文中定义的 ApplicationModuleInitializer bean。

应用程序模块初始化器

在使用应用程序模块时，通常需要在应用程序启动时执行一些特定于单个模块的代码。这意味着该代码的执行顺序需要遵循应用程序模块的依赖关系结构。如果模块 B 依赖于模块 A，则 A 的初始化代码必须在 B 的初始化代码之前运行，即使初始化器本身并不直接依赖于另一个。

Diagram

虽然开发人员当然可以通过 Spring 的标准 @Order 注解或 Ordered 接口来定义执行顺序，但 Spring Modulith 提供了一个 ApplicationModuleInitializer 接口，用于在应用程序启动时运行 bean。这些 bean 的执行顺序将自动遵循应用程序模块依赖关系结构。

  • Java

  • Kotlin

@Component
class MyInitializer implements ApplicationModuleInitializer {

  @Override
  public void initialize() {
    // Initialization code goes here
  }
}
@Component
class MyInitializer : ApplicationModuleInitializer {


  override fun initialize() {
    // Initialization code goes here
  }
}

请注意，只有当 spring-modulith-runtime JAR 位于类路径上时（请参阅 为应用程序模块设置运行时支持），ApplicationModuleInitializer bean 才会被调用，因为这会引入根据应用程序模块结构对初始化器进行拓扑排序所需的依赖项。