自定义Spring ApplicationRunner的单元测试最佳实践与传参方案

核心思路 #

要同时满足加载完整Spring上下文（保证@Autowired注入正常）和自主控制参数、阻止Runner自动执行，可以通过以下几种方案实现：

方案一：条件注解控制自动执行（推荐） #

在你的RefAppRunner类上添加条件注解，默认生产环境自动执行，测试环境禁用自动触发，测试时手动调用：

1. 修改RefAppRunner类 #

@Component
// 默认启用自动执行，测试时可通过属性关闭
@ConditionalOnProperty(name = "ref.app.runner.enabled", havingValue = "true", matchIfMissing = true)
public class RefAppRunner implements ApplicationRunner {
    @Autowired
    private YourDependency yourDependency; // 原有注入字段

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 原有业务逻辑
    }
}

2. 编写测试类 #

@SpringBootTest(properties = {"ref.app.runner.enabled=false"})
public class RefAppRunnerTest {

    @Autowired
    private RefAppRunner refAppRunner;

    @Test
    public void testRunWithSpecificArgs() throws Exception {
        // 构造自定义测试参数
        ApplicationArguments testArgs = new DefaultApplicationArguments("--param1=foo", "--param2=bar");
        
        // 手动调用Runner的run方法
        refAppRunner.run(testArgs);
        
        // 添加断言验证行为，例如检查依赖组件的状态、处理结果等
        // assertThat(yourDependency.getProcessedResult()).isEqualTo(expectedValue);
    }
}

方案二：拦截ApplicationReadyEvent阻止自动执行 #

通过自定义配置拦截Spring Boot的ApplicationReadyEvent（该事件触发后会自动执行所有ApplicationRunner），从而阻止自动执行，同时保留完整上下文：

@SpringBootTest
public class RefAppRunnerTest {

    @Autowired
    private RefAppRunner refAppRunner;

    @Test
    public void testRunWithCustomParams() throws Exception {
        // 构造参数
        ApplicationArguments args = new DefaultApplicationArguments("--test-mode", "--data-path=/tmp/test");
        
        // 手动执行Runner
        refAppRunner.run(args);
        
        // 断言逻辑
    }

    // 测试配置类：拦截ApplicationReadyEvent，阻止Runner自动执行
    @TestConfiguration
    static class DisableAutoRunnerConfig {
        @Bean
        public SpringApplicationBuilderCustomizer runnerDisabler() {
            return builder -> builder.listeners(
                (ApplicationListener<ApplicationReadyEvent>) event -> {
                    // 空实现，覆盖默认的Runner执行逻辑
                }
            );
        }
    }
}

方案三：手动构建Spring上下文 #

如果不想使用@SpringBootTest，可以手动构建Spring应用上下文，完全控制Runner的执行时机：

public class RefAppRunnerTest {

    private RefAppRunner refAppRunner;

    @BeforeEach
    void initContext() {
        // 构建Spring应用，禁用Web环境，拦截Runner自动执行
        SpringApplication app = new SpringApplication(YourSpringBootApplication.class);
        app.setWebApplicationType(WebApplicationType.NONE);
        app.addListeners((ApplicationListener<ApplicationReadyEvent>) event -> {});
        
        // 启动上下文并获取Runner实例
        ApplicationContext context = app.run();
        refAppRunner = context.getBean(RefAppRunner.class);
    }

    @Test
    public void testRunWithDifferentArgs() throws Exception {
        ApplicationArguments testArgs = new DefaultApplicationArguments("--env=test", "--debug");
        refAppRunner.run(testArgs);
        
        // 验证逻辑
    }
}

注意事项 #

• 无论哪种方案，核心都是保留完整Spring上下文，才能保证@Autowired的依赖正常注入，避免空指针。
• 手动调用run()方法时，用DefaultApplicationArguments即可快速构造符合Spring规范的命令行参数。

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