Apollo Kotlin中GraphQL订阅协议的正确配置方式

在Apollo Kotlin项目中实现GraphQL订阅功能时，开发者可能会遇到关于WebSocket协议配置的问题。本文将详细介绍如何正确配置GraphQLWsProtocol以避免常见错误。

问题背景

当开发者尝试按照文档配置WebSocket协议时，可能会遇到"Apollo: 'webSocketEngine' has no effect if 'subscriptionNetworkTransport' is set"的错误提示。这个错误表明在配置订阅传输层时存在不兼容的设置方式。

错误配置分析

典型的错误配置方式是同时使用了.okHttpClient()和.subscriptionNetworkTransport()方法。这是因为.okHttpClient()方法内部会调用webSocketEngine()，而这两种配置方式不能同时使用。

正确配置方案

正确的做法是为查询/变更和订阅分别配置独立的网络传输层：

1. 对于常规的GraphQL查询和变更操作，使用HttpNetworkTransport配置HTTP传输层
2. 对于订阅操作，使用WebSocketNetworkTransport配置WebSocket传输层

具体配置示例如下：

val client = ApolloClient.Builder()
    .serverUrl(httpUrl)
    .subscriptionNetworkTransport(
        // 订阅传输配置
        WebSocketNetworkTransport.Builder()
            .protocol(GraphQLWsProtocol.Factory())
            .serverUrl(websocketUrl)
            .okHttpClient(okHttpClient)
            .build()
    )
    .networkTransport(
        // 查询/变更传输配置
        HttpNetworkTransport.Builder()
            .okHttpClient(okHttpClient)
            .build()
    )
    .build()

配置要点说明

1. 分离传输层：必须将HTTP和WebSocket传输层分开配置
2. 协议指定：在WebSocket配置中明确指定使用GraphQLWsProtocol
3. 客户端复用：可以复用同一个OkHttpClient实例，但需要在各自的传输层中分别配置

最佳实践建议

1. 确保HTTP和WebSocket的URL端点正确配置
2. 考虑为WebSocket连接添加适当的拦截器处理认证等逻辑
3. 对于生产环境，建议配置WebSocket连接的心跳和超时参数

通过这种分离配置的方式，开发者可以灵活地为不同类型的GraphQL操作配置最适合的网络传输层，同时避免配置冲突导致的运行时错误。