SpringBoot集成Graphql Query實戰(zhàn)示例
概述
REST作為一種現(xiàn)代網(wǎng)絡應用非常流行的軟件架構風格受到廣大WEB開發(fā)者的喜愛，在目前軟件架構設計模式中隨處可見REST的身影，但是隨著REST的流行與發(fā)展，它的一個最大的缺點開始暴露出來：
在很多時候客戶端需要的數(shù)據(jù)往往在不同的地方具有相似性，但卻又不盡相同。
如同樣的用戶信息，在有的場景下前端只需要用戶的簡要信息（名稱、頭像），在其他場景下又需要用戶的詳細信息。當這樣的相似但又不同的地方多的時候，就需要開發(fā)更多的接口來滿足前端的需要。
隨著這樣的場景越來越多，接口越來越多，文檔越來越臃腫，前后端溝通成本呈指數(shù)增加。
基于上面的場景，我們迫切需要有一種解決方案或框架，可以使得在使用同一個領域模型（DO、DTO）的數(shù)據(jù)接口時可以由前端指定需要的接口字段，而后端根據(jù)前端的需求自動適配并返回對應的字段。
這就是我們今天的主角GraphQL。
場景模擬
考慮下面的場景：
用戶 與 文章 是一對多的關系，一個用戶可以發(fā)表多篇文章，同時又可以根據(jù)文章找到對應的作者。
我們需要構建以下幾個Graphql查詢：
- 根據(jù)用戶ID獲取用戶詳情，并獲取此用戶發(fā)表的所有文章
- 根據(jù)文章ID獲取文章詳情，并獲取文章作者的信息
當然項目是基于SpringBoot開發(fā)的。
開發(fā)實戰(zhàn)
在正式開發(fā)之前我推薦你在IDEA上安裝一下 JS GraphQL插件，這個插件方便我們編寫Schema，語法糾錯，代碼高亮等等。。。
創(chuàng)建一個SpringBoot項目
通過IDEA創(chuàng)建一個SpringBoot項目，并引入對應的jar
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--graphql start--> <dependency> <groupId>com.graphql-java</groupId> <artifactId>graphql-spring-boot-starter</artifactId> <version>5.0.2</version> </dependency> <dependency> <groupId>com.graphql-java</groupId> <artifactId>graphql-java-tools</artifactId> <version>5.2.4</version> </dependency> <!--graphql end--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> </dependencies>
這里主要需要引入graphql-spring-boot-starter和graphql-java-tools。
建立Java實體類
User
@Data
public class User {
private int userId;
private String userName;
private String realName;
private String email;
private List<Post> posts;
public User() {
}
public User(int userId, String userName, String realName, String email) {
this.userId = userId;
this.userName = userName;
this.realName = realName;
this.email = email;
}
}
Post
@Data
public class Post {
private int postId;
private String title ;
private String text;
private String category;
private User user;
public Post() {
}
public Post(int postId, String title, String text, String category) {
this.postId = postId;
this.title = title;
this.text = text;
this.category = category;
}
}
定義了兩個JAVA實體：Post，User。
編寫Schema文件
在resources/schema目錄下創(chuàng)建GraphQL Schema文件
schema {
query: Query,
}
type Query {
# 獲取具體的用戶
getUserById(id:Int) : User
# 獲取具體的博客
getPostById(id:Int) : Post
}
type User {
userId : ID!,
userName : String,
realName : String,
email : String,
posts : [Post],
}
type Post {
postId : ID!,
title : String!,
text : String,
category: String
user: User,
}
如上，我們通過type關鍵字定義了兩個對象，User與Post。在屬性后面添加！表明這是一個非空屬性，通過[Post]表明這是一個Post集合，類似于Java對象中List。
通過Query關鍵字定義了兩個查詢對象，getUserById，getPostById，分別返回User對象和Post對象。
關于schema的語法大家可以參考鏈接：https://graphql.org/learn/schema/
編寫業(yè)務邏輯
PostService
@Service
public class PostService implements GraphQLQueryResolver {
/**
* 為了測試，只查詢id為1的結果
*/
public Post getPostById(int id){
if(id == 1){
User user = new User(1,"javadaily","JAVA日知錄","zhangsan@qq.com");
Post post = new Post(1,"Hello,Graphql","Graphql初體驗","日記");
post.setUser(user);
return post;
}else{
return null;
}
}
}
UserService
@Service
public class UserService implements GraphQLQueryResolver {
List<User> userList = Lists.newArrayList();
public User getUserById(int id){
return userList.stream().filter(item -> item.getUserId() == id).findAny().orElse(null);
}
@PostConstruct
public void initUsers(){
Post post1 = new Post(1,"Hello,Graphql1","Graphql初體驗1","日記");
Post post2 = new Post(2,"Hello,Graphql2","Graphql初體驗2","日記");
Post post3 = new Post(3,"Hello,Graphql3","Graphql初體驗3","日記");
List<Post> posts = Lists.newArrayList(post1,post2,post3);
User user1 = new User(1,"zhangsan","張三","zhangsan@qq.com");
User user2 = new User(2,"lisi","李四","lisi@qq.com");
user1.setPosts(posts);
user2.setPosts(posts);
userList.add(user1);
userList.add(user2);
}
}
基于Graphql的查詢需要實現(xiàn)GraphQLQueryResolver接口，由于為了便于演示我們并沒有引入數(shù)據(jù)層，請大家知悉。
配置Graphql 端點
server.port = 8080 graphql.servlet.corsEnabled=true # 配置端點 graphql.servlet.mapping=/graphql graphql.servlet.enabled=true
配置完端口和端點后我們就可以對我們編寫的Graphql接口進行測試了。
接口地址為：localhost:8080/graphql
測試
這里我使用的是Chrome瀏覽器的Altair Graphal Client插件，當然你還可以使用其他的客戶端工具，如：graphql-playground。
安裝插件
瀏覽器輸入chrome://extensions/，在擴展中心搜索Altair后即可添加至瀏覽器。
查詢
啟動SpringBoot項目，然后在打開的Altair插件界面，輸入Graphql端點http://localhost:8080/graphql，然后點擊Docs，將鼠標移至需要的查詢上，點擊ADD QUERY即可添加對應的查詢。
點擊Send Request 即可看到查詢結果：
然后我們在Query中可以根據(jù)我們的需要新增或刪除接口字段并重新請求接口，會看到響應結果中也會根據(jù)我們的請求自動返回結果：
小結
Graphql支持的數(shù)據(jù)操作有：
- 查詢（Query） ：獲取數(shù)據(jù)的基本查詢。
- 變更（Mutation） ：支持對數(shù)據(jù)的增刪改等操作。
- 訂閱（Subscription） ：用于監(jiān)聽數(shù)據(jù)變動、并靠websocket等協(xié)議推送變動的消息給對方。
本節(jié)內(nèi)容我們基于SpringBoot完成了Query的數(shù)據(jù)操作，實現(xiàn)過程還是相對比較簡單。希望此文能讓大家對Graphql有一個整體的了解，如果大家對Graphql感興趣后面還會更新此系列文章，完成對其他數(shù)據(jù)操作的整合。
更多關于SpringBoot集成Graphql Query的資料請關注腳本之家其它相關文章！
相關文章
java一個接口多個實現(xiàn)類的調(diào)用方式
這篇文章主要給大家介紹了關于java一個接口多個實現(xiàn)類的調(diào)用方式的相關資料,經(jīng)測試確認,當一個接口有多個實現(xiàn)時,調(diào)用時只會執(zhí)行一個,有時候需要多個實現(xiàn)調(diào)用,需要的朋友可以參考下2023-09-09
Maven中Junit測試@Test等注解無法識別的問題及解決
這篇文章主要介紹了Maven中Junit測試@Test等注解無法識別的問題及解決方案,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11
Java中的流程控制語句可以這樣分類：順序結構，選擇結構，循環(huán)結構。下面文章我們就來看看來順序結構的詳細介紹，主要以順序結構簡單圖示及詳細解說該內(nèi)容，需要的小伙伴可以參考一下2021-12-12
在項目開發(fā)中，時常會遇到跨域問題，本文主要介紹了五種解決跨域的方法，使用最多的是第三種，需要的朋友們下面隨著小編來一起學習學習吧2021-06-06
插入排序是一種最簡單的排序方法，它的基本思想是將一個記錄插入到已經(jīng)排好序的有序表中，從而一個新的、記錄數(shù)增1的有序表。本文通過圖片合示例講解了插入排序的實現(xiàn)，需要的可以了解一下2022-11-11
Java使用jSerialComm進行跨平臺串口通信的完全指南
在現(xiàn)代嵌入式開發(fā)和物聯(lián)網(wǎng)應用中,串口通信仍然是設備間數(shù)據(jù)交換的重要方式,jSerialComm作為一款專為Java設計的跨平臺串口通信庫,為開發(fā)者提供了簡單高效的解決方案,下面小編就和大家詳細講講具體實現(xiàn)方法吧2025-12-12
這篇文章主要為大家詳細介紹了springboot整合mybatisplus的方法，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-03-03
在默認配置下,SpringBean的加載順序主要受到Bean定義順序、依賴關系和生命周期回調(diào)方法的影響,本文就來了解一下Spring bean加載順序,感興趣的同學可以學習2024-10-10
Mybatis-plus通過添加攔截器實現(xiàn)簡單數(shù)據(jù)權限
系統(tǒng)需要根據(jù)用戶所屬的公司,來做一下數(shù)據(jù)權限控制,具體一點,就是通過表中的company_id進行權限控制,項目使用的是mybatis-plus,所以通過添加攔截器的方式,修改查詢sql,實現(xiàn)數(shù)據(jù)權限,本文就通過代碼給大家詳細的講解一下,需要的朋友可以參考下2023-08-08
這篇文章介紹了java 取出文本文件中空行的實例代碼，有需要的朋友可以參考一下2013-09-09