KafkaTemplate测试时额外添加换行符的问题排查与解决

问题本质 #

这个换行符通常是Jackson序列化时开启了缩进格式化（INDENT_OUTPUT）导致的，或是Lombok的toString方法默认带换行，但你的验证逻辑用了无换行的预期字符串，最终导致匹配失败。

三种可行解决思路 #

1. 从根源消除换行：调整序列化配置 #

如果用的是Spring Kafka的Jackson序列化器，直接关闭缩进输出，让序列化后的JSON不带换行：

@Bean
public KafkaTemplate<String, ConferenceInstanceDTO> kafkaTemplate(ProducerFactory<String, ConferenceInstanceDTO> producerFactory) {
    KafkaTemplate<String, ConferenceInstanceDTO> template = new KafkaTemplate<>(producerFactory);
    ObjectMapper objectMapper = new ObjectMapper();
    // 关闭序列化时的缩进格式化，避免生成换行
    objectMapper.disable(SerializationFeature.INDENT_OUTPUT);
    template.setValueSerializer(new JsonSerializer<>(objectMapper));
    return template;
}

修改后实际发送的消息体就不会带换行，验证时直接用预期的ConferenceInstanceDTO对象匹配即可。

2. 灵活匹配：用Mockito参数匹配器忽略换行 #

不想改配置的话，用ArgumentMatchers.argThat()自定义匹配逻辑，两种实现方式可选：

方式A：去除换行后比较JSON字符串

ConferenceInstanceDTO expectedDto = // 构建你的预期DTO

verify(kafkaTemplate).send(eq("你的目标topic"), argThat(actualDto -> {
    ObjectMapper mapper = new ObjectMapper();
    try {
        String expectedJson = mapper.writeValueAsString(expectedDto).replaceAll("\\n", "");
        String actualJson = mapper.writeValueAsString(actualDto).replaceAll("\\n", "");
        return expectedJson.equals(actualJson);
    } catch (JsonProcessingException e) {
        throw new RuntimeException(e);
    }
}));

方式B：直接比对DTO属性（推荐）

这种方式不受序列化格式、字段顺序影响，稳定性更高：

ConferenceInstanceDTO expectedDto = // 构建你的预期DTO

verify(kafkaTemplate).send(eq("你的目标topic"), argThat(actualDto -> {
    return Objects.equals(actualDto.getId(), expectedDto.getId())
            && Objects.equals(actualDto.getConferenceName(), expectedDto.getConferenceName())
            // 按需求比对所有关键属性
            ;
}));

3. 调整Lombok的ToString格式（仅针对toString导致的换行） #

如果换行来自Lombok的@ToString默认格式，自定义ToString样式去掉换行：

@ToString(style = ToStringStyle.SIMPLE_STYLE)
@Data
public class ConferenceInstanceDTO {
    // 你的字段定义
}

注意：这个只影响toString()方法的输出，如果是Jackson序列化导致的换行，还是前两种方案更有效。

内容的提问来源于stack exchange，提问作者Umut Emre Önder