Spring Boot 3配置嵌入式MongoDB测试方法

本教程详细介绍了如何在Spring Boot 3.0.0及更高版本中正确配置和使用嵌入式MongoDB进行集成测试。针对从Spring Boot 2.x迁移时遇到的兼容性问题，文章指出核心在于更新Flapdoodle嵌入式MongoDB的Maven依赖以及调整application.properties中的MongoDB版本配置属性的命名空间，确保测试环境能够顺利启动并连接到嵌入式数据库。

引言

随着Spring Boot 3.x版本的发布，项目在底层架构上进行了重大升级，包括从Java EE迁移到Jakarta EE。这一变化不仅影响了Web和数据访问相关的API，也对一些常用的第三方库的集成方式产生了影响。在进行Spring Boot应用程序的集成测试时，嵌入式数据库（如嵌入式MongoDB）是常见的选择，它提供了一个轻量级、独立的测试环境。然而，从Spring Boot 2.x升级到3.x时，开发者可能会发现原有的嵌入式MongoDB配置不再工作，并遇到连接超时或拒绝连接的错误。本文将详细阐述如何在Spring Boot 3.x项目中正确配置Flapdoodle嵌入式MongoDB。

核心兼容性调整

在Spring Boot 3.x中使用嵌入式MongoDB进行测试，主要需要进行两项关键的兼容性调整：更新Flapdoodle嵌入式MongoDB的Maven依赖和修改application.properties中的MongoDB版本配置。

1. 更新Flapdoodle嵌入式MongoDB依赖

Flapdoodle de.flapdoodle.embed 系列库为Spring Boot 3.x提供了专门的集成模块。这意味着，原先用于Spring Boot 2.x的依赖需要更新其artifactId以适应新的Spring Boot版本。

原有（Spring Boot 2.x 兼容）依赖：

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

更新后（Spring Boot 3.x 兼容）依赖：

请注意，artifactId已从de.flapdoodle.embed.mongo更改为de.flapdoodle.embed.mongo.spring30x，并且通常也需要更新版本号以获取最新的兼容性和功能。

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

在选择version时，建议访问Maven Central（如mvnrepository.com）搜索de.flapdoodle.embed.mongo.spring30x以获取最新的稳定版本。

2. 调整MongoDB版本配置属性

在Spring Boot 3.x中，用于配置嵌入式MongoDB版本的属性命名空间也发生了变化。原先由Spring Boot自身提供的配置属性已迁移到Flapdoodle自己的命名空间下。

原有（Spring Boot 2.x 兼容）配置：

在application.properties或application.yml中：

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相关的配置（如数据库名称和端口）通常保持不变。

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

集成测试示例

完成上述依赖和配置的更新后，您的MongoDB集成测试代码通常无需修改。以下是一个典型的使用@DataMongoTest进行嵌入式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("给定一个要保存的对象，当使用MongoDB模板保存时，对象应被保存")
  @Test
  public void testSaveObject(@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 Data MongoDB的测试切片，并注入MongoTemplate以进行数据操作。在正确配置了Flapdoodle嵌入式MongoDB依赖和属性后，该测试将能够成功启动一个嵌入式MongoDB实例并执行测试逻辑。

常见问题与故障排除

如果在进行上述更改后，仍然遇到类似org.springframework.dao.DataAccessResourceFailureException: Timed out after 30000 ms while waiting to connect. Client view of cluster state is {type=UNKNOWN, servers=[{address=localhost:27017, type=UNKNOWN, state=CONNECTING, exception={com.mongodb.MongoSocketOpenException: Exception opening socket}, caused by {java.net.ConnectException: Connection refused: no further information}}]}的错误，这通常表明：

1. 依赖版本不匹配： 确保de.flapdoodle.embed.mongo.spring30x的版本与您的Spring Boot 3.x版本兼容，并且是最新稳定版。
2. 配置属性拼写错误： 仔细检查de.flapdoodle.mongodb.embedded.version属性是否拼写正确，没有多余的空格或错误的字符。
3. 其他MongoDB配置冲突： 检查项目中是否有其他MongoDB相关的配置（如spring.data.mongodb.uri），它们可能会覆盖或干扰嵌入式MongoDB的自动配置。
4. 网络或端口冲突： 确保27017端口（或您配置的其他端口）没有被其他MongoDB实例或进程占用。

总结

在Spring Boot 3.x项目中集成和测试嵌入式MongoDB，需要对Flapdoodle的依赖和配置属性进行特定调整。通过将de.flapdoodle.embed.mongo依赖更新为de.flapdoodle.embed.mongo.spring30x，并调整application.properties中的MongoDB版本配置属性为de.flapdoodle.mongodb.embedded.version，开发者可以顺利地在新的Spring Boot生态系统中利用嵌入式MongoDB进行高效、可靠的集成测试。理解这些兼容性变化对于平稳地从Spring Boot 2.x迁移至3.x至关重要。