JUnit测试Spring Kafka配置类：如何在@BeforeEach中加载配置？

问题根源 #

1. @PropertySource不支持YAML文件：该注解默认仅能解析.properties格式配置，无法读取application.yml中的配置，导致bootstrapServers始终为null。
2. Bean初始化时机问题：Spring上下文初始化阶段就会创建producerFactory Bean，而@BeforeEach是在Bean创建完成后执行的，此时再设置bootstrapServers已经无法影响producerFactory中的配置。

解决方案 #

方案一：使用@SpringBootTest（推荐）

这是Spring Boot官方推荐的测试方式，会自动加载YAML配置并处理@ConfigurationProperties，无需手动配置解析逻辑。

修改测试类：

@SpringBootTest(classes = {KafkaProducerConfig.class, MessageProducerServiceImpl.class})
// 可选：使用专门的测试配置文件，避免污染主配置
@TestPropertySource(locations = "classpath:application-test.yml")
public class MessageProducerServiceImplTest {
  
  @Autowired
  private MessageProducerServiceImpl messageProducerServiceImpl; 
  
  @MockBean
  private KafkaTemplate<String, String> kafkaTemplate;

  @Test
  void sendMessageTest() throws Exception {
    messageProducerServiceImpl.sendMessage("somemessage");
    // 可添加验证逻辑，例如：verify(kafkaTemplate).send(anyString(), anyString());
  }
}

在test/resources下创建application-test.yml：

si-producer:
  kafka:
    configuration:
      bootstrapServers: "localhost:9092"
      topic: "test-topic"

方案二：手动加载YAML配置（无需@SpringBootTest）

如果不想使用@SpringBootTest，可以通过ApplicationContextInitializer手动解析YAML文件，确保配置在Bean初始化前加载。

1. 创建YAML配置初始化类：

public class YamlPropertySourceInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        Resource resource = applicationContext.getResource("classpath:application.yml");
        try {
            YamlPropertySourceLoader loader = new YamlPropertySourceLoader();
            PropertySource<?> propertySource = loader.load("yamlProperties", resource).get(0);
            applicationContext.getEnvironment().getPropertySources().addFirst(propertySource);
        } catch (IOException e) {
            throw new RuntimeException("加载YAML配置失败", e);
        }
    }
}

2. 修改测试类：

@ExtendWith(SpringExtension.class)
@ContextConfiguration(
    classes = {KafkaProducerConfig.class, MessageProducerServiceImpl.class},
    initializers = YamlPropertySourceInitializer.class
)
public class MessageProducerServiceImplTest {
  
  @Autowired
  private MessageProducerServiceImpl messageProducerServiceImpl; 
  
  @MockBean
  private KafkaTemplate<String, String> kafkaTemplate;

  @Test
  void sendMessageTest() throws Exception {
    messageProducerServiceImpl.sendMessage("somemessage");
  }
}

方案三：@BeforeEach中重新初始化Bean（不推荐）

如果必须在@BeforeEach中修改配置，需要重新注册相关Bean，但会破坏Spring上下文一致性，仅作特殊场景参考：

@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = {KafkaProducerConfig.class, MessageProducerServiceImpl.class})
@DirtiesContext(methodMode = DirtiesContext.MethodMode.AFTER_METHOD) // 每次测试后刷新上下文
public class MessageProducerServiceImplTest {
  
  @Autowired
  private ConfigurableApplicationContext context;
  
  @Autowired
  private MessageProducerServiceImpl messageProducerServiceImpl; 
  
  @Autowired
  private KafkaProducerConfig kafkaProducerConfig;
  
  @MockBean
  private KafkaTemplate<String, String> kafkaTemplate;

  @BeforeEach
  void setUp() {
    kafkaProducerConfig.setBootstrapServers("somebootstrapServer");
    // 重新注册producerFactory和kafkaTemplate Bean
    DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) context.getBeanFactory();
    try {
      beanFactory.registerSingleton("siProducerFactory", kafkaProducerConfig.producerFactory());
      beanFactory.registerSingleton("siKafkaTemplate", kafkaProducerConfig.commonProducerKafkaTemplate());
    } catch (FileNotFoundException e) {
      throw new RuntimeException(e);
    }
  }

  @Test
  void sendMessageTest() throws Exception {
    messageProducerServiceImpl.sendMessage("somemessage");
  }
}

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