
本文旨在解决在graphql中使用嵌套突变(nested mutation)同时创建主实体及其关联实体时,因输入结构不匹配而导致的“字段未提供”错误。我们将深入探讨graphql输入类型定义与prisma等orm的内部嵌套写入机制之间的差异,并提供正确的graphql客户端突变输入示例,以确保数据能够成功创建。
理解GraphQL嵌套突变与输入类型
在构建API时,我们经常需要在一个操作中同时创建或更新多个相互关联的实体。例如,在用户注册时,可能需要同时创建用户(User)及其个人资料(Profile)。GraphQL通过嵌套突变(Nested Mutation)提供了实现这一目标的强大机制。然而,正确构造GraphQL的输入数据是关键。
假设我们有一个User模型和一个Profile模型,它们之间存在一对一的关系。我们希望通过一个signUp突变同时创建用户及其资料。
GraphQL Schema 定义:
首先,我们来看一下相关的GraphQL输入类型定义:
input addUserInput { firstName: String! middleName: String lastName: String username: String! email: String roleId: String! password: String profile: addProfileInput # 注意这里:profile字段直接期望 addProfileInput 类型}input addProfileInput { addressOne: String! addressTwo: String! zip: String! dob: String!}type Mutation { signUp(input: addUserInput!): AuthPayload}type AuthPayload { id: ID! firstName: String lastName: String profile: Profile}type Profile { id: ID! addressOne: String addressTwo: String zip: String dob: String}
从addUserInput的定义中可以看到,profile字段的类型是addProfileInput。这意味着当客户端发送addUserInput时,profile字段的值应该直接是一个符合addProfileInput结构的对象。
解析“字段未提供”错误
当客户端尝试执行如下GraphQL突变时:
mutation { addUser( input: { firstName: "Jane" lastName: "Doe" roleId: "bfb3d29a-379e-4558-b2fd-af98b666c100" username: "jdoe" email: "jdoe@example.com" password: "1234567890" profile: { create: { # 这里的 'create' 是导致问题的原因 addressOne: "Runda, Kenya" addressTwo: "Murang'a, Kenya" dob: "12-12-1990" zip: "22333-00100" } } } ) { id firstName lastName profile { id dob } } }
会收到类似”message”: “Field “addProfileInput.addressOne” of required type “String!” was not provided.”的错误。这个错误提示表明addProfileInput中的addressOne字段没有被提供。
错误根源:问题在于GraphQL客户端发送的突变结构与GraphQL Schema中addUserInput的定义不匹配。Schema中明确指出profile字段直接期望一个addProfileInput类型的对象,而客户端却在profile字段下额外嵌套了一个create对象,然后才将addProfileInput的实际数据放入create中。
从GraphQL服务器的角度来看,当它解析profile: { create: { … } }时,它期望profile字段的值直接包含addressOne等字段,但它看到的是一个包含create字段的对象。因此,它无法在预期位置找到addProfileInput所需的必填字段,从而抛出错误。
后端Resolver中的Prisma嵌套写入
值得注意的是,在后端Resolver中使用Prisma等ORM进行数据操作时,嵌套写入的语法是不同的。例如,使用Prisma创建用户并同时创建其资料的Resolver代码可能如下:
signUp: async (_, { input }) => { const password = await hash(input.password, 10); // 假设 hash 是一个密码哈希函数 const newUser = await prisma.user.create({ data: { firstName: input.firstName, middleName: input.middleName, lastName: input.lastName, roleId: input.roleId, username: input.username, email: input.email, password, profile: { create: { // 这里 Prisma 期望 'create' 关键字来表示嵌套创建 addressOne: input.profile.addressOne, // 注意这里是从 input.profile 中获取数据 addressTwo: input.profile.addressTwo, zip: input.profile.zip, dob: input.profile.dob, }, }, }, include: { profile: { select: { dob: true, }, }, }, }); return newUser;},
在这个Resolver中,profile: { create: { … } }是Prisma用来执行嵌套创建的正确语法。Resolver会从input.profile中提取addressOne、addressTwo等字段,并将它们传递给Prisma的create操作。
关键区分:
GraphQL Schema/客户端突变: 遵循GraphQL输入类型定义,profile字段直接接收addProfileInput对象。Prisma Resolver内部: 使用Prisma的特定语法profile: { create: { … } }来指示数据库执行嵌套创建。
这两者是不同层次的概念,不能混淆。GraphQL客户端发送的数据结构必须严格匹配GraphQL Schema的定义,而Prisma的create关键字是Resolver内部处理数据时使用的ORM指令。
正确的GraphQL客户端突变输入
要解决上述错误,客户端的GraphQL突变应该移除profile字段下的额外create层级,直接提供addProfileInput的数据:
mutation { addUser( input: { firstName: "Jane" lastName: "Doe" roleId: "bfb3d29a-379e-4558-b2fd-af98b666c100" username: "jdoe" email: "jdoe@example.com" password: "1234567890" profile: { # 直接提供 addProfileInput 的数据 addressOne: "Runda, Kenya" addressTwo: "Murang'a, Kenya" dob: "12-12-1990" zip: "22333-00100" } } ) { id firstName lastName profile { id dob } } }
通过这种方式,客户端发送的数据结构将完全符合addUserInput的Schema定义,profile字段直接接收addProfileInput对象,从而使GraphQL服务器能够正确解析输入,并将数据传递给Resolver。Resolver再根据input.profile中的数据,利用Prisma的create语法执行嵌套写入。
总结与注意事项
严格匹配Schema: GraphQL客户端发送的突变输入数据结构必须严格遵循GraphQL Schema中定义的输入类型。任何额外的嵌套层级(如本例中的create)都可能导致“字段未提供”的错误。区分概念: 明确区分GraphQL输入类型定义与后端ORM(如Prisma)的内部嵌套写入语法。它们服务于不同的目的和层次。Resolver数据访问: 在Resolver中,当GraphQL输入类型定义为profile: addProfileInput时,嵌套数据将直接通过input.profile访问,例如input.profile.addressOne。错误排查: 当遇到“字段未提供”的错误时,首先检查客户端发送的GraphQL突变结构是否与对应的GraphQL输入类型定义完全一致。
正确理解和应用这些原则,将有助于您在GraphQL应用程序中高效、无误地处理嵌套突变操作。
以上就是GraphQL 嵌套突变中的输入结构解析与常见错误规避的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1529042.html
微信扫一扫
支付宝扫一扫