Apollo iOS 项目中 WebSocket 订阅协议配置问题解析

问题背景

在 iOS 开发中使用 Apollo GraphQL 客户端进行订阅操作时，开发者可能会遇到 WebSocket 连接错误。这类问题通常与 WebSocket 子协议配置不当有关，特别是在本地开发环境或模拟器中运行时。

错误现象

开发者在使用 iOS 模拟器进行 GraphQL 订阅测试时，可能会遇到两种典型错误：

1. SSL 相关错误："The operation couldn't be completed. (OSStatus error -9847.)"
2. WebSocket 协议错误："The operation couldn't be completed. (ApolloWebSocket.WebSocket.WSError error 1.)"

问题根源分析

1. 本地开发环境使用 wss 协议

第一个 SSL 错误通常是因为在本地开发环境中错误地使用了 wss(WebSocket Secure)协议而非 ws 协议。本地开发服务器通常不会配置 SSL 证书，因此应该使用非加密的 ws 协议。

2. WebSocket 子协议不匹配

第二个错误则更为关键，它反映了 WebSocket 子协议配置不正确的问题。GraphQL over WebSocket 有多种实现协议，常见的有：

• graphql-ws 库使用的 graphql-transport-ws 协议
• subscriptions-transport-ws 库使用的 graphql-ws 协议

许多开发者容易混淆库名称和实际协议名称，导致配置错误。

解决方案

1. 本地环境协议配置

对于本地开发环境，应确保：

• 使用 ws:// 而非 wss:// 协议
• 确认本地 WebSocket 服务器已正确启动并监听指定端口

2. 正确配置 WebSocket 子协议

在 Apollo iOS 客户端初始化 WebSocket 连接时，必须根据后端使用的实际库选择正确的子协议：

// 如果后端使用 graphql-ws 库
let protocol = WebSocket.WSProtocol.graphql_transport_ws

// 如果后端使用 subscriptions-transport-ws 库
let protocol = WebSocket.WSProtocol.graphql_ws

最佳实践建议

1. 环境区分：为不同环境(开发/生产)配置不同的 WebSocket 连接参数
2. 协议验证：与后端团队确认使用的具体 WebSocket 实现库
3. 错误处理：实现完善的错误处理机制，捕获并记录连接过程中的详细错误信息
4. 日志记录：在开发阶段启用详细日志，帮助诊断连接问题

总结

Apollo iOS 客户端中的 WebSocket 订阅功能配置需要注意两个关键点：一是正确选择 ws/wss 协议以适应不同环境，二是准确匹配后端使用的 GraphQL WebSocket 子协议。理解这两点可以避免大多数连接问题，确保订阅功能正常工作。