kotlin 携程 withTimeoutOrNull

heeheeai2024-06-28 23:53

withTimeoutOrNull 是 Kotlin 协程库中的一个函数，它用于在指定的时间内执行一个协程，如果协程在超时时间内完成，则返回协程的结果，否则返回 null。

函数签名:

fun <T> withTimeoutOrNull(timeMillis: Long, block: suspend CoroutineScope.() -> T): T?

参数:

timeMillis: 超时时间，单位为毫秒。
block: 要执行的协程代码块。

返回值:

如果协程在超时时间内完成，则返回协程的结果。
如果协程在超时时间内未完成，则返回 null。

用法示例:

import kotlinx.coroutines.*

fun main() = runBlocking {
    // 执行一个耗时操作，超时时间为 1 秒
    val result = withTimeoutOrNull(1000) {
        delay(2000) // 延迟 2 秒
        "操作完成"
    }

    println(result) // 打印结果：null
}

解释:

在上面的示例中，withTimeoutOrNull 函数被用来执行一个延迟 2 秒的协程，超时时间为 1 秒。
由于协程在超时时间内未完成，因此 withTimeoutOrNull 函数返回 null。

使用场景:

限制操作执行时间: 在需要限制操作执行时间的场景下，可以使用 withTimeoutOrNull 函数来防止操作长时间阻塞。
处理异步操作超时: 在处理异步操作时，可以使用 withTimeoutOrNull 函数来处理超时情况，例如网络请求超时。
避免死锁: 在可能发生死锁的场景下，可以使用 withTimeoutOrNull 函数来设置超时时间，避免程序卡死。

注意:

withTimeoutOrNull 函数不会取消协程，即使协程在超时时间内未完成，它也会继续执行。
如果协程在超时时间内完成，withTimeoutOrNull 函数会返回协程的结果，而不是 null。