Spring Boot GraphQL 实战 02_增删改查和自定义标量

Spring Boot GraphQL 实战系列第二篇,使用 GraphQL 实现增删改查。

hello,大叫好,我是小黑,又和大家见面啦~

今天我们来继续学习 Spring Boot GraphQL 实战,我们使用的框架是 https://github.com/graphql-java-kickstart/graphql-spring-boot

项目 github 地址:https://github.com/shenjianeng/graphql-spring-boot-example

Query(查询)

带参数的查询

首先,在 classpath 下创建 graphqls 文件:

type Book{ id:ID! name:String!}type Query{ # 根据 id 查询 book,参数名为 id,参数类型的 ID 类型,结果返回 book getBookById(id:ID!):Book}

创建一个 Spring Bean,此处需要实现 GraphQLQueryResolver 接口,并在该类中自定义一个方法来映射 graphqls 文件中的查询。

@Datapublic class Book { private int id; private String name;}@Componentpublic class BookGraphQLQueryResolver implements GraphQLQueryResolver { public Book getBookById(int id) {  Book book = new Book();  book.setId(id);  book.setName("这边书没有书名");  return book; }}

复合字段查询

需求:每本书都有作者,在查询书本信息时,有时需要返回作者信息。

# 定义 Author 数据类型结构type Author{ id:ID! name:String!}type Book{ id:ID! name:String! # 增加 author 字段,数据类型为 Author author:Author}type Query{ # 根据 id 查询 book,参数名为 id,参数类型的 ID 类型,结果返回 book getBookById(id:ID!):Book}

再看一下此时我们的 Java Bean:

@Datapublic class Author { private UUID id; private String name;}@Datapublic class Book { private long id; private String name;}

看仔细哦,Book 类中并没有 author 字段,Book 中 author 信息将由 graphql.kickstart.tools.GraphQLResolver 来提供。

@Slf4j@Componentpublic class BookGraphQLResolver implements GraphQLResolver<Book> { public Author author(Book book) {  log.info("book id :{} query author info", book.getId());  Author author = new Author();  author.setId(UUID.randomUUID());  author.setName(String.format("我是[%s]的作者", book.getName()));  return author; }}

ok,让我们启动服务,访问 src="https://cdn.jsdelivr.net/gh/shenjianeng/pictures/2020-12-19/1608362776229-image.png" alt="同时查询book和author" loading="lazy">

而当客户端不需要 author 信息时,服务端就不会执行 BookGraphQLResolver#author,真正做到了使得客户端能够准确地获得它需要的数据,而且没有任何冗余。

(ps:如果你是服务端开发,你会怎么实现呢?是给客户端提供一个接口返回 book 和 author 信息,还是给客户端提供两个不同的接口呢?)

只查询book时

Mutation(变更)

在 graphqls 文件中,使用 Query 来定义查询接口,使用 Mutation 可以定义变更数据的操作。

type Mutation{ createBook(id:ID!,name:String!):Book}

上述 graphqls 文件中定义了一个 createBook 的方法,参数列表为 id 和 name ,方法返回创建的 Book 对象。

与之对应的 Java 代码如下:

@Componentpublic class BookGraphQLMutationResolver implements GraphQLMutationResolver { public Book createBook(int id, String name) {  Book book = new Book();  book.setId(id);  book.setName(name);  return book; }}

BookGraphQLMutationResolver 实现了 graphql.kickstart.tools.GraphQLMutationResolver 接口,表明当前类中的方法用来映射 graphqls 文件中的 Mutation。

mutation

Input Types

当 Mutation 中请求参数特别多时,我们可以使用 Input Types 来优化代码。

type Mutation{ createBook(id:ID!,name:String!):Book create(bookInput:BookInput!):Book}input BookInput{ id:ID! name:String!}

同理,我们也需求在 BookGraphQLMutationResolver 中添加对应的方法来映射。

@Componentpublic class BookGraphQLMutationResolver implements GraphQLMutationResolver {     // ...省略其他代码  public Book create(BookInput input) {  Book book = new Book();  book.setId(input.getId());  book.setName(input.getName());  return book; }}

客户端请求代码如下:

评论

暂无评论