Apollo Kotlin iOS 中 DefaultHttpEngine 的线程安全问题分析

在 Apollo Kotlin 4.0.0-rc.1 版本中，iOS 平台上的 DefaultHttpEngine 组件被发现存在一个潜在的线程安全问题。这个问题主要影响在多线程环境下使用 HttpInterceptor 的场景，可能导致 HashMap 操作时抛出 ArrayIndexOutOfBoundsException 或 IllegalStateException 异常。

问题背景

当开发者在构建 ApolloClient 时添加了 HttpInterceptor 拦截器，并且在多线程协程上下文（如使用 MultithreadedDispatchers）中并发执行多个 Apollo 查询或变更操作时，系统可能会随机抛出异常。根据用户报告，在 iOS 18 设备上约有 10% 的用户会遇到此问题。

技术细节分析

问题的根源在于 StreamingDataDelegate.registerHandlerForTask 方法中对 HashMap 的操作缺乏线程同步机制。在并发环境下，多个线程同时操作同一个 HashMap 实例可能导致内部数据结构损坏，从而引发以下两种异常：

1. ArrayIndexOutOfBoundsException：当多个线程同时尝试扩容 HashMap 时可能发生
2. IllegalStateException：当 HashMap 的内部状态被并发修改破坏时可能发生

典型场景重现

这个问题最常出现在以下典型使用场景中：

// 添加带有认证令牌的拦截器
addHttpInterceptor(object : HttpInterceptor {
    override suspend fun intercept(
        request: HttpRequest, chain: HttpInterceptorChain
    ): HttpResponse {
        val token = try {
            authenticationService.acquireToken()
        } catch (ex: CancellationException) {
            throw ex
        } catch (e: Exception) {
            null
        }
        return chain.proceed(
            when {
                token == null -> request
                else -> request
                    .newBuilder()
                    .addHeader("Authorization", "Bearer $token")
                    .build()
            },
        )
    }
})

当上述配置的 ApolloClient 在多线程环境下被并发调用时，就可能触发线程安全问题。

解决方案

Apollo Kotlin 开发团队已经识别并修复了这个问题。修复方案主要是为 HashMap 操作添加了适当的同步机制，确保在多线程环境下的线程安全。该修复已经合并到主分支，并计划包含在即将发布的 4.1.1 版本中。

对于急需修复的用户，可以考虑以下临时解决方案：

1. 使用预览版本（4.1.1-2025.01.21）
2. 在应用中限制 Apollo 操作在单线程上下文中执行
3. 自定义实现线程安全的 HttpEngine

最佳实践建议

为了避免类似的线程安全问题，建议开发者在多线程环境下使用 Apollo Kotlin 时注意以下几点：

1. 及时更新到最新稳定版本
2. 对于关键业务逻辑，考虑使用单线程调度器
3. 在自定义拦截器中注意线程安全
4. 对共享状态的操作要添加适当的同步机制

根据用户反馈，在升级到修复版本后，该问题已不再出现，证明了修复方案的有效性。