如何在Spring Boot 3.x中集成和使用嵌入式MongoDB进行测试

本文详细介绍了在spring boot 3.x项目中集成和使用嵌入式mongodb进行测试的关键步骤。主要聚焦于解决从spring boot 2.x升级时遇到的兼容性问题,通过更新flapdoodle嵌入式mongodb依赖的artifactid和调整application.properties中mongodb版本配置的命名空间,确保开发人员能够顺利地在spring boot 3.x环境中进行数据层测试。

在Spring Boot 3.x中配置嵌入式MongoDB进行测试

随着Spring Boot 3.x的发布,其底层依赖和架构进行了重大升级,这导致一些在Spring Boot 2.x中正常工作的配置可能不再兼容。对于使用Flapdoodle嵌入式MongoDB进行测试的开发者而言,从Spring Boot 2.x迁移到3.x时,会发现原有的配置可能导致连接失败,出现DataAccessResourceFailureException,提示“Connection refused”。这通常是因为嵌入式MongoDB的集成方式发生了变化。本教程将详细指导您如何适配这些变化,使嵌入式MongoDB在Spring Boot 3.x项目中正常工作。

1. 理解兼容性问题

Spring Boot 3.x与Flapdoodle嵌入式MongoDB的早期版本存在兼容性问题。Flapdoodle项目为了更好地支持Spring Boot 3.x,发布了专门的集成模块。这意味着您需要更新项目的Maven或Gradle依赖,以引入针对Spring Boot 3.x优化的新模块。此外,配置嵌入式MongoDB版本的方式也从Spring Boot的命名空间迁移到了Flapdoodle自身的命名空间。

2. 更新Maven依赖

首先,您需要修改项目的pom.xml文件,将原有的Flapdoodle嵌入式MongoDB依赖更新为针对Spring Boot 3.x的版本。

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


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

新依赖(适用于Spring Boot 3.x):

请注意,artifactId已更改为de.flapdoodle.embed.mongo.spring30x,并且版本号也应更新到最新。您可以在Maven中央仓库查找de.flapdoodle.embed.mongo.spring30x的最新版本。


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

完整pom.xml示例(仅展示相关部分):



    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        3.0.0 
         
    
    com.example
    your-project
    0.0.1-SNAPSHOT
    your-project
    Demo project for Spring Boot

    
        17
    

    
        
            org.springframework.boot
            spring-boot-starter-data-mongodb
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.projectlombok
            lombok
            true
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        

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

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
                
                    
                        
                            org.projectlombok
                            lombok
                        
                    
                
            
        
    

3. 调整MongoDB版本配置

除了依赖的更改,您还需要更新application.properties或application.yml文件中配置嵌入式MongoDB版本的方式。在Spring Boot 3.x中,此配置已从Spring的命名空间迁移到Flapdoodle自己的命名空间。

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

spring.data.mongodb.database=test
spring.data.mongodb.port=27017
spring.mongodb.embedded.version=4.0.2

新配置(适用于Spring Boot 3.x):

将spring.mongodb.embedded.version更改为de.flapdoodle.mongodb.embedded.version。

spring.data.mongodb.database=test
spring.data.mongodb.port=27017
de.flapdoodle.mongodb.embedded.version=4.0.2

注意事项:

  • spring.data.mongodb.database和spring.data.mongodb.port通常不需要更改,它们是Spring Data MongoDB的通用配置。
  • de.flapdoodle.mongodb.embedded.version指定了您希望嵌入式MongoDB使用的MongoDB服务器版本。请确保此版本是Flapdoodle支持的有效版本。

4. 编写或验证测试类

完成上述依赖和配置的更改后,您的Spring Boot 3.x项目应该能够成功启动并连接到嵌入式MongoDB实例。您可以使用@DataMongoTest注解来编写数据层测试。

示例测试类:

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注解,它会自动配置一个嵌入式MongoDB实例(如果存在兼容的依赖和配置),并提供一个MongoTemplate bean供测试使用。通过注入MongoTemplate,您可以像操作真实MongoDB一样进行数据操作和断言。

总结

在Spring Boot 3.x项目中集成嵌入式MongoDB进行测试,关键在于更新Flapdoodle的专用Spring Boot 3.x兼容依赖,并调整application.properties中嵌入式MongoDB版本配置的命名空间。通过遵循本教程的步骤,您可以顺利地从Spring Boot 2.x迁移,并在新的Spring Boot 3.x环境中继续享受嵌入式MongoDB带来的便利,从而提高数据层测试的效率和可靠性。务必定期检查Flapdoodle嵌入式MongoDB项目的官方文档或Maven中央仓库,以获取最新的依赖版本和最佳实践。