C#如何实现GraphQL订阅_C# HotChocolate实时订阅教程【高级】

夏磊同学_3798

夏磊同学_3798

2026-05-18

767人浏览

原创

graphql订阅在c#中基于websocket长连接实现,需显式启用usewebsockets()、配置反向代理、返回iasyncenumerable或eventstream、匹配协议(graphql-ws或升级至v13+支持双协议),并监听诊断事件捕获错误。

c#如何实现graphql订阅_c# hotchocolate实时订阅教程【高级】

GraphQL订阅在C#里不是靠轮询实现的

HotChocolate 的 Subscription 本质是基于 WebSocket 的长连接,不是 HTTP 请求重试或 SignalR 封装。如果你在 Startup 中只配了 AddGraphQLServer() 却没启用 WebSocket 支持,subscription 字段会直接返回 Null 或抛出 NotSupportedException,前端连连接都建不起来。

必须显式启用 WebSocket 中间件,且顺序不能错:

  • app.UseWebSockets() 要放在 UseRouting() 之后、UseEndpoints() 之前
  • endpoints.MapGraphQL() 本身不自动开启 WebSocket —— 它只响应 POST /graphql,而 subscription 走的是 GET /graphql 升级为 WebSocket
  • 若用了反向代理(如 Nginx),需额外配置 proxy_http_version 1.1 和 Upgrade $http_upgrade,否则握手失败,浏览器控制台报 WebSocket connection to 'ws://...' failed

定义订阅类型时别漏掉 EventStream<t></t>

HotChocolate v12+ 强制要求订阅 resolver 返回 IAsyncEnumerable<t></t> 或 EventStream<t></t>。直接 return 一个普通对象、Task<t></t> 或 IObservable<t></t> 都会静默失败——字段不报错,但客户端收不到任何数据。

典型写法是:

public async IAsyncEnumerable<messagetype> OnMessageReceived(
    [Service] IMessagePublisher publisher,
    [EnumeratorCancellation] CancellationToken ct)
{
    await foreach (var msg in publisher.Listen(ct))
    {
        yield return msg;
    }
}</messagetype>

注意点:

  • [EnumeratorCancellation] 是必须的,否则客户端断连时 CancellationToken 不触发,后台任务持续占用资源
  • 不要在 resolver 里 new ChannelReader 或手动管理 Task.Run,HotChocolate 已内置背压和生命周期绑定
  • 如果用 EventStream<t></t>,需注册 AddEventStreaming(),否则运行时报 Unable to resolve service for type 'IEventStream'...

客户端发 subscription 请求前得先确认协议支持

HotChocolate 默认只接受 graphql-ws 协议(Apollo Server 旧版),不兼容 graphql-transport-ws(Apollo Client 3.8+ 默认)。你看到前端报 connection_init timeout 或后端日志出现 Unknown protocol: graphql-transport-ws,基本就是这个原因。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

解决方式只有两个:

  • 客户端降级:Apollo Client 配 graphqlWs 协议(需装 @graphql-ws/client)
  • 服务端升级:HotChocolate v13+ 支持双协议,但需显式调用 AddWebSocketTransports().AddApolloFederation() 并启用 EnableWebSocketTransport()
  • 别信文档里“自动适配”的说法——v12.16.1 及以前版本对 graphql-transport-ws 的支持是实验性的,连 complete 消息都可能丢

调试订阅卡住时优先查 ExecutionResult 的 Errors 字段

订阅 resolver 抛异常不会像 query/mutation 那样返回标准 GraphQL 错误体。它常表现为客户端无响应、连接秒断、或收到空的 next 帧。真正的问题藏在服务器端的 ExecutionResult.Errors 里,但默认不打印到日志。

建议加一层诊断 wrapper:

services.AddGraphQLServer()
    .AddQueryType<query>()
    .AddMutationType<mutation>()
    .AddSubscriptionType<subscription>()
    .AddErrorFilter(_ => null) // 先清空默认过滤器
    .AddDiagnosticEventListener(sp => new SubscriptionErrorLogger(sp.GetRequiredService<ilogger>>()));</ilogger></subscription></mutation></query>

其中 SubscriptionErrorLogger 要监听 OnSubscriptionExecutionError 事件,否则你永远不知道 publisher.Listen() 里 throw 了个 NullReferenceException。

另外,EventStream 内部异常不会传播到 resolver 外层,所以 try/catch 包不住——必须靠 HotChocolate 的诊断事件捞。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2769

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2148

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1140

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1078

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1296

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1998

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3060

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

13455

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Conan 2 Essentials 免费课程
Conan 2 Essentials 免费课程

共0课时 | 0人学习

CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 高级依赖模型介绍
Conan 2 高级依赖模型介绍

共0课时 | 0人学习