如何使用Mockito-Kotlin实现Producer.send方法的测试桩？

问题核心 #

Kafka Producer.send 存在多方法重载，且返回值为Future<RecordMetadata>，在Kotlin环境下容易因泛型匹配、方法签名细节导致Mock桩设置失效，同时对返回值的正确构造也容易产生困惑。

完整解决方案 #

1. 测试依赖准备 #

优先选用适配Kotlin的Mock库mockk，避免Mockito在Kotlin泛型、空安全场景下的适配问题：

testImplementation "io.mockk:mockk:1.13.8"
testImplementation "org.junit.jupiter:junit-jupiter-api:5.9.2"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.9.2"

2. 目标ServiceImpl示例 #

先明确待测试的服务类结构（模拟真实业务场景）：

import org.apache.kafka.clients.producer.KafkaProducer
import org.apache.kafka.clients.producer.ProducerRecord
import org.springframework.stereotype.Service

@Service
class KafkaMessageServiceImpl(
    private val kafkaProducer: KafkaProducer<String, String>
) {
    // 无回调的发送方法
    fun sendMessage(topic: String, key: String, value: String) {
        val record = ProducerRecord(topic, key, value)
        kafkaProducer.send(record)
    }

    // 带回调的发送方法
    fun sendMessageWithCallback(topic: String, key: String, value: String) {
        val record = ProducerRecord(topic, key, value)
        kafkaProducer.send(record) { metadata, exception ->
            // 业务回调逻辑（比如日志记录、异常处理）
        }
    }
}

3. 单元测试实现 #

场景1：测试无回调的send方法

import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.apache.kafka.clients.producer.KafkaProducer
import org.apache.kafka.clients.producer.ProducerRecord
import org.apache.kafka.clients.producer.RecordMetadata
import org.junit.jupiter.api.Test
import java.util.concurrent.CompletableFuture

class KafkaMessageServiceImplTest {

    @Test
    fun `send message should trigger producer send correctly`() {
        // 1. Mock KafkaProducer实例
        val mockProducer = mockk<KafkaProducer<String, String>>()
        
        // 2. 构造模拟的返回结果：已完成的成功Future
        val mockMetadata = mockk<RecordMetadata>()
        val successFuture = CompletableFuture.completedFuture(mockMetadata)
        
        // 3. 设置Mock桩：匹配任意ProducerRecord类型的参数，返回成功Future
        every { mockProducer.send(any<ProducerRecord<String, String>>()) } returns successFuture
        
        // 4. 初始化服务并执行测试方法
        val service = KafkaMessageServiceImpl(mockProducer)
        service.sendMessage("test-topic", "user-1001", "hello kafka")
        
        // 5. 验证send方法被调用一次，且参数符合预期
        verify(exactly = 1) {
            mockProducer.send(match { 
                it.topic() == "test-topic" && it.key() == "user-1001" 
            })
        }
    }
}

场景2：测试带回调的send方法

针对带Callback参数的重载方法，需明确匹配方法签名：

@Test
fun `send message with callback should trigger producer send with callback`() {
    val mockProducer = mockk<KafkaProducer<String, String>>()
    val mockMetadata = mockk<RecordMetadata>()
    val successFuture = CompletableFuture.completedFuture(mockMetadata)
    
    // 匹配带Callback参数的send重载
    every { 
        mockProducer.send(any<ProducerRecord<String, String>>(), any()) 
    } returns successFuture
    
    val service = KafkaMessageServiceImpl(mockProducer)
    service.sendMessageWithCallback("test-topic", "user-1001", "hello kafka")
    
    // 验证重载方法被调用
    verify(exactly = 1) {
        mockProducer.send(any<ProducerRecord<String, String>>(), any())
    }
}

常见问题排查 #

• 重载匹配失败：必须明确指定参数类型（如any<ProducerRecord<String, String>>()），避免Mock库匹配到错误的重载方法。
• Future返回值错误：必须返回已完成的Future（成功用completedFuture，失败用failedFuture），否则测试会因异步阻塞或未完成状态导致断言失效。
• 泛型匹配问题：若遇到泛型擦除导致的匹配失败，用match自定义参数匹配逻辑，精准校验ProducerRecord的topic、key等属性。

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