Spring GraphQL注解模式下schema.grapqls文件创建的官方工作流是怎样的

官方标准设计工作流 #

Spring GraphQL 原生默认采用 Schema 优先 的设计理念，对应官方推荐的标准工作流如下：

• 首先手动编写 .graphqls 后缀的 Schema 定义文件，在文件中声明所有需要的查询、突变、自定义类型等规则
• 再基于 Schema 中定义的节点，编写对应的 @Controller 代码，通过 @QueryMapping、@MutationMapping 等注解完成业务逻辑与 Schema 节点的绑定

关于自动生成 Schema 的说明 #

目前 Spring GraphQL 官方没有提供从 Controller 注解反向自动生成 Schema 文件的原生能力。
Spring GraphQL 体系下的 Controller 相关注解本质是 Schema 映射注解，设计定位就是用来匹配已经存在的 Schema 节点，而非作为 Schema 生成的数据源，因此不能直接基于 Controller 信息生成完整的 Schema 文件。

Schema 与 Controller 一致性校验方案 #

针对你提到的手动维护两份代码容易出现拼写错误、重构不同步的问题，官方已经提供了全链路的校验能力：

• 运行时校验：项目启动阶段，Spring GraphQL 会自动扫描所有 Controller 注解，和加载完成的 Schema 做一致性匹配，如果出现字段名不匹配、参数不匹配等问题会直接启动失败，提前暴露问题
• 编译期校验：可以集成官方提供的 Spring GraphQL Maven/Gradle 插件，在代码编译阶段就执行 Schema 与 Controller 的一致性校验，不需要等到项目启动就能发现不一致问题
• 类型校验：插件同时支持 Java 业务模型与 GraphQL 自定义类型的字段匹配校验，进一步降低拼写错误的概率

如果更倾向于代码优先的开发模式，可以引入第三方扩展工具实现从代码自动生成 Schema 的能力，无需手动维护 .graphqls 文件，不过这类能力不属于 Spring GraphQL 原生支持范围。

spring-graphql 标签说明 #

目前 Stack Overflow 的 spring-graphql 标签已经正式上线，直接搜索即可使用，相关问题打上该标签会得到官方维护团队及社区开发者的跟进。

内容的提问来源于stack exchange，提问作者cgaisl