讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

AniShort
AniShort

AI短剧协同制作平台

立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

C# GraphQL集成方法 C#如何使用HotChocolate构建GraphQL服务

落瑶大大_8182

落瑶大大_8182

发布时间:2026-02-28 10:51:52

|

141人浏览过

|

来源于php中文网

原创

HotChocolate服务注册必须在ConfigureServices中完成,且AddGraphQLServer()需在AddControllers()之前调用;Query类型须为public并暴露public属性或标记[GraphQLName];ID参数必须用[ID]标记;端点需通过UseGraphQL中间件启用;自定义标量类型须完整实现ParseResult和Serialize。

c# graphql集成方法 c#如何使用hotchocolate构建graphql服务

HotChocolate服务注册必须在ConfigureServices中完成

不注册IServiceCollection就调用AddGraphQLServer()会导致运行时抛出InvalidOperationException: No service for type 'HotChocolate.IRequestExecutorResolver' has been registered。这是最常见的启动失败原因。

正确做法是:在Program.cs(.NET 6+)或Startup.ConfigureServices中显式添加服务:

services
    .AddGraphQLServer()
    .AddQueryType<Query>()
    .AddMutationType<Mutation>();
  • 必须在AddControllers()之前注册,否则控制器路由会覆盖GraphQL端点
  • 若使用Entity Framework Core,需先注册AddDbContext<appdbcontext>()</appdbcontext>,再注册GraphQL——类型发现依赖已注册的上下文
  • 不要在Configure里调用AddGraphQLServer,它不是中间件配置方法

Query类型必须公开且含public字段/属性或[GraphQLName]标记

HotChocolate默认只暴露public实例成员。若定义了private字段、internal属性,或未加[GraphQLName]的public方法,它们不会出现在Schema中,前端查询会报Cannot query field "xxx" on type "Query"。

示例错误写法:

public class Query
{
    private string _name = "test"; // 不可见
    internal int Count => 42;     // 不可见
    public string GetName() => _name; // 方法名驼峰转小写后为"getname",非标准命名
}

应改为:

public class Query
{
    [GraphQLName("name")]
    public string Name => "test";

    public int Count { get; } = 42;

    public User GetUser([ID] string id) => new User { Id = id };
}
  • 属性优先于方法;方法需返回值且无参数(或仅接受IResolverContext)才被自动识别
  • ID参数必须用[ID]特性标记,否则解析失败并报Unable to infer GraphQL type
  • 返回IEnumerable<t></t>或IQueryable<t></t>时,HotChocolate会自动推导为[T!],但IQueryable需配合AddProjections()启用服务端投影

GraphQL端点路径默认是/graphql,但需手动映射中间件

仅注册服务不等于端点可用。若没在Configure中调用UseGraphQL,访问/graphql会返回404。

C#
C#

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

下载

正确中间件顺序(.NET 6+ Program.cs):

app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
app.UseWebSockets();
app.UseGraphQL("/graphql"); // 必须在UseRouting之后、UseEndpoints之前
app.UseGraphQLPlayground(); // 可选,仅开发环境
app.UseEndpoints(endpoints => endpoints.MapControllers());
  • UseGraphQL必须放在UseRouting之后,否则HttpContext.Request.RouteValues为空导致解析异常
  • 若同时启用UseGraphQLPlayground和UseGraphQLAltair,确保只启用一个,避免静态资源冲突
  • 生产环境建议禁用Playground,通过env.IsDevelopment()控制是否注册

自定义标量类型需全局注册且实现IValueNodeConverter

比如想支持DateOnly作为输入/输出类型,直接返回DateOnly会触发Unable to infer GraphQL type。HotChocolate不内置DateOnly映射。

解决路径:

  • 定义标量类型类,继承ScalarType<dateonly></dateonly>并重写ParseResult/Serialize
  • 在AddGraphQLServer()链式调用中用AddType<dateonlytype>()</dateonlytype>注册
  • 或全局注册:services.AddGraphQLServer().AddScalarType<dateonlytype>()</dateonlytype>

关键点:若只注册类型但没重写Serialize,JSON序列化仍走默认DateTime逻辑,导致格式错乱;若漏掉ParseResult,客户端传"2023-01-01"会解析失败。

这个环节最容易被跳过——开发者常以为“加了AddType就完事”,结果在变量传入时卡在解析层,错误信息却只显示模糊的Variable '$date' has invalid value。

热门AI工具

更多
花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

更多
Python GraphQL API 开发实战
Python GraphQL API 开发实战

本专题系统讲解 Python 在 GraphQL API 开发中的实际应用,涵盖 GraphQL 基础概念、Schema 设计、Query 与 Mutation 实现、权限控制、分页与性能优化,以及与现有 REST 服务和数据库的整合方式。通过完整示例,帮助学习者掌握 使用 Python 构建高扩展性、前后端协作友好的 GraphQL 接口服务,适用于中大型应用与复杂数据查询场景。

249

2026.01.21

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

709

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

664

2025.12.18

ThinkPHP中间件机制与请求拦截处理实践
ThinkPHP中间件机制与请求拦截处理实践

本专题围绕 ThinkPHP 中间件体系展开,深入讲解中间件的定义、注册与执行流程。内容包括全局中间件与路由中间件的区别、请求前后处理逻辑、自定义中间件开发以及权限验证与日志处理应用。通过实际案例,帮助开发者掌握中间件在项目中的核心作用与最佳实践。

458

2026.03.31

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2295

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3722

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1236

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

4319

2025.09.10

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

40

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn