Spring Boot中如何Mock带有@EventListener(ApplicationReadyEvent)的类方法？

以下是几种可行的解决方案，根据你的测试场景选择：

1. 基于环境配置跳过初始化逻辑 #

在初始化方法中添加环境判断，测试环境下不执行核心逻辑：

@Component
public class FooImpl implements FooInterface {

    @Autowired
    private Environment environment;

    @Autowired
    private MyService anotherServiceIneed;

    Logger logger = LoggerFactory.getLogger(FooImpl.class);

    @EventListener(ApplicationReadyEvent.class)
    @Order(1)
    public void doSomethingonApplicationStartup() {
        // 测试环境下跳过执行
        if (!environment.acceptsProfiles(Profiles.of("test"))) {
            // do stuff with anotherServiceIneed
        }
    }
}

然后在测试类中激活test配置：

@SpringBootTest
@AutoConfigureMockMvc
@ActiveProfiles("test")
public class AnotherPartOfTheApplication {
    @Test
    public void testMethod() {
        // 测试逻辑
    }
}

2. Mock接口而非实现类 #

由于FooImpl实现了FooInterface，直接Mock接口可以替换所有实现类的实例，避免原初始化方法被调用：

@SpringBootTest
@AutoConfigureMockMvc
public class AnotherPartOfTheApplication {
    @MockBean
    private FooInterface fooInterface; // Mock接口而非具体实现

    @Test
    public void testMethod() {
        // 测试逻辑
    }
}

3. 用测试配置覆盖原组件 #

在测试类中定义@TestConfiguration，提供一个不执行初始化逻辑的FooInterface实现，覆盖原有的FooImpl：

@SpringBootTest
@AutoConfigureMockMvc
public class AnotherPartOfTheApplication {

    @TestConfiguration
    static class TestOverrideConfig {
        @Bean
        public FooInterface fooInterface() {
            return new FooInterface() {
                // 空实现，不执行任何初始化操作
                @Override
                public void doSomethingonApplicationStartup() {}
            };
        }
    }

    @Test
    public void testMethod() {
        // 测试逻辑
    }
}

4. 单独测试初始化方法 #

如果需要验证初始化逻辑的正确性，单独编写单元测试，手动调用方法而非依赖上下文启动：

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.mockito.Mockito.*;

@ExtendWith(MockitoExtension.class)
public class FooImplInitializationTest {
    @InjectMocks
    private FooImpl fooImpl;

    @Mock
    private MyService anotherServiceIneed;

    @BeforeEach
    void setUp() {
        // 初始化Mock环境
    }

    @Test
    void testInitializationLogic() {
        // 模拟依赖方法的返回值
        when(anotherServiceIneed.someRequiredMethod()).thenReturn("mockResult");

        // 手动调用初始化方法
        fooImpl.doSomethingonApplicationStartup();

        // 验证依赖方法是否被正确调用
        verify(anotherServiceIneed, times(1)).someRequiredMethod();
    }
}

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