如何在 Junit5 中的函数中正确测试Kafka模板.send（）？

Question

我正在学习如何编写测试，尤其是有生产者的测试。我不能发布所有的类，因为它是巨大的（而不是我的，我应该通过改变测试来练习使用KafkaTemplate）。我不知道应该如何测试这样的电话。

我得到一个NPE是因为我正在测试的函数中有一个producer.send（“主题”，JsonObject）。函数是这样构建的：

@Autowired
private KafkaTemplate<String,EventDto> kafkaTemplate;

public EventDto sendEvent(Event event) {
       EventDto eventToSend = this.dtoMapper.mapToDto(event, SomeEvent.class);
       this.kafkaTemplate.send("topic",eventToSend);
       return eventToSend;
   }

在单元测试中，它是这样的（省略不相关的部分）：

@Test
void testSendEvent() {
      //omitted lines regarding second assert that works
      
      EventProducer producer = new EventProducer(something);
      EventDto dto = producer.sendEvent(Event.newBuilder().build());
      assertThat(dto).isNotNull();
      //there is a second assert here that passes, nothing to do with kafka
}

我们有Mockito，我想我需要以某种方式模拟KafkaTemplate。但是我不太明白如何“指导”发送事件在producer.sendEvent（）调用中使用KafkaTemplate？

解决方案编辑:我将< code>@Autowired改为用构造函数注入它。效果很好！下面是完整的类和方法

@Service
public class EventProducer implements EventProducerInterface {

   private final DtoMapper dtoMapper;
   private KafkaTemplate<String,EventDto> kafkaTemplate;

   @Autowired
   public EventProducer (KafkaTemplate<String,EventDto> kafkaTemplate, IDtoMapper dtoMapper) {
          Assert.notNull(dtoMapper, "dtoMapper must not be null");
          this.dtoMapper = dtoMapper;
          this.kafkaTemplate=kafkaTemplate;
       }

   public EventDto sendEvent(Event event) {
       EventDto eventToSend = this.dtoMapper.mapToDto(event, EventDto.class);
       this.kafkaTemplate.send("output-topic",eventToSend);
       return eventToSend;
   }
}

Answer 1

您应该使用构造函数注入而不是@Autowared：

private KafkaTemplate<String,EventDto> kafkaTemplate;

public EventProducer(KafkaTemplate<String,EventDto> kafkaTemplate, something) {
    this.kafkaTemplate = kafkaTemplate;
}

public EventDto sendEvent(Event event) {
       EventDto eventToSend = this.dtoMapper.mapToDto(event, SomeEvent.class);
       this.kafkaTemplate.send("topic",eventToSend);
       return eventToSend;
}

这样，您可以在测试中注入模拟：

@Test
void testSendEvent() {
      //omitted lines regarding second assert that works
      KafkaTemplate<<String,EventDto>> templateMock = mock(KafkaTemplate.class);
      EventProducer producer = new EventProducer(templateMock, something);
      EventDto dto = producer.sendEvent(Event.newBuilder().build());
      assertThat(dto).isNotNull();
      //there is a second assert here that passes, nothing to do with kafka
}

如果无法更改类的构造函数，则可以使用@MockBean提供模拟：

@MockBean
KafkaTemplate<String,EventDto> kafkaTemplate;

@Test
void testSendEvent() {
      //omitted lines regarding second assert that works
      
      EventProducer producer = new EventProducer(something);
      EventDto dto = producer.sendEvent(Event.newBuilder().build());
      assertThat(dto).isNotNull();
      //there is a second assert here that passes, nothing to do with kafka
}

但这种设计有点奇怪——EventProducer类是否有@Autowired和构造函数参数？自动连线只适用于bean，通常类要么有默认构造函数和@Autowired依赖项，要么通过构造函数注入所有内容。

如果我提供的这些选项对您不起作用，请添加有关类的构造函数和总体设计的更多详细信息。