单元测试中如何验证Kotlin协程内的handleMessage调用？

你遇到的问题核心是GlobalScope.launch启动的协程脱离了测试上下文，测试方法执行完毕时，后台协程还没来得及调用messageProcessor.handleMessage()，导致验证失败。runBlocking和coVerify无效，是因为协程不属于测试的协程作用域，无法被测试代码追踪控制。

以下是几种可行的解决方式：

方案1：替换GlobalScope为可注入的CoroutineScope（推荐） #

通过依赖注入协程作用域，让测试代码能完全控制协程执行时机，是最可靠的解决方式。

步骤1：修改端点类，注入CoroutineScope #

@MessageEndpoint
class MyTcpEndpoint(
    private val messageProcessor: MyMessageProcessor,
    private val coroutineScope: CoroutineScope // 注入自定义协程作用域
) {

    @ServiceActivator(inputChannel = "inboundChannel")
    fun process(messageByteArray: ByteArray): String {
        val message = String(messageByteArray)
        coroutineScope.launch {
            val myDto = // 基于message创建MyDto对象的逻辑
            messageProcessor.handleMessage(myDto)
        }
        log.trace("Sending 'OK' back to the calling camera")
        return "OK"
    }
}

步骤2：配置协程作用域的Bean #

在Spring配置类中定义全局的协程作用域Bean，供端点使用：

@Configuration
class CoroutineConfig {
    @Bean
    fun tcpEndpointCoroutineScope(): CoroutineScope = CoroutineScope(Dispatchers.Default)
}

步骤3：修改测试代码，控制协程执行 #

借助kotlinx-coroutines-test库的runTest和advanceUntilIdle()方法，确保协程执行完成后再做验证：

internal class MyTcpEndpointTest {

    @Test
    fun myTest() = runTest {
        // GIVEN
        val messageProcessor = mockk<MyMessageProcessor>(relaxed = true)
        val testScope = TestCoroutineScope()
        val tcpEndpoint = MyTcpEndpoint(messageProcessor, testScope)

        val messageByteArray = myXmlString.toByteArray()

        // WHEN
        tcpEndpoint.process(messageByteArray)
        testScope.advanceUntilIdle() // 推进到所有协程执行完毕

        // THEN
        verify { messageProcessor.handleMessage(MyDto(...)) }
    }
}

方案2：使用MockK的带超时验证（快速临时方案） #

如果暂时不想修改端点代码，可以给verify添加超时时间，让测试等待协程执行完成：

internal class MyTcpEndpointTest {

    @Test
    fun myTest() {
        // GIVEN
        val messageProcessor = mockk<MyMessageProcessor>(relaxed = true)
        val tcpEndpoint = MyTcpEndpoint(messageProcessor)

        val messageByteArray = myXmlString.toByteArray()

        // WHEN
        tcpEndpoint.process(messageByteArray)

        // THEN
        verify(timeout = 1000) { // 等待1秒直到调用发生
            messageProcessor.handleMessage(MyDto(...))
        }
    }
}

注意：这个方案依赖超时时间，可能因环境差异导致不稳定，仅适合临时验证。

方案3：不推荐的延迟等待 #

直接在验证前添加延迟，让协程有时间执行，但这种方式最不可靠，不建议使用：

internal class MyTcpEndpointTest {

    @Test
    fun myTest() = runBlocking {
        // GIVEN & WHEN 逻辑不变

        delay(500) // 等待500毫秒
        verify { messageProcessor.handleMessage(MyDto(...)) }
    }
}

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