在ApplicationEvent上测试Spring的简单方法

Question

我有一个应用程序事件侦听器，其中包含以下函数：

@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
//do some stuff
}

我如何编写一个单元测试来模拟ContextRefreshedEvent，比如正在执行的jar，并测试我的onApplicationEvent函数是否完成了它应该做的事情？

Answer 1

我基于这个Spring Boot示例实现了一个编程有效负载侦听器测试，如果有人可能需要模拟测试而不是加载所有Spring上下文。

@Test
public void testProgrammaticEventListener() {
    final List<StoreEvent> events = new ArrayList<>();
    final ApplicationListener<PayloadApplicationEvent<Integer>> listener = forPayload(events::add);

    ConfigurableApplicationContext ac = new GenericApplicationContext();
    ac.addApplicationListener(listener);
    ac.refresh();

    PayloadApplicationEvent<Integer> event = new PayloadApplicationEvent<>(this, 1);
    ac.publishEvent(event);
    assertThat(events.contains(event.getPayload()), Is.is(true));
}

在示例代码中，Application ationListener.forPayload中有一个方法；如果它不存在，您可以手动添加到您的测试类中：

static <T> ApplicationListener<PayloadApplicationEvent<T>> forPayload(final Consumer<T> consumer) {
        return event -> consumer.accept(event.getPayload());
    }

参考PayloadApplication EventTests.java#L65

Answer 2

这是我能想到的最小的独立示例。

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import java.util.concurrent.LinkedBlockingQueue;

import static org.junit.Assert.assertEquals;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {RefreshTest.MyConfig.class})
public class RefreshTest {

    @Autowired
    private MyListener listener;

    @Test
    public void test() {
        assertEquals("Refresh should be called once",1, listener.events.size());
    }

    public static class MyConfig {
        @Bean
        public MyListener listener() {
            return new MyListener();
        }
    }

    public static class MyListener implements ApplicationListener <ContextRefreshedEvent> {
        // you don't really need a threadsafe collection in a test, as the test main thread is also loading the spring contest and calling the handler, 
        // but if you are inside an application, you should be aware of which thread is calling in case you want to read the result from another thread. 
        LinkedBlockingQueue<ContextRefreshedEvent> events = new LinkedBlockingQueue<ContextRefreshedEvent>();
        public void onApplicationEvent(ContextRefreshedEvent  event) {
            events.add(event);
        }
    }
}

在处理程序内部测试代码和调用处理程序之间存在差异。不要将代码直接放在处理程序中，而是放在从处理程序调用的另一个bean中，因此可以在没有处理程序的情况下测试逻辑（通过使用您创建的上下文刷新事件调用它）。刷新上下文时（通常在加载上下文时）会发送刷新事件，因此无需对此进行测试。如果在您的生产代码中没有调用它，您通常会立即注意到。此外，测试和生产环境之间的上下文加载可能不同，因此即使您编写了一个显示已调用处理程序的测试，也不能保证它将在生产环境中被调用，除非您使用完全相同的配置运行，我几乎从未这样做，因为我经常使用Profile实现不同的配置/bean，例如，当我不希望我的测试使用AWS队列和其他外部IO通道时。