GraphQL和REST API最大的不同就是查询语句完全由客户端控制。比如说咱们有个图书管理系统,传统REST接口可能得分别调/user/{id}和/user/{id}/books两个接口,但用GraphQL只需要在请求体里写明需要哪些字段就行。下面通过具体代码来看看怎么在Java项目里实现。
先引入必要的依赖,除了基础的spring-boot-starter-web,重点要加上graphql-java和graphql-java-spring组件。注意要确认依赖版本兼容性,我用的SpringBoot 2.7.x搭配graphql-java 20.2版本:
接着定义领域对象,这里以图书和作者为例:
核心是要创建GraphQL Schema,这部分在resources目录下新建schema.graphqls文件:
然后实现数据解析器,这里用内存数据演示:
启动应用后通过访问,在GraphiQL界面测试这个查询:
返回结果正好只包含请求的字段:
实际开发中可能会遇到N+1查询问题。比如当查询图书列表时,如果每本书都要单独查询作者信息,就会产生多次数据库查询。这时候可以用DataLoader来批量加载:
在Resolver中通过DataLoader注册:
最后说说踩坑记录。首先是错误处理,GraphQL默认无论部分成功还是失败都会返回200状态码,需要在配置中开启包括错误详细信息的选项。另外字段命名建议统一使用驼峰命名,避免序列化时出现意外问题。对于分页查询,虽然GraphQL没有内置方案,但可以借鉴Relay风格的连接查询模式,定义PageInfo类型包含分页元数据。
整体体验下来,GraphQL特别适合字段需求多变的业务场景。比如我们有个图书详情页,移动端和网页端需要的字段差异很大,现在只需要各取所需就行。不过也要注意控制查询深度,避免出现性能黑洞。建议在生产环境配置查询复杂度限制和查询深度限制,防止恶意复杂查询拖垮服务。