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

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

2025-06-18 16:19:13作者:俞予舒Fleming

在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操作配置最适合的网络传输层,同时避免配置冲突导致的运行时错误。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8