|
此版本仍在开发中,尚未被视为稳定版。如需最新稳定版本,请使用 Spring Modulith 2.0.4! |
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'
}
添加此 JAR 将导致 Spring Boot 自动配置运行,从而在您的应用程序中注册以下组件:
-
一个允许访问
ApplicationModules的ApplicationModulesRuntime。 -
一个
SpringBootApplicationRuntime用于回退到前一个 bean,以检测主应用程序类。 -
一个用于
ApplicationStartedEvent的事件监听器,它将调用在应用上下文中定义的ApplicationModuleInitializerBean。
应用程序模块初始化器
在使用应用模块时,很常见的需求是在应用启动时执行特定于某个模块的代码。 这意味着该代码的执行顺序需要遵循应用模块的依赖结构。 如果模块 B 依赖于模块 A,那么 A 的初始化代码必须在 B 之前运行,即使这些初始化器之间没有直接的依赖关系。
虽然开发人员当然可以通过 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,因为它会引入所需的依赖项,以便根据应用程序模块结构对初始化器进行拓扑排序。