Spring Boot中如何测试使用ElasticsearchRepository的服务

你可以根据实际环境选以下任意一种方案，所有方案都不会触达远程生产ES实例：

方案一：基于Testcontainers启动临时ES容器（优先推荐） #

这个方案会在测试运行时自动启动一个和生产版本完全一致的单节点ES容器，测试结束后自动销毁，环境完全隔离，没有脏数据残留，兼容性最好。

• 先在测试依赖中引入Testcontainers ES组件，以Maven为例：

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>elasticsearch</artifactId>
    <version>1.18.3</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>1.18.3</version>
    <scope>test</scope>
</dependency>

• 编写ES测试基类，统一配置容器连接、测试数据清理逻辑：

@Testcontainers
@SpringBootTest
@ActiveProfiles("test")
public abstract class EsServiceTestBase {
    // 镜像版本必须和远程生产ES版本完全一致，避免行为差异
    @Container
    private static final ElasticsearchContainer esContainer = new ElasticsearchContainer(
            "docker.elastic.co/elasticsearch/elasticsearch:7.17.10"
    ).withEnv("discovery.type", "single-node");

    // 动态覆盖ES连接配置，指向临时容器
    @DynamicPropertySource
    static void overrideEsConfig(DynamicPropertyRegistry registry) {
        registry.add("spring.elasticsearch.uris", esContainer::getHttpHostAddress);
    }

    // 每个测试用例执行完清空索引，避免用例间数据干扰
    @AfterEach
    void resetIndex(ElasticsearchOperations esOperations) {
        IndexCoordinates targetIndex = IndexCoordinates.of("你的业务索引名称");
        esOperations.indexOps(targetIndex).delete();
        esOperations.indexOps(targetIndex).create();
        // 如果你开了自动创建索引，也可以直接调用repository.deleteAll()
    }
}

• 编写服务测试类时直接继承上述基类，正常注入你的Service、Repository即可，所有保存、删除、搜索操作都会在临时容器中执行，和生产行为完全一致。

方案二：连接独立部署的固定测试ES实例 #

如果你的测试环境无法运行Docker，可以单独部署一个仅用于测试的ES实例，和生产实例网络、数据完全隔离：

• 在项目test资源目录下创建application-test.yml，配置测试实例的连接信息：

spring:
  elasticsearch:
    uris: http://独立测试ES的IP:9200
    # 如果测试ES开了认证就补充用户名密码配置
    username: test
    password: test123

• 测试类上添加@ActiveProfiles("test")激活测试配置，同时记得每个测试用例执行完清空测试索引数据，避免不同测试任务的数据互相影响。

注意事项 #

• 不要使用Mock框架模拟ElasticsearchRepository的行为：ES的分词、查询、聚合、相关性算分逻辑有大量专属行为，Mock出来的结果和真实ES运行结果差异极大，测试没有实际验证意义。
• 如果你用的是7.10以下版本的ES，也可以使用内嵌ES测试组件，但高版本ES已经移除了内嵌支持，且内嵌实例容易出现本地环境和服务器环境的兼容问题，不优先推荐。
• 所有测试配置必须放在test目录下，通过profile隔离，绝对不要修改主配置文件中的生产ES连接信息，避免误操作生产数据。

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