RabbitMQ Testcontainer连接问题解决方法

本文旨在解决使用Testcontainers集成RabbitMQ时常见的连接中断和认证失败问题。通过优化容器生命周期管理，移除冲突的`@Container`和`@Testcontainers`注解，并正确配置RabbitMQ的默认认证凭据（`guest`用户），确保Spring Boot测试环境中RabbitMQ容器的稳定运行和AMQP连接的成功建立，从而避免`Socket closed`和`ACCESS_REFUSED`等错误。

理解RabbitMQ Testcontainer连接问题

在使用Testcontainers进行集成测试时，开发者可能会遇到RabbitMQ容器在启动后立即断开连接的问题，表现为日志中出现Socket closed、java.io.IOException或com.rabbitmq.client.ShutdownSignalException: connection error等错误信息。这通常发生在Spring应用程序尝试连接RabbitMQ时，尤其是在SimpleMessageListenerContainer初始化或RabbitAdmin尝试声明队列时。

另一个常见问题是AuthenticationFailureException: ACCESS_REFUSED - Login was refused using authentication mechanism PLAIN。这表明应用程序尝试使用错误的用户名和密码连接到RabbitMQ容器。

根本原因分析与解决方案

这些问题的根源通常在于两个方面：容器生命周期的不当管理以及RabbitMQ容器的默认认证配置。

1. 容器生命周期管理冲突

当开发者手动通过Startables.deepStart(Stream.of(rabbitMQContainer, sqlContainer)).join();来管理多个Testcontainers的生命周期时，如果同时在容器字段上使用了@Container注解，并且类上还存在@Testcontainers注解，就会造成生命周期管理的冲突。

• @Testcontainers注解会触发Testcontainers JUnit扩展，该扩展会根据@Container注解自动管理容器的启动和停止。
• Startables.deepStart()则提供了手动、显式的容器启动机制。

当两者同时存在时，可能会导致容器被意外地启动多次或在不恰当的时机被关闭，从而引发连接中断。

解决方案： 如果选择使用Startables.deepStart()进行手动容器生命周期管理，应移除类上的@Testcontainers注解以及容器字段上的@Container注解。这样可以确保容器只通过Startables.deepStart()启动一次，避免冲突。

import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.containers.RabbitMQContainer;
import org.testcontainers.lifecycle.Startables;

import java.util.stream.Stream;

// 移除 @Testcontainers 注解
@SpringBootTest(classes = TestContainersDemoApplication.class)
@AutoConfigureMockMvc
@ExtendWith(SpringExtension.class)
public abstract class TestContainersConfig {

    @Autowired
    public MockMvc mockMvc;

    // 移除 @Container 注解
    public static final RabbitMQContainer rabbitMQContainer = new RabbitMQContainer("rabbitmq:3.8-management-alpine");

    // 移除 @Container 注解
    public static PostgreSQLContainer sqlContainer = new PostgreSQLContainer("postgres:latest")
            .withDatabaseName("demo")
            .withUsername("postgres")
            .withPassword("postgres");

    @DynamicPropertySource
    static void registerProperties(DynamicPropertyRegistry dynamicPropertyRegistry) {
        dynamicPropertyRegistry.add("spring.datasource.url", sqlContainer::getJdbcUrl);
        dynamicPropertyRegistry.add("spring.datasource.username", sqlContainer::getUsername);
        dynamicPropertyRegistry.add("spring.datasource.password", sqlContainer::getPassword);
        dynamicPropertyRegistry.add("spring.rabbitmq.host", rabbitMQContainer::getHost);
        dynamicPropertyRegistry.add("spring.rabbitmq.port", rabbitMQContainer::getAmqpPort);
        // ... RabbitMQ 认证信息将在这里添加
    }

    static {
        Startables.deepStart(Stream.of(rabbitMQContainer, sqlContainer)).join();
    }
}

2. RabbitMQ容器认证失败

RabbitMQContainer在默认情况下，其管理界面的默认用户名和密码是guest。如果Spring Boot应用程序尝试使用不同的凭据（例如，Spring Cloud Stream的默认凭据guest:guest，但如果未显式配置，可能会导致问题），就会导致ACCESS_REFUSED错误。

解决方案： 在Spring Boot的配置中，通过DynamicPropertySource或application.yml显式地为RabbitMQ连接配置正确的用户名和密码。

// 在 TestContainersConfig 类中
@DynamicPropertySource
static void registerProperties(DynamicPropertyRegistry dynamicPropertyRegistry) {
    dynamicPropertyRegistry.add("spring.datasource.url", sqlContainer::getJdbcUrl);
    dynamicPropertyRegistry.add("spring.datasource.username", sqlContainer::getUsername);
    dynamicPropertyRegistry.add("spring.datasource.password", sqlContainer::getPassword);
    dynamicPropertyRegistry.add("spring.rabbitmq.host", rabbitMQContainer::getHost);
    dynamicPropertyRegistry.add("spring.rabbitmq.port", rabbitMQContainer::getAmqpPort);
    // 添加 RabbitMQ 认证信息
    dynamicPropertyRegistry.add("spring.rabbitmq.username", () -> "guest");
    dynamicPropertyRegistry.add("spring.rabbitmq.password", () -> "guest");
}

或者，如果你的测试环境允许，在src/test/resources/application.yml中进行配置：

spring:
  rabbitmq:
    host: ${RABBITMQ_HOST:localhost} # 占位符或通过 DynamicPropertySource 覆盖
    port: ${RABBITMQ_PORT:5672}
    username: guest
    password: guest

完整的优化配置示例

结合上述两点，一个稳定且正确的TestContainersConfig配置应如下所示：

package com.example.testcontainersdemo; // 根据实际包名调整

import com.example.testcontainersdemo.TestContainersDemoApplication;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.containers.RabbitMQContainer;
import org.testcontainers.lifecycle.Startables;

import java.util.stream.Stream;

// 移除 @Testcontainers 注解，因为我们手动管理容器生命周期
@SpringBootTest(classes = TestContainersDemoApplication.class)
@AutoConfigureMockMvc
@ExtendWith(SpringExtension.class)
public abstract class TestContainersConfig {

    @Autowired
    public MockMvc mockMvc;

    // 移除 @Container 注解
    public static final RabbitMQContainer rabbitMQContainer = new RabbitMQContainer("rabbitmq:3.8-management-alpine");

    // 移除 @Container 注解
    public static PostgreSQLContainer sqlContainer = new PostgreSQLContainer("postgres:latest")
            .withDatabaseName("demo")
            .withUsername("postgres")
            .withPassword("postgres");

    @DynamicPropertySource
    static void registerProperties(DynamicPropertyRegistry dynamicPropertyRegistry) {
        // 配置 PostgreSQL 数据库连接
        dynamicPropertyRegistry.add("spring.datasource.url", sqlContainer::getJdbcUrl);
        dynamicPropertyRegistry.add("spring.datasource.username", sqlContainer::getUsername);
        dynamicPropertyRegistry.add("spring.datasource.password", sqlContainer::getPassword);

        // 配置 RabbitMQ 连接
        dynamicPropertyRegistry.add("spring.rabbitmq.host", rabbitMQContainer::getHost);
        dynamicPropertyRegistry.add("spring.rabbitmq.port", rabbitMQContainer::getAmqpPort);
        // 显式设置 RabbitMQ 默认的用户名和密码
        dynamicPropertyRegistry.add("spring.rabbitmq.username", () -> "guest");
        dynamicPropertyRegistry.add("spring.rabbitmq.password", () -> "guest");
    }

    static {
        // 使用 Startables.deepStart 确保所有容器在测试开始前启动并就绪
        Startables.deepStart(Stream.of(rabbitMQContainer, sqlContainer)).join();
    }
}

注意事项与总结

1. 手动生命周期管理优先： 当你需要精确控制多个Testcontainers的启动顺序或协同工作时，Startables.deepStart()是一个非常强大的工具。在这种情况下，请务必移除@Testcontainers和@Container注解，以避免不必要的冲突。
2. 默认凭据： 许多Testcontainers提供的服务（如RabbitMQ、PostgreSQL等）都有默认的用户名和密码。在集成测试中，务必根据容器的默认设置来配置应用程序的连接凭据。对于RabbitMQContainer，默认的用户名和密码通常是guest/guest。
3. 日志分析： 当遇到连接问题时，仔细检查应用程序和Testcontainers容器的日志至关重要。错误堆栈信息（如Socket closed、EOFException、ACCESS_REFUSED）能提供宝贵的线索，帮助定位问题所在。
4. 版本兼容性： 确保Testcontainers库、Spring Boot版本以及RabbitMQ容器镜像版本之间没有已知的兼容性问题。

通过遵循上述指导原则，开发者可以有效解决RabbitMQ Testcontainer在集成测试中遇到的连接中断和认证失败问题，确保测试环境的稳定性和可靠性。