Cucumber中@BeforeAll是否先于Spring应用上下文加载？问题排查与解决

一、验证Spring应用上下文是否加载 #

有两种简单的验证方式：

1. 注入ApplicationContext直接检查
   在你的Cucumber步骤类中注入ApplicationContext，然后在任意步骤方法中判断上下文状态：

   @SpringBootTest
   public class YourStepDefinitions {
       @Autowired
       private ApplicationContext context;
   
       @Given("some step")
       public void someStep() {
           if (context == null) {
               System.err.println("Spring上下文未加载");
           } else {
               System.out.println("Spring上下文已加载，可获取Bean数量：" + context.getBeanDefinitionCount());
           }
       }
   }
   

2. 通过ApplicationContextAware监听初始化
   创建一个类实现ApplicationContextAware，监听上下文初始化状态：

   @Component
   public class ContextChecker implements ApplicationContextAware {
       private static ApplicationContext context;
   
       @Override
       public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
           context = applicationContext;
           System.out.println("Spring上下文已初始化");
       }
   
       public static boolean isContextLoaded() {
           return context != null;
       }
   }
   

   在步骤类或钩子方法中调用ContextChecker.isContextLoaded()即可判断。

二、解决Spring上下文未加载的问题 #

你的@PostConstructBean属性为空、@Value取不到配置，大概率是Cucumber未正确加载Spring上下文，按以下步骤修复：

1. 确保引入正确依赖
   确认pom.xml（Maven）或build.gradle（Gradle）中包含cucumber-spring依赖，且版本与Spring/Spring Boot匹配：

   <!-- Maven示例 -->
   <dependency>
       <groupId>io.cucumber</groupId>
       <artifactId>cucumber-spring</artifactId>
       <version>7.14.0</version>
       <scope>test</scope>
   </dependency>
   

2. 为步骤类添加Spring测试注解
   在你的Cucumber步骤类上添加@SpringBootTest（Spring Boot项目）或@ContextConfiguration（非Spring Boot项目），指定Spring的启动类或配置类：

   @SpringBootTest(classes = YourApplicationMainClass.class)
   public class YourStepDefinitions {
       // 步骤方法、Bean注入等
   }
   

3. 检查Bean的组件扫描配置
   • 带有@PostConstruct的类必须添加@Component、@Service、@Repository等Spring组件注解，确保被Spring扫描到。
   • 确认Spring的组件扫描路径包含该类所在的包，必要时在启动类上通过@ComponentScan(basePackages = "com.your.package")指定。
4. 修复@Value配置读取问题
   • 确保application.yml文件放在src/test/resources目录下（测试环境）。
   • 检查@Value的key是否与配置文件中的一致，比如配置是app.api.url: http://example.com，则@Value("${app.api.url}")才正确。
   • 如果是非Spring Boot项目，需要通过@PropertySource("classpath:application.yml")指定配置文件（注意yml文件需要额外依赖支持）。

三、在@BeforeAll中发起REST请求 #

要在Cucumber的@BeforeAll中发起REST请求，需确保上下文已加载且能注入HTTP客户端：

1. 创建Spring管理的钩子类
   创建一个钩子类，添加@Component和@CucumberContextConfiguration注解，确保Spring上下文优先加载：

   @Component
   @CucumberContextConfiguration
   @SpringBootTest(classes = YourApplicationMainClass.class)
   public class CucumberHooks {
       @Autowired
       private RestTemplate restTemplate;
   
       @BeforeAll
       public void setupBeforeAll() {
           // 发起REST请求
           ResponseEntity<String> response = restTemplate.getForEntity("http://your-api-url.com/init", String.class);
           // 处理响应
           if (response.getStatusCode().is2xxSuccessful()) {
               System.out.println("初始化请求成功");
           }
       }
   }
   

2. 注意事项
   • 如果没有自定义RestTemplate，Spring Boot会自动配置一个，也可以使用WebTestClient（适用于测试WebFlux或Mock环境）。
   • @BeforeAll方法不需要是静态的，因为钩子类是Spring管理的Bean，依赖注入会正常工作。

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