0

0

C# GraphQL Schema文件加载 C#如何从.graphqls文件构建GraphQL服务器架构

幻夢星雲

幻夢星雲

发布时间:2026-02-20 08:05:02

|

435人浏览过

|

来源于php中文网

原创

graphql.net 不支持直接加载 .graphqls 文件,必须通过手写 c# 类型或代码生成(如 graphql-codegen)构建 schema,并显式绑定 resolver 和依赖注入。

c# graphql schema文件加载 c#如何从.graphqls文件构建graphql服务器架构

GraphQL.NET 不直接读 .graphqls 文件

GraphQL.NET 本身不提供从 .graphqls 文件自动构建 Schema 的能力。它要求你用 C# 类型(ObjectGraphTypeField 等)显式定义类型,或通过 Schema.For(已弃用)+ 字符串解析(非标准、不推荐)。所以,别指望像 Apollo Server 那样直接 loadSchema('schema.graphqls') —— 这条路在主流 C# GraphQL 库里走不通。

常见错误现象:Schema.For(File.ReadAllText("schema.graphqls")) 看似能跑,但会丢失 resolver 绑定、字段参数校验、接口实现关系,且 Schema.For 在 GraphQL.NET v7+ 中已被标记为 obsolete。

  • 真正可用的路径只有两条:手写类型类(最稳),或用工具预生成 C# 类型(需额外步骤)
  • 如果你已有成熟 .graphqls,又想复用,优先选代码生成方案,而不是硬塞字符串进 Schema.For
  • 注意兼容性:GraphQL.NET v6/v7 对 SDL 解析支持有限;v8 引入了实验性 SchemaBuilder,但仍未开放完整文件加载 API

用 graphql-codegen + C# 插件生成类型骨架

这是目前最贴近“从 .graphqls 构建架构”的可行做法:把 SDL 当输入,生成可继承/扩展的 C# 类型基类,再手动补上 resolver 和业务逻辑。

使用场景:团队已有统一 SDL 规范、前后端共用 schema 定义、需要强类型保障。

  • 安装 @graphql-codegen/cli@graphql-codegen/c-sharp 插件
  • 配置 codegen.yml 指向你的 schema.graphqls,输出目标设为 Types.cs
  • 生成结果是 public class QueryType : ObjectGraphType 这类空壳,字段默认无 resolver —— 你必须继承它并重写 Field 调用,填入真实逻辑
  • 生成的类型不包含 Resolve 实现,也不处理依赖注入绑定,这部分仍需你手写注册到 DI 容器

AddGraphQLServer() 中如何挂载自定义 Schema 实例

无论你是手写还是生成类型,最终都要构造一个 ISchema 实例,并在 ASP.NET Core 启动时交给 GraphQL.NET。关键不是“怎么读文件”,而是“怎么让这个 Schema 可运行”。

Regie.ai
Regie.ai

一个使用AI生成产品描述的网络平台

下载

常见错误现象:Schema 编译通过但查询报 Cannot query field "xxx" on type "Query" —— 很可能是 QueryType 没正确传给 Schema 构造函数,或未注册 resolver 依赖。

  • 必须显式 new Schema 并指定 Query = new MyQueryType(),不能只注册类型类而不实例化
  • resolver 中用到的服务(如 IRepository<user></user>)要提前注册到 IServiceCollection,否则 ExecutionOptions.RequestServices 拿不到
  • 如果用了 AutoRegisteringObjectGraphType 或类似反射机制,确保程序集没被 trimming(.NET 6+ 发布时默认启用),否则类型丢失导致字段为空

为什么不用 HotChocolate?它支持 .graphqls 吗?

HotChocolate 是另一个主流 C# GraphQL 库,它的 ISchema 构建方式更接近 SDL 优先:可通过 SchemaBuilder.New().AddDocumentFromFile("schema.graphqls") 加载 SDL,但——这仅完成类型结构解析,不等于“开箱即用”。

容易踩的坑:

  • AddDocumentFromFile 只建模类型和字段,所有 resolver 仍需你单独用 BindResolverUseNode 显式绑定,否则字段返回 null
  • 接口、联合类型、指令(directive)的支持程度取决于版本;v13+ 支持较好,但 v12 对自定义 directive 解析不稳定
  • 加载后必须调用 ModifyTryAdd 注入 resolver,否则 schema 是“只读结构”,无法执行

复杂点在于:SDL 文件只是契约,C# 层永远要补足执行逻辑。没有哪个库能跳过这一步——文件只是起点,不是终点。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

22

2026.01.21

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

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

246

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

806

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

594

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

217

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1555

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

965

2024.03.22

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

660

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 9.8万人学习

C 教程
C 教程

共75课时 | 4.8万人学习

C++教程
C++教程

共115课时 | 18.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号