GraphQL.NET 不直接读 .graphqls 文件
GraphQL.NET 本身不提供从
.graphqls文件自动构建 Schema 的能力。它要求你用 C# 类型(
ObjectGraphType、
Field等)显式定义类型,或通过
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 可运行”。
常见错误现象: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 仍需你单独用
BindResolver或
UseNode显式绑定,否则字段返回 null 接口、联合类型、指令(directive)的支持程度取决于版本;v13+ 支持较好,但 v12 对自定义 directive 解析不稳定 加载后必须调用
Modify或
TryAdd注入 resolver,否则 schema 是“只读结构”,无法执行
复杂点在于:SDL 文件只是契约,C# 层永远要补足执行逻辑。没有哪个库能跳过这一步——文件只是起点,不是终点。
