变更(Mutations)
大多数关于 GraphQL 的讨论都集中在数据获取上,但任何完整的数据平台都需要一种修改服务端数据的方法。在 REST 中,任何请求都可能在服务器上产生副作用,但最佳实践建议我们不应在 GET 请求中修改数据。GraphQL 也类似——从技术上讲,任何查询都可以实现为导致数据写入。然而,与 REST 一样,建议遵循这样的约定:任何导致写入的操作都应该通过变更(mutation)显式发送(更多信息请参阅此处)。
官方 Apollo 文档使用了一个 upvotePost() 变更示例。该变更实现了一个增加帖子 votes 属性值的方法。要在 Nest 中创建等效的变更,我们将使用 @Mutation() 装饰器。
代码优先
让我们向上一节中使用的 AuthorResolver 添加另一个方法(参见解析器)。
@Mutation(() => Post)
async upvotePost(@Args({ name: 'postId', type: () => Int }) postId: number) {
return this.postsService.upvoteById({ id: postId });
}提示
所有装饰器(例如 @Resolver、@ResolveField、@Args 等)都从 @nestjs/graphql 包导出。
这将在 SDL 中生成以下 GraphQL schema 部分:
type Mutation {
upvotePost(postId: Int!): Post
}upvotePost() 方法接受 postId(Int)作为参数,并返回更新后的 Post 实体。出于解析器章节中解释的原因,我们必须显式设置期望的类型。
如果变更需要将对象作为参数,我们可以创建一个输入类型。输入类型是一种特殊的对象类型,可以作为参数传入(更多信息请参阅此处)。要声明输入类型,请使用 @InputType() 装饰器。
import { InputType, Field } from '@nestjs/graphql';
@InputType()
export class UpvotePostInput {
@Field()
postId: number;
}提示
@InputType() 装饰器接受一个选项对象作为参数,因此你可以指定输入类型的描述等。请注意,由于 TypeScript 的元数据反射系统限制,你必须使用 @Field 装饰器手动指示类型,或者使用 CLI 插件。
然后我们可以在解析器类中使用此类型:
@Mutation(() => Post)
async upvotePost(
@Args('upvotePostData') upvotePostData: UpvotePostInput,
) {}Schema 优先
让我们扩展上一节中使用的 AuthorResolver(参见解析器)。
@Mutation()
async upvotePost(@Args('postId') postId: number) {
return this.postsService.upvoteById({ id: postId });
}请注意,我们在上面假设业务逻辑已移至 PostsService(查询帖子并增加其 votes 属性)。PostsService 类中的逻辑可以根据需要简单或复杂。此示例的重点是展示解析器如何与其他提供者交互。
最后一步是将我们的变更添加到现有的类型定义中。
type Author {
id: Int!
firstName: String
lastName: String
posts: [Post]
}
type Post {
id: Int!
title: String
votes: Int
}
type Query {
author(id: Int!): Author
}
type Mutation {
upvotePost(postId: Int!): Post
}upvotePost(postId: Int!): Post 变更现在可以作为应用程序 GraphQL API 的一部分被调用。