Quarkus扩展：从BuildStep返回多DevServices并确保Mongo优先启动

核心思路是利用DevService的服务依赖声明和条件配置，通过显式依赖关系保证MongoDB先启动，同时支持按需在测试环境引入。

代码示例（Spring Boot环境） #

@Configuration
@Profile({"dev", "test"}) // 仅在开发/测试环境生效
public class DevServiceConfig {

    // 定义MongoDB DevService，作为前置依赖服务
    @Bean
    public DevService mongodbDevService() {
        return DevService.builder()
                .name("mongodb")
                .image("mongo:6.0")
                .ports(27017)
                // 等待MongoDB启动完成的标志日志
                .waitStrategy(Wait.forLogMessage("waiting for connections on port 27017", 1))
                .build();
    }

    // 定义自研应用DevService，通过@DependsOn强制依赖MongoDB服务
    @Bean
    @DependsOn("mongodbDevService")
    public DevService myAppDevService() {
        return DevService.builder()
                .name("my-app")
                .mainClass("com.myapp.MyApplication")
                .environment(Map.of("SPRING_DATA_MONGODB_URI", "mongodb://localhost:27017/mydb"))
                .build();
    }
}

针对疑问的解答 #

1. 能否让方法返回List，第一个元素对应MongoDB、第二个对应自身应用？ #

可以，但显式依赖比列表顺序更可靠（部分框架的DevService容器可能忽略列表顺序）。如果用列表返回，建议在应用服务中显式关联MongoDB实例：

@Bean
public List<DevService> devServices() {
    DevService mongodb = DevService.builder()
            .name("mongodb")
            // 同上述MongoDB配置
            .build();

    DevService app = DevService.builder()
            .name("my-app")
            .dependsOn(mongodb) // 显式绑定依赖
            // 同上述应用配置
            .build();

    return List.of(mongodb, app);
}

2. 是否需单独方法提供另一服务，若需如何确保MongoDB先启动？ #

推荐用单独@Bean方法分别定义两个服务，更清晰易维护。确保MongoDB先启动的两种可靠方式：

• 使用@DependsOn注解：在应用服务的Bean上标注@DependsOn("mongodbDevService")，强制容器先初始化MongoDB服务。
• 服务内部显式依赖：在应用DevService的配置中通过dependsOn()方法关联MongoDB服务实例。

3. 能否仅在测试时引入Mongo扩展并依赖它，同时保证MongoDB优先启动？ #

完全可以，通过Profile条件配置+测试范围依赖实现：

1. 把Mongo DevService依赖设为测试范围（以Maven为例）：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>mongodb-dev-service-extension</artifactId>
    <scope>test</scope>
</dependency>

2. 配置仅测试环境生效的DevService：

@Configuration
@Profile("test")
public class TestDevServiceConfig {

    @Bean
    public DevService mongodbTestDevService() {
        return DevService.builder()
                .name("mongodb-test")
                .image("mongo:6.0")
                .ports(27017)
                .waitStrategy(Wait.forLogMessage("waiting for connections on port 27017", 1))
                .build();
    }

    @Bean
    @DependsOn("mongodbTestDevService")
    public DevService myAppTestDevService() {
        return DevService.builder()
                .name("my-app-test")
                .mainClass("com.myapp.MyApplication")
                .environment(Map.of("SPRING_DATA_MONGODB_URI", "mongodb://localhost:27017/testdb"))
                .build();
    }
}

这样测试环境启动时会自动加载并优先启动MongoDB，非测试环境则不会加载该扩展。

内容的提问来源于stack exchange，提问作者Snappawapa