Apollo Kotlin 从2.x升级到3.x：SubscriptionManager的迁移指南

在将项目从Apollo Kotlin 2.x迁移到3.x版本时，许多开发者会遇到SubscriptionManager相关API变更的问题。本文将深入分析这一变化，并提供详细的迁移方案。

核心问题分析

在Apollo Kotlin 2.x版本中，开发者可以通过ApolloClient.enableSubscriptions()和disableSubscriptions()方法来控制订阅功能，这些方法底层调用了SubscriptionManager.start()和stop()。但在3.x版本中，这些API已被移除，需要寻找替代方案。

3.x版本的解决方案

方案一：完全销毁并重建

最直接的迁移方式是使用新的网络传输控制API：

1. 停止订阅：调用client.subscriptionNetworkTransport.dispose()会关闭底层Channel，这与2.x的disableSubscriptions效果类似。

2. 重新启用订阅：由于dispose后的NetworkTransport不可重用，需要：

   • 创建新的subscriptionNetworkTransport
   • 通过ApolloClient.newBuilder()基于现有配置创建新客户端

这种方案简单直接，但会带来客户端实例重建的开销。

方案二：可控的连接管理

对于需要更精细控制的情况，可以使用3.x提供的连接管理机制：

// 定义重连信号通道和控制异常
val reconnectSignalChannel = Channel<Unit>(0)
object MyDisconnectException : Exception()

// 配置客户端
val apolloClient = ApolloClient.Builder()
    .webSocketReopenWhen { throwable, attempt ->
        if (throwable is MyDisconnectException) {
            reconnectSignalChannel.receive() // 等待重连信号
        }
        true
    }
    .build()

// 需要断开时
client.subscriptionNetworkTransport.closeConnection(MyDisconnectException)

// 需要重连时
reconnectSignalChannel.offer(Unit)

这种方案的优势在于：

• 保持客户端实例不变
• 实现精确的连接状态控制
• 可自定义重连逻辑

迁移建议

1. 简单场景：直接采用方案一，代码改动量小，逻辑清晰。

2. 复杂场景：如果需要保持客户端实例或实现特殊控制逻辑，推荐方案二。

3. 性能考量：频繁创建/销毁客户端实例会影响性能，在需要高频切换订阅状态的场景中应优先考虑方案二。

注意事项

1. 确保在适当的生命周期节点控制订阅状态，如应用进入后台时断开，回到前台时重连。

2. 考虑添加适当的错误处理和重试机制，特别是在网络不稳定的环境下。

3. 测试各种边界条件，如快速切换订阅状态、网络中断等情况下的行为。

通过理解这些迁移方案，开发者可以顺利地将订阅管理逻辑从Apollo Kotlin 2.x升级到3.x版本，同时根据具体需求选择最适合的实现方式。