GraphQL with Go:另一种API风格

发布时间:2026/8/16 16:03:23
GraphQL with Go:另一种API风格 # GraphQL with Go:另一种API风格摘要: 本篇从GraphQL的核心概念讲起用gqlgen搭建一个完整的GraphQL服务演示Schema定义、Resolver实现和Mutation操作分享N1查询问题及DataLoader解决方案的踩坑经历对比REST与GraphQL两种API风格的取舍。开篇故事去年我们有个移动端App首页要展示用户信息和最近订单。REST的做法是先调/users/1拿用户信息再调/users/1/orders拿订单列表两个请求串行发。移动端网络差的时候两个请求加起来要等两三秒用户看到白屏就想退出。后来产品又要在订单列表里展示每个订单关联的商品名称。REST这边只能再循环调/orders/:id/itemsN个订单N次请求。移动端同事快疯了说你们后端能不能一次把数据给全了。我当时想直接加个聚合接口/users/:id/home把用户和订单和商品全查出来打包返回。但这接口只适合首页换个场景又要写新接口。后来越来越多场景要聚合聚合接口膨胀到了二十多个。后来我研究了GraphQL发现它天然解决这个问题。客户端需要什么字段就查什么字段一次请求拿全所有关联数据。今天就聊聊在Go里怎么用GraphQL。一、GraphQL核心概念GraphQL用Schema定义数据类型和查询入口。客户端发一个查询语句服务端解析后只返回客户端请求的字段。# 客户端只需要用户名, 就只返回用户名 query { user(id: 1) { name } } # 需要用户名和订单, 一个请求搞定 query { user(id: 1) { name orders { id amount items { name } } } }同一个接口不同客户端按需取字段。移动端取精简数据管理后台取完整数据后端只维护一个Resolver。二、用gqlgen搭建GraphQL服务Go生态里gqlgen是最主流的GraphQL库基于Schema先行的理念先写Schema再生成代码骨架。# 安装gqlgengoinstallgithub.com/99designs/gqlgenlatest# 初始化项目go mod init myapp gqlgen init先写Schema定义数据类型和查询。# schema.graphql 定义类型和查询入口 # 用户类型 type User { id: ID! name: String! email: String! orders: [Order!]! # 用户的订单列表 } # 订单类型 type Order { id: ID! amount: Float! items: [Item!]! # 订单里的商品 } # 商品类型 type Item { id: ID! name: String! price: Float! } # 查询入口 type Query { user(id: ID!): User users: [User!]! } # 变更入口 type Mutation { createUser(name: String!, email: String!): User! }执行gqlgen generate后它会根据Schema生成Go的struct定义和Resolver接口。你只需要实现接口方法。三、实现Resolvergqlgen生成的Resolver接口是你要实现的核心。每个Schema里的字段都有一个对应的Resolver方法。packagegraphimport(contextmyapp/graph/model)// Resolver 根Resolver, 持有依赖typeResolverstruct{userStore*UserStore// 用户数据源orderStore*OrderStore// 订单数据源}// User 返回UserResolver, 处理User类型的字段解析func(r*Resolver)User()UserResolver{returnuserResolver{r}}// Query Query入口的Resolverfunc(r*Resolver)Query()QueryResolver{returnqueryResolver{r}}// Mutation Mutation入口的Resolverfunc(r*Resolver)Mutation()MutationResolver{returnmutationResolver{r}}typequeryResolverstruct{*Resolver}// User 根据ID查用户// ctx是请求上下文, id是参数func(q*queryResolver)User(ctx context.Context,idstring)(*model.User,error){// 从数据源查用户user,err:q.userStore.GetByID(ctx,id)// 查数据库iferr!nil{returnnil,err// 返回错误给GraphQL}returnuser,nil// 返回用户对象}typeuserResolverstruct{*Resolver}// Orders 解析User的orders字段// 只有客户端请求了orders字段时才会调用这个方法func(u*userResolver)Orders(ctx context.Context,obj*model.User)([]*model.Order,error){// 根据用户ID查订单列表orders,err:u.orderStore.GetByUserID(ctx,obj.ID)// 按用户ID查iferr!nil{returnnil,err}returnorders,nil// 返回订单列表}typemutationResolverstruct{*Resolver}// CreateUser 创建用户func(m*mutationResolver)CreateUser(ctx context.Context,namestring,emailstring)(*model.User,error){user:model.User{Name:name,Email:email}// 构造用户对象iferr:m.userStore.Create(ctx,user);err!nil{// 写入数据库returnnil,err}returnuser,nil// 返回新用户}gqlgen的核心设计是按字段懒加载。客户端请求user(id:1){name}时只调用Query.User方法不会调用userResolver.Orders。客户端请求了orders字段时才查订单查了订单又请求了items才查商品。这种设计避免了多余的数据查询。四、独家踩坑:N1查询问题说一个GraphQL最经典的坑。上面那个Resolver看起来没问题但压测时数据库连接被打满了。问题是这样的。有个查询要获取10个用户每个用户再查订单。query { users { name orders { amount } } }。执行的SQL是这样的。SELECT * FROM users; -- 1次查询拿10个用户 SELECT * FROM orders WHERE user_id 1; -- 每个用户1次查询 SELECT * FROM orders WHERE user_id 2; ...总共10个用户就是10次查询 -- 1 10 11次SQL, 这就是N1问题数据量大了数据库扛不住。REST接口也有这个问题但GraphQL的嵌套查询让N1更容易发生因为每层嵌套都可能触发新的查询。解决方案是用DataLoader。它把同层级的查询合并成批量查询。importgithub.com/graph-gophers/dataloader/v7// OrderLoader 批量加载订单的DataLoadertypeOrderLoaderstruct{store*OrderStore// 订单数据源}// BatchGetOrders 批量查询, 一次SQL查多个用户的订单func(l*OrderLoader)BatchGetOrders(ctx context.Context,userIDs[]string)[]*dataloader.Result[[]*model.Order]{// 一次SQL查出所有用户的订单orders,_:l.store.GetByUserIDs(ctx,userIDs)// 批量查询// 按userID分组返回结果results:make([]*dataloader.Result[[]*model.Order],len(userIDs))// 结果切片fori,uid:rangeuserIDs{results[i]dataloader.Result[[]*model.Order]{Data:orders[uid]}// 按用户分组}returnresults// 返回每个用户对应的订单}// 在Resolver中使用DataLoaderfunc(u*userResolver)Orders(ctx context.Context,obj*model.User)([]*model.Order,error){// 从context取出DataLoader实例loader:ctx.Value(orderLoader).(*dataloader.Loader[string,[]*model.Order])// Load会自动批量合并同层级的查询thunk:loader.Load(ctx,obj.ID)// 延迟加载orders,err:thunk()// 实际执行批量查询iferr!nil{returnnil,err// 错误处理}returnorders,nil// 返回订单}DataLoader在同一个事件循环tick内收集所有Load调用然后用一个批量查询一次性取回所有数据。10个用户的订单从11次SQL降到2次一次查用户一次批量查订单。这个坑我踩了挺久才定位。症状是QPS上不去数据库CPU飙高。开了GORM的Debug日志看SQL发现同一个请求里同一条SELECT语句被反复执行。接上DataLoader后SQL数量大幅下降QPS直接翻倍。五、对比分析与总结维度RESTGraphQL取数据固定字段多次请求按需取字段一次请求过取数据常见接口返回固定字段少见客户端指定字段欠取数据常见要发多次请求少见一次查全缓存HTTP缓存天然支持缓存复杂靠客户端缓存学习成本低CRUD直觉高Schema和ResolverN1问题可控需要DataLoader兜底GraphQL在数据聚合场景下优势明显一个请求拿全所有关联数据移动端友好。但它的复杂度也高Schema设计、N1优化、缓存策略都是要趟的坑。REST在简单CRUD场景下仍然是最直接的方案。我的建议是看场景选。移动端App、多端复用API、数据聚合多的项目GraphQL值得上。内部管理系统、简单CRUD服务REST够用。两者不冲突可以共存GraphQL做聚合层REST做底层服务。模块三的API开发篇到这里就结束了。从Gin路由到中间件从版本控制到文档生成从验证错误处理到CORS安全最后到GraphQL你已经具备搭建生产级API服务的完整能力。后续模块会进入数据库和缓存的话题。