测试支持

为异步应用程序编写集成必然比测试更简单的应用程序更复杂。当抽象（如@RabbitListener注释出现。问题是如何验证在发送消息后，侦听器是否按预期收到了消息。spring-doc.cadn.net.cn

框架本身有许多单元测试和集成测试。一些使用模拟，而另一些则使用实时 RabbitMQ 代理的集成测试。您可以查阅这些测试，了解测试方案的一些想法。spring-doc.cadn.net.cn

Spring AMQP 版本 1.6 引入了spring-rabbit-testjar 的 jar 中，它为测试其中一些更复杂的场景提供支持。预计该项目将随着时间的推移而扩展，但我们需要社区反馈，以便为帮助测试所需的功能提出建议。请使用 JIRA 或 GitHub Issues 提供此类反馈。spring-doc.cadn.net.cn

@SpringRabbitTest

使用此注释将基础结构 bean 添加到 Spring 测试ApplicationContext. 例如，在使用时，这不是必需的@SpringBootTest因为 Spring Boot 的自动配置将添加 bean。spring-doc.cadn.net.cn

已注册的 Bean 包括：spring-doc.cadn.net.cn

CachingConnectionFactory (autoConnectionFactory).如果@RabbitEnabled存在，则使用其 Connection Factory。spring-doc.cadn.net.cn
RabbitTemplate (autoRabbitTemplate)spring-doc.cadn.net.cn
RabbitAdmin (autoRabbitAdmin)spring-doc.cadn.net.cn
RabbitListenerContainerFactory (autoContainerFactory)spring-doc.cadn.net.cn

此外，与@EnableRabbit（支持@RabbitListener）添加。spring-doc.cadn.net.cn

Junit5 示例

@SpringJUnitConfig
@SpringRabbitTest
public class MyRabbitTests {

	@Autowired
	private RabbitTemplate template;

	@Autowired
	private RabbitAdmin admin;

	@Autowired
	private RabbitListenerEndpointRegistry registry;

	@Test
	void test() {
        ...
	}

	@Configuration
	public static class Config {

        ...

	}

}

使用 JUnit4，将@SpringJUnitConfig跟@RunWith(SpringRunnner.class).spring-doc.cadn.net.cn

莫基托`Answer<?>`实现

目前有两个Answer<?>implementations 来帮助进行测试。spring-doc.cadn.net.cn

第一个LatchCountDownAndCallRealMethodAnswer提供Answer<Void>返回null并倒计时一个闩锁。以下示例演示如何使用LatchCountDownAndCallRealMethodAnswer:spring-doc.cadn.net.cn

LatchCountDownAndCallRealMethodAnswer answer = this.harness.getLatchAnswerFor("myListener", 2);
doAnswer(answer)
    .when(listener).foo(anyString(), anyString());

...

assertThat(answer.await(10)).isTrue();

第二个LambdaAnswer<T>提供一种机制来选择性地调用 Real 方法，并提供一个机会返回自定义结果，请根据InvocationOnMock和结果（如果有）。spring-doc.cadn.net.cn

考虑以下 POJO：spring-doc.cadn.net.cn

public class Thing {

    public String thing(String thing) {
        return thing.toUpperCase();
    }

}

以下类测试ThingPOJO：spring-doc.cadn.net.cn

Thing thing = spy(new Thing());

doAnswer(new LambdaAnswer<String>(true, (i, r) -> r + r))
    .when(thing).thing(anyString());
assertEquals("THINGTHING", thing.thing("thing"));

doAnswer(new LambdaAnswer<String>(true, (i, r) -> r + i.getArguments()[0]))
    .when(thing).thing(anyString());
assertEquals("THINGthing", thing.thing("thing"));

doAnswer(new LambdaAnswer<String>(false, (i, r) ->
    "" + i.getArguments()[0] + i.getArguments()[0])).when(thing).thing(anyString());
assertEquals("thingthing", thing.thing("thing"));

从版本 2.2.3 开始，答案捕获被测方法引发的任何异常。用answer.getExceptions()以获取对它们的引用。spring-doc.cadn.net.cn

当与@RabbitListenerTest和RabbitListenerTestHarness用harness.getLambdaAnswerFor("listenerId", true, …)为侦听器获取正确构建的答案。spring-doc.cadn.net.cn

`@RabbitListenerTest`和`RabbitListenerTestHarness`

注释您的其中一个@Configuration类@RabbitListenerTest使框架将标准RabbitListenerAnnotationBeanPostProcessor替换为名为RabbitListenerTestHarness（它还使@RabbitListener检测方式@EnableRabbit).spring-doc.cadn.net.cn

这RabbitListenerTestHarness以两种方式增强侦听器。首先，它将侦听器包装在Mockito Spy，启用“法线”Mockito存根和验证作。它还可以添加Advice添加到侦听器中，从而启用对 argument、result 和引发的任何异常的访问。您可以通过@RabbitListenerTest. 后者用于访问有关调用的较低级别数据。它还支持阻塞测试线程，直到异步侦听器被调用。spring-doc.cadn.net.cn

final @RabbitListener方法不能被窥探或建议。此外，只有id属性可以被窥探或建议。

请看看一些例子。spring-doc.cadn.net.cn

以下示例使用 spy：spring-doc.cadn.net.cn

@Configuration
@RabbitListenerTest
public class Config {

    @Bean
    public Listener listener() {
        return new Listener();
    }

    ...

}

public class Listener {

    @RabbitListener(id="foo", queues="#{queue1.name}")
    public String foo(String foo) {
        return foo.toUpperCase();
    }

    @RabbitListener(id="bar", queues="#{queue2.name}")
    public void foo(@Payload String foo, @Header("amqp_receivedRoutingKey") String rk) {
        ...
    }

}

public class MyTests {

    @Autowired
    private RabbitListenerTestHarness harness; (1)

    @Test
    public void testTwoWay() throws Exception {
        assertEquals("FOO", this.rabbitTemplate.convertSendAndReceive(this.queue1.getName(), "foo"));

        Listener listener = this.harness.getSpy("foo"); (2)
        assertNotNull(listener);
        verify(listener).foo("foo");
    }

    @Test
    public void testOneWay() throws Exception {
        Listener listener = this.harness.getSpy("bar");
        assertNotNull(listener);

        LatchCountDownAndCallRealMethodAnswer answer = this.harness.getLatchAnswerFor("bar", 2); (3)
        doAnswer(answer).when(listener).foo(anyString(), anyString()); (4)

        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "bar");
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "baz");

        assertTrue(answer.await(10));
        verify(listener).foo("bar", this.queue2.getName());
        verify(listener).foo("baz", this.queue2.getName());
    }

}

1	将 Harness 注入到测试用例中，以便我们可以访问 spy。
2	获取对 spy 的引用，以便我们可以验证它是否按预期调用。由于这是一个发送和接收作，因此无需暂停测试线程，因为它已经是 suspended 在`RabbitTemplate`等待回复。
3	在这种情况下，我们只使用 send作，因此我们需要一个 latch 来等待对侦听器的异步调用在容器线程上。我们使用 Answer<？> 实现之一来帮助解决这个问题。重要提示：由于侦听器的侦测方式，使用`harness.getLatchAnswerFor()`获取 SPY 的正确配置答案。
4	配置 spy 以调用`Answer`.

以下示例使用 capture 建议：spring-doc.cadn.net.cn

@Configuration
@ComponentScan
@RabbitListenerTest(spy = false, capture = true)
public class Config {

}

@Service
public class Listener {

    private boolean failed;

    @RabbitListener(id="foo", queues="#{queue1.name}")
    public String foo(String foo) {
        return foo.toUpperCase();
    }

    @RabbitListener(id="bar", queues="#{queue2.name}")
    public void foo(@Payload String foo, @Header("amqp_receivedRoutingKey") String rk) {
        if (!failed && foo.equals("ex")) {
            failed = true;
            throw new RuntimeException(foo);
        }
        failed = false;
    }

}

public class MyTests {

    @Autowired
    private RabbitListenerTestHarness harness; (1)

    @Test
    public void testTwoWay() throws Exception {
        assertEquals("FOO", this.rabbitTemplate.convertSendAndReceive(this.queue1.getName(), "foo"));

        InvocationData invocationData =
            this.harness.getNextInvocationDataFor("foo", 0, TimeUnit.SECONDS); (2)
        assertThat(invocationData.getArguments()[0], equalTo("foo"));     (3)
        assertThat((String) invocationData.getResult(), equalTo("FOO"));
    }

    @Test
    public void testOneWay() throws Exception {
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "bar");
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "baz");
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "ex");

        InvocationData invocationData =
            this.harness.getNextInvocationDataFor("bar", 10, TimeUnit.SECONDS); (4)
        Object[] args = invocationData.getArguments();
        assertThat((String) args[0], equalTo("bar"));
        assertThat((String) args[1], equalTo(queue2.getName()));

        invocationData = this.harness.getNextInvocationDataFor("bar", 10, TimeUnit.SECONDS);
        args = invocationData.getArguments();
        assertThat((String) args[0], equalTo("baz"));

        invocationData = this.harness.getNextInvocationDataFor("bar", 10, TimeUnit.SECONDS);
        args = invocationData.getArguments();
        assertThat((String) args[0], equalTo("ex"));
        assertEquals("ex", invocationData.getThrowable().getMessage()); (5)
    }

}

1	将 Harness 注入到测试用例中，以便我们可以访问 spy。
2	用`harness.getNextInvocationDataFor()`检索调用数据 - 在本例中，因为它是请求/回复场景，则无需等待任何时间，因为测试线程在`RabbitTemplate`等待以获得结果。
3	然后，我们可以验证参数和结果是否符合预期。
4	这一次我们需要一些时间来等待数据，因为它是容器线程上的异步作，我们需要以暂停测试线程。
5	当侦听器抛出异常时，它在`throwable`属性。

使用自定义Answer<?>s 替换为 Harness，为了正常运行，此类 ANSWERS 应 subclassForwardsInvocation并从工具框架（getDelegate("myListener")）并调用super.answer(invocation). 请参阅提供的莫基托Answer<?>实现源代码。

用`TestRabbitTemplate`

这TestRabbitTemplate用于执行一些基本的集成测试，而无需代理。当您将其添加为@Bean在你的测试用例中，它会发现上下文中的所有侦听器容器，无论是声明为@Bean或<bean/>或使用@RabbitListener注解。它目前仅支持按队列名称进行路由。该模板从容器中提取消息侦听器，并直接在测试线程上调用它。请求-回复消息（sendAndReceive方法）支持返回回复的侦听器。spring-doc.cadn.net.cn

以下测试用例使用模板：spring-doc.cadn.net.cn

@RunWith(SpringRunner.class)
public class TestRabbitTemplateTests {

    @Autowired
    private TestRabbitTemplate template;

    @Autowired
    private Config config;

    @Test
    public void testSimpleSends() {
        this.template.convertAndSend("foo", "hello1");
        assertThat(this.config.fooIn, equalTo("foo:hello1"));
        this.template.convertAndSend("bar", "hello2");
        assertThat(this.config.barIn, equalTo("bar:hello2"));
        assertThat(this.config.smlc1In, equalTo("smlc1:"));
        this.template.convertAndSend("foo", "hello3");
        assertThat(this.config.fooIn, equalTo("foo:hello1"));
        this.template.convertAndSend("bar", "hello4");
        assertThat(this.config.barIn, equalTo("bar:hello2"));
        assertThat(this.config.smlc1In, equalTo("smlc1:hello3hello4"));

        this.template.setBroadcast(true);
        this.template.convertAndSend("foo", "hello5");
        assertThat(this.config.fooIn, equalTo("foo:hello1foo:hello5"));
        this.template.convertAndSend("bar", "hello6");
        assertThat(this.config.barIn, equalTo("bar:hello2bar:hello6"));
        assertThat(this.config.smlc1In, equalTo("smlc1:hello3hello4hello5hello6"));
    }

    @Test
    public void testSendAndReceive() {
        assertThat(this.template.convertSendAndReceive("baz", "hello"), equalTo("baz:hello"));
    }

    @Configuration
    @EnableRabbit
    public static class Config {

        public String fooIn = "";

        public String barIn = "";

        public String smlc1In = "smlc1:";

        @Bean
        public TestRabbitTemplate template() throws IOException {
            return new TestRabbitTemplate(connectionFactory());
        }

        @Bean
        public ConnectionFactory connectionFactory() throws IOException {
            ConnectionFactory factory = mock(ConnectionFactory.class);
            Connection connection = mock(Connection.class);
            Channel channel = mock(Channel.class);
            willReturn(connection).given(factory).createConnection();
            willReturn(channel).given(connection).createChannel(anyBoolean());
            given(channel.isOpen()).willReturn(true);
            return factory;
        }

        @Bean
        public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory() throws IOException {
            SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
            factory.setConnectionFactory(connectionFactory());
            return factory;
        }

        @RabbitListener(queues = "foo")
        public void foo(String in) {
            this.fooIn += "foo:" + in;
        }

        @RabbitListener(queues = "bar")
        public void bar(String in) {
            this.barIn += "bar:" + in;
        }

        @RabbitListener(queues = "baz")
        public String baz(String in) {
            return "baz:" + in;
        }

        @Bean
        public SimpleMessageListenerContainer smlc1() throws IOException {
            SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(connectionFactory());
            container.setQueueNames("foo", "bar");
            container.setMessageListener(new MessageListenerAdapter(new Object() {

                public void handleMessage(String in) {
                    smlc1In += in;
                }

            }));
            return container;
        }

    }

}

JUnit4`@Rules`

Spring AMQP 版本 1.7 及更高版本提供了一个名为spring-rabbit-junit. 这个 jar 包含几个实用程序@Rule实例，以便在运行 JUnit4 测试时使用。请参阅 JUnit5 条件以了解 JUnit5 测试。spring-doc.cadn.net.cn

用`BrokerRunning`

BrokerRunning提供了一种机制，当代理未运行时（在localhost）。spring-doc.cadn.net.cn

它还具有用于初始化和清空队列以及删除队列和交换的实用方法。spring-doc.cadn.net.cn

以下示例显示了其用法：spring-doc.cadn.net.cn

@ClassRule
public static BrokerRunning brokerRunning = BrokerRunning.isRunningWithEmptyQueues("foo", "bar");

@AfterClass
public static void tearDown() {
    brokerRunning.removeTestQueues("some.other.queue.too") // removes foo, bar as well
}

有几个isRunning…static 方法，例如isBrokerAndManagementRunning()，用于验证代理是否启用了管理插件。spring-doc.cadn.net.cn

配置规则

有时，如果没有代理，例如夜间 CI 构建，您希望测试失败。要在运行时禁用该规则，请设置一个名为RABBITMQ_SERVER_REQUIRED自true.spring-doc.cadn.net.cn

您可以使用 setter 或环境变量覆盖代理属性，例如 hostname：spring-doc.cadn.net.cn

下面的示例演示如何使用 setter 覆盖属性：spring-doc.cadn.net.cn

@ClassRule
public static BrokerRunning brokerRunning = BrokerRunning.isRunningWithEmptyQueues("foo", "bar");

static {
    brokerRunning.setHostName("10.0.0.1")
}

@AfterClass
public static void tearDown() {
    brokerRunning.removeTestQueues("some.other.queue.too") // removes foo, bar as well
}

您还可以通过设置以下环境变量来覆盖属性：spring-doc.cadn.net.cn

public static final String BROKER_ADMIN_URI = "RABBITMQ_TEST_ADMIN_URI";
public static final String BROKER_HOSTNAME = "RABBITMQ_TEST_HOSTNAME";
public static final String BROKER_PORT = "RABBITMQ_TEST_PORT";
public static final String BROKER_USER = "RABBITMQ_TEST_USER";
public static final String BROKER_PW = "RABBITMQ_TEST_PASSWORD";
public static final String BROKER_ADMIN_USER = "RABBITMQ_TEST_ADMIN_USER";
public static final String BROKER_ADMIN_PW = "RABBITMQ_TEST_ADMIN_PASSWORD";

这些环境变量会覆盖默认设置（localhost:5672对于 AMQP 和localhost:15672/api/对于管理 REST API）。spring-doc.cadn.net.cn

更改主机名会影响amqp和managementREST API 连接（除非显式设置了管理员 URI）。spring-doc.cadn.net.cn

BrokerRunning还提供了一个static方法调用setEnvironmentVariableOverrides这样，您就可以传入包含这些变量的 Map。它们会覆盖系统环境变量。如果您希望对多个测试套件中的测试使用不同的配置，这可能很有用。重要说明：在调用任何isRunning()static 方法。变量值将应用于此调用后创建的所有实例。调用clearEnvironmentVariableOverrides()将规则重置为使用默认值（包括任何实际的环境变量）。spring-doc.cadn.net.cn

在测试用例中，您可以使用brokerRunning创建 Connection Factory 时;getConnectionFactory()返回规则的 RabbitMQConnectionFactory. 以下示例显示了如何执行此作：spring-doc.cadn.net.cn

@Bean
public CachingConnectionFactory rabbitConnectionFactory() {
    return new CachingConnectionFactory(brokerRunning.getConnectionFactory());
}

用`LongRunningIntegrationTest`

LongRunningIntegrationTest是禁用长时间运行的测试的规则。您可能希望在开发人员系统上使用它，但请确保在夜间 CI 构建等上禁用该规则。spring-doc.cadn.net.cn

以下示例显示了其用法：spring-doc.cadn.net.cn

@Rule
public LongRunningIntegrationTest longTests = new LongRunningIntegrationTest();

要在运行时禁用该规则，请设置一个名为RUN_LONG_INTEGRATION_TESTS自true.spring-doc.cadn.net.cn

JUnit5 条件

版本 2.0.2 引入了对 JUnit5 的支持。spring-doc.cadn.net.cn

使用`@RabbitAvailable`注解

这个类级注解类似于BrokerRunning @Rule讨论于JUnit4@Rules. 它由RabbitAvailableCondition.spring-doc.cadn.net.cn

该批注具有三个属性：spring-doc.cadn.net.cn

queues：在每次测试之前声明（和清除）并在所有测试完成时删除的队列数组。spring-doc.cadn.net.cn
management：将此项设置为true如果您的测试还需要在 broker 上安装 Management 插件。spring-doc.cadn.net.cn
purgeAfterEach：（自版本 2.2 起）当true（默认）、queues将在测试之间清除。spring-doc.cadn.net.cn

它用于检查 broker 是否可用，如果没有，则跳过测试。如配置规则中所述，名为RABBITMQ_SERVER_REQUIRED如果true，如果没有 Broker，则会导致测试快速失败。您可以使用环境变量配置条件，如配置规则中所述。spring-doc.cadn.net.cn

此外，RabbitAvailableCondition支持参数化测试构造函数和方法的参数解析。支持两种参数类型：spring-doc.cadn.net.cn

BrokerRunningSupport：实例（在 2.2 之前，这是 JUnit 4BrokerRunning实例）spring-doc.cadn.net.cn
ConnectionFactory：这BrokerRunningSupport实例的 RabbitMQ 连接工厂spring-doc.cadn.net.cn

以下示例显示了两者：spring-doc.cadn.net.cn

@RabbitAvailable(queues = "rabbitAvailableTests.queue")
public class RabbitAvailableCTORInjectionTests {

    private final ConnectionFactory connectionFactory;

    public RabbitAvailableCTORInjectionTests(BrokerRunningSupport brokerRunning) {
        this.connectionFactory = brokerRunning.getConnectionFactory();
    }

    @Test
    public void test(ConnectionFactory cf) throws Exception {
        assertSame(cf, this.connectionFactory);
        Connection conn = this.connectionFactory.newConnection();
        Channel channel = conn.createChannel();
        DeclareOk declareOk = channel.queueDeclarePassive("rabbitAvailableTests.queue");
        assertEquals(0, declareOk.getConsumerCount());
        channel.close();
        conn.close();
    }

}

前面的测试在框架本身中，验证参数注入以及条件是否正确创建了队列。spring-doc.cadn.net.cn

实际的用户测试可能如下所示：spring-doc.cadn.net.cn

@RabbitAvailable(queues = "rabbitAvailableTests.queue")
public class RabbitAvailableCTORInjectionTests {

    private final CachingConnectionFactory connectionFactory;

    public RabbitAvailableCTORInjectionTests(BrokerRunningSupport brokerRunning) {
        this.connectionFactory =
            new CachingConnectionFactory(brokerRunning.getConnectionFactory());
    }

    @Test
    public void test() throws Exception {
        RabbitTemplate template = new RabbitTemplate(this.connectionFactory);
        ...
    }
}

当你在测试类中使用 Spring 注解应用程序上下文时，你可以通过一个名为RabbitAvailableCondition.getBrokerRunning().spring-doc.cadn.net.cn

从版本 2.2 开始，getBrokerRunning()返回BrokerRunningSupport对象;以前，JUnit 4BrokerRunnning实例。新类具有与BrokerRunning.

以下测试来自框架，演示了用法：spring-doc.cadn.net.cn

@RabbitAvailable(queues = {
        RabbitTemplateMPPIntegrationTests.QUEUE,
        RabbitTemplateMPPIntegrationTests.REPLIES })
@SpringJUnitConfig
@DirtiesContext(classMode = ClassMode.AFTER_EACH_TEST_METHOD)
public class RabbitTemplateMPPIntegrationTests {

    public static final String QUEUE = "mpp.tests";

    public static final String REPLIES = "mpp.tests.replies";

    @Autowired
    private RabbitTemplate template;

    @Autowired
    private Config config;

    @Test
    public void test() {

        ...

    }

    @Configuration
    @EnableRabbit
    public static class Config {

        @Bean
        public CachingConnectionFactory cf() {
            return new CachingConnectionFactory(RabbitAvailableCondition
                    .getBrokerRunning()
                    .getConnectionFactory());
        }

        @Bean
        public RabbitTemplate template() {

            ...

        }

        @Bean
        public SimpleRabbitListenerContainerFactory
                            rabbitListenerContainerFactory() {

            ...

        }

        @RabbitListener(queues = QUEUE)
        public byte[] foo(byte[] in) {
            return in;
        }

    }

}

使用`@LongRunning`注解

与LongRunningIntegrationTestJUnit4@Rule，则此注释会导致跳过测试，除非将环境变量（或系统属性）设置为true. 以下示例演示如何使用它：spring-doc.cadn.net.cn

@RabbitAvailable(queues = SimpleMessageListenerContainerLongTests.QUEUE)
@LongRunning
public class SimpleMessageListenerContainerLongTests {

    public static final String QUEUE = "SimpleMessageListenerContainerLongTests.queue";

...

}

默认情况下，变量为RUN_LONG_INTEGRATION_TESTS，但您可以在注解的value属性。spring-doc.cadn.net.cn

测试支持

@SpringRabbitTest

莫基托Answer<?>实现

@RabbitListenerTest和RabbitListenerTestHarness

用TestRabbitTemplate

JUnit4@Rules

用BrokerRunning