java - 测试Spring onApplicationEvent的简单方法

Question

我有一个包含函数的应用程序事件监听器:

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

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

Answer 1

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

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 中，这样您就可以在没有处理程序的情况下测试逻辑(通过使用您创建的 ContextRefreshedEvent 调用它)。刷新上下文时(通常是加载时)会发送刷新事件，因此无需对其进行测试。如果它没有在您的生产代码中被调用，您通常会立即注意到。此外，测试和生产之间的上下文加载可能不同，因此即使您编写的测试显示调用了处理程序，也不能保证它会在生产中调用，除非您使用完全相同的 @Configuration 运行- 我几乎从不这样做，因为我经常最终使用 @Profile 对某些配置/bean 进行不同的实现，例如当我不希望我的测试使用 AWS 队列时，并且其他外部 IO channel 。