SpringBoot开发秘籍之集成Graphql Query

2023-5-17

[[394594]]

概述

REST作为一种现代网络应用非常流行的软件架构风格受到广大WEB开发者的喜爱，在目前软件架构设计模式中随处可见REST的身影，但是随着REST的流行与发展，它的一个最大的缺点开始暴露出来：

在很多时候客户端需要的数据往往在不同的地方具有相似性，但却又不尽相同。

如同样的用户信息，在有的场景下前端只需要用户的简要信息(名称、头像)，在其他场景下又需要用户的详细信息。当这样的相似但又不同的地方多的时候，就需要开发更多的接口来满足前端的需要。

随着这样的场景越来越多，接口越来越多，文档越来越臃肿，前后端沟通成本呈指数增加。

基于上面的场景，我们迫切需要有一种解决方案或框架，可以使得在使用同一个领域模型(DO、DTO)的数据接口时可以由前端指定需要的接口字段，而后端根据前端的需求自动适配并返回对应的字段。

这就是我们今天的主角GraphQL。

场景模拟

考虑下面的场景：

用户 与 文章 是一对多的关系，一个用户可以发表多篇文章，同时又可以根据文章找到对应的作者。

我们需要构建以下几个Graphql查询：

  • 根据用户ID获取用户详情，并获取此用户发表的所有文章
  • 根据文章ID获取文章详情，并获取文章作者的信息

当然项目是基于SpringBoot开发的。

开发实战

在正式开发之前我推荐你在IDEA上安装一下 JS GraphQL插件，这个插件方便我们编写Schema，语法纠错，代码高亮等等。。。

创建一个SpringBoot项目

通过IDEA创建一个SpringBoot项目，并引入对应的jar

 
 
 
 
    
  
  
  
  
  1. <dependencies> 
    2. 
  
  
  
  
  2.  <dependency> 
    3. 
  
  
  
  
  3.   <groupId>org.springframework.boot</groupId> 
    4. 
  
  
  
  
  4.   <artifactId>spring-boot-starter</artifactId> 
    5. 
  
  
  
  
  5.  </dependency> 
    6. 
  
  
  
  
  6.  
    7. 
  
  
  
  
  7.  <dependency> 
    8. 
  
  
  
  
  8.   <groupId>org.springframework.boot</groupId> 
    9. 
  
  
  
  
  9.   <artifactId>spring-boot-starter-web</artifactId> 
    10. 
  
  
  
  
  10.  </dependency> 
    11. 
  
  
  
  
  11.  
    12. 
  
  
  
  
  12.  <!--graphql start--> 
    13. 
  
  
  
  
  13.  <dependency> 
    14. 
  
  
  
  
  14.   <groupId>com.graphql-java</groupId> 
    15. 
  
  
  
  
  15.   <artifactId>graphql-spring-boot-starter</artifactId> 
    16. 
  
  
  
  
  16.   <version>5.0.2</version> 
    17. 
  
  
  
  
  17.  </dependency> 
    18. 
  
  
  
  
  18.  <dependency> 
    19. 
  
  
  
  
  19.   <groupId>com.graphql-java</groupId> 
    20. 
  
  
  
  
  20.   <artifactId>graphql-java-tools</artifactId> 
    21. 
  
  
  
  
  21.   <version>5.2.4</version> 
    22. 
  
  
  
  
  22.  </dependency> 
    23. 
  
  
  
  
  23.  <!--graphql end--> 
    24. 
  
  
  
  
  24.  
    25. 
  
  
  
  
  25.  <dependency> 
    26. 
  
  
  
  
  26.   <groupId>org.projectlombok</groupId> 
    27. 
  
  
  
  
  27.   <artifactId>lombok</artifactId> 
    28. 
  
  
  
  
  28.  </dependency> 
    29. 
  
  
  
  
  29. </dependencies> 
    30.

 

 

这里主要需要引入 graphql-spring-boot-starter和 graphql-java-tools。

建立Java实体类

User

 
 
 
 
    
  
  
  
  
  1. @Data 
    2. 
  
  
  
  
  2. public class User { 
    3. 
  
  
  
  
  3.     private int userId; 
    4. 
  
  
  
  
  4.     private String userName; 
    5. 
  
  
  
  
  5.     private String realName; 
    6. 
  
  
  
  
  6.     private String email; 
    7. 
  
  
  
  
  7.     private List<Post> posts; 
    8. 
  
  
  
  
  8.  
    9. 
  
  
  
  
  9.     public User() { 
    10. 
  
  
  
  
  10.     } 
    11. 
  
  
  
  
  11.  
    12. 
  
  
  
  
  12.     public User(int userId, String userName, String realName, String email) { 
    13. 
  
  
  
  
  13.         this.userId = userId; 
    14. 
  
  
  
  
  14.         this.userName = userName; 
    15. 
  
  
  
  
  15.         this.realName = realName; 
    16. 
  
  
  
  
  16.         this.email = email; 
    17. 
  
  
  
  
  17.     } 
    18. 
  
  
  
  
  18. } 
    19.

Post

 
 
 
 
    
  
  
  
  
  1. @Data 
    2. 
  
  
  
  
  2. public class Post { 
    3. 
  
  
  
  
  3.     private int postId; 
    4. 
  
  
  
  
  4.     private String title ; 
    5. 
  
  
  
  
  5.     private String text; 
    6. 
  
  
  
  
  6.     private String  category; 
    7. 
  
  
  
  
  7.     private User user; 
    8. 
  
  
  
  
  8.  
    9. 
  
  
  
  
  9.     public Post() { 
    10. 
  
  
  
  
  10.  
    11. 
  
  
  
  
  11.     } 
    12. 
  
  
  
  
  12.  
    13. 
  
  
  
  
  13.     public Post(int postId, String title, String text, String category) { 
    14. 
  
  
  
  
  14.         this.postId = postId; 
    15. 
  
  
  
  
  15.         this.title = title; 
    16. 
  
  
  
  
  16.         this.text = text; 
    17. 
  
  
  
  
  17.         this.category = category; 
    18. 
  
  
  
  
  18.     } 
    19. 
  
  
  
  
  19.  
    20. 
  
  
  
  
  20. } 
    21.

定义了两个JAVA实体：Post，User。

编写Schema文件

在resources/schema目录下创建GraphQL Schema文件

 
 
 
 
    
  
  
  
  
  1. schema { 
    2. 
  
  
  
  
  2.     query: Query, 
    3. 
  
  
  
  
  3. } 
    4. 
  
  
  
  
  4.  
    5. 
  
  
  
  
  5. type Query { 
    6. 
  
  
  
  
  6.     # 获取具体的用户 
    7. 
  
  
  
  
  7.     getUserById(id:Int) : User 
    8. 
  
  
  
  
  8.     # 获取具体的博客 
    9. 
  
  
  
  
  9.     getPostById(id:Int) : Post 
    10. 
  
  
  
  
  10. } 
    11. 
  
  
  
  
  11.  
    12. 
  
  
  
  
  12. type User { 
    13. 
  
  
  
  
  13.     userId : ID!, 
    14. 
  
  
  
  
  14.     userName : String, 
    15. 
  
  
  
  
  15.     realName : String, 
    16. 
  
  
  
  
  16.     email : String, 
    17. 
  
  
  
  
  17.     posts : [Post], 
    18. 
  
  
  
  
  18. } 
    19. 
  
  
  
  
  19.  
    20. 
  
  
  
  
  20. type Post { 
    21. 
  
  
  
  
  21.     postId : ID!, 
    22. 
  
  
  
  
  22.     title : String!, 
    23. 
  
  
  
  
  23.     text : String, 
    24. 
  
  
  
  
  24.     category: String 
    25. 
  
  
  
  
  25.     user: User, 
    26. 
  
  
  
  
  26. } 
    27.

如上，我们通过 type关键字定义了两个对象，User与Post。在属性后面添加!表明这是一个非空属性，通过[Post]表明这是一个Post集合，类似于Java对象中List。

通过Query关键字定义了两个查询对象，getUserById，getPostById，分别返回User对象和Post对象。

关于schema的语法大家可以

版权声明：
作者：后浪云
链接：https://www.idc.net/help/339448/
文章版权归作者所有，未经允许请勿转载。
THE END
Copyright © 2025 后浪云 网站地图