如何在Spring Boot 3.0.0中集成和测试嵌入式MongoDB_技术教程

本文详细介绍了在spring boot 3.0.0项目中集成和测试嵌入式mongodb的必要步骤。针对spring boot 2.x到3.x版本升级中遇到的兼容性问题，文章指出需要更新flapdoodle embedded mongodb的依赖artifactid，并调整其配置属性的命名空间，以解决连接超时错误，确保测试环境的顺利运行。

Spring Boot 3.0.0中嵌入式MongoDB的集成与测试

在Spring Boot 3.0.0及更高版本中，集成和测试嵌入式MongoDB时，开发者可能会遇到与Spring Boot 2.x版本不兼容的问题，导致测试环境无法正确启动MongoDB实例，并抛出org.springframework.dao.DataAccessResourceFailureException: Timed out after ... while waiting to connect等连接错误。这主要是因为Flapdoodle Embedded MongoDB库针对Spring Boot 3.x进行了API和配置的适配。本文将详细阐述如何在Spring Boot 3.0.0项目中正确配置和使用嵌入式MongoDB进行测试。

问题根源分析

在Spring Boot 2.7.x版本中，通常使用de.flapdoodle.embed:de.flapdoodle.embed.mongo作为嵌入式MongoDB的依赖，并通过spring.mongodb.embedded.version属性配置MongoDB版本。然而，随着Spring Boot 3.0.0迁移到Jakarta EE命名空间以及内部架构的调整，旧版的Flapdoodle Embedded MongoDB集成模块不再直接兼容。Flapdoodle项目为此推出了专门适配Spring Boot 3.x的新模块，并调整了配置属性的命名空间。

解决方案

解决此问题的核心在于更新Flapdoodle Embedded MongoDB的Maven依赖以及相应的配置属性。

1. 更新Embedded Mongo依赖

首先，需要将pom.xml文件中原有的Flapdoodle Embedded Mongo依赖更新为适配Spring Boot 3.x的版本。

原有依赖 (适用于Spring Boot 2.x):


    de.flapdoodle.embed
    de.flapdoodle.embed.mongo
    3.5.3
    test

更新为 (适用于Spring Boot 3.x):


    de.flapdoodle.embed
    de.flapdoodle.embed.mongo.spring30x
    4.5.2 
    test

注意事项：

artifactId 变更： 注意artifactId已从de.flapdoodle.embed.mongo变为de.flapdoodle.embed.mongo.spring30x，明确表示其对Spring Boot 3.x的适配。
版本号： 示例中的4.5.2是撰写本文时的最新版本，建议访问 Maven Central 查询并使用最新的稳定版本。

2. 调整MongoDB版本配置属性

其次，application.properties或application.yml中用于指定嵌入式MongoDB版本的配置属性也需要进行调整。

原有配置 (适用于Spring Boot 2.x):

spring.mongodb.embedded.version=4.0.2

更新为 (适用于Spring Boot 3.x):

de.flapdoodle.mongodb.embedded.version=4.0.2

注意事项：

命名空间变更： 配置属性的命名空间已从Spring的spring.mongodb.embedded前缀切换到Flapdoodle自己的de.flapdoodle.mongodb.embedded前缀。

3. 完整的pom.xml示例（相关部分）


    
    
        org.springframework.boot
        spring-boot-starter-data-jpa
    
    
        org.springframework.boot
        spring-boot-starter-web
    
    
        org.springframework.boot
        spring-boot-starter-data-mongodb
    

    
    
        org.springframework.boot
        spring-boot-devtools
        runtime
        true
    
    
        org.projectlombok
        lombok
        true
    

    
    
        org.springframework.boot
        spring-boot-starter-test
        test
    
    
    
        de.flapdoodle.embed
        de.flapdoodle.embed.mongo.spring30x
        4.5.2 
        test

4. 完整的application.properties示例（相关部分）

spring.data.mongodb.database=test
spring.data.mongodb.port=27017
# 适配Spring Boot 3.x的嵌入式MongoDB版本配置
de.flapdoodle.mongodb.embedded.version=4.0.2

5. 测试代码示例

完成上述依赖和配置的更新后，原有的MongoDB集成测试代码通常无需修改，因为它使用的是Spring Data MongoDB提供的抽象。

import com.mongodb.BasicDBObjectBuilder;
import com.mongodb.DBObject;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import static org.assertj.core.api.Assertions.assertThat;

@DataMongoTest
@ExtendWith(SpringExtension.class)
public class MongoDbSpringIntegrationTest {

  @DisplayName("given object to save"
      + " when save object using MongoDB template"
      + " then object is saved")
  @Test
  public void test(@Autowired MongoTemplate mongoTemplate) {
    // given
    DBObject objectToSave = BasicDBObjectBuilder.start()
        .add("key", "value")
        .get();

    // when
    mongoTemplate.save(objectToSave, "collection");

    // then
    assertThat(mongoTemplate.findAll(DBObject.class, "collection")).extracting("key")
        .containsOnly("value");
  }
}

通过@DataMongoTest注解，Spring Boot会自动配置嵌入式MongoDB，并提供MongoTemplate实例供测试使用。在正确的依赖和配置下，上述测试将能够成功启动嵌入式MongoDB并执行数据操作。

总结

在Spring Boot 3.0.0项目中集成和测试嵌入式MongoDB，关键在于适配Flapdoodle Embedded MongoDB库针对新版本的变更。这主要涉及两个方面：一是将de.flapdoodle.embed.mongo依赖更新为de.flapdoodle.embed.mongo.spring30x，并确保使用兼容的最新版本；二是将application.properties中的spring.mongodb.embedded.version配置项改为de.flapdoodle.mongodb.embedded.version。完成这些调整后，即可在Spring Boot 3.x环境中顺利进行基于嵌入式MongoDB的集成测试。