GraphQL全解析,你學會了嗎?
您可能已經看過很多關于GraphQL的內容,在這個過程中是不是有時會感到困惑和不知所措。本文讓我嘗試用更簡單易懂的語言回答關于GraphQL的三個主要問題:GraphQL是什么,如何工作,何時使用?希望對您更好地理解GraphQL有所裨益。
1 什么是GraphQL
“Graph”指的是數據以類似圖形的結構表示和連接。在GraphQL中,數據表示為具有節點和邊的圖形,允許不同數據實體之間的靈活關系。
“QL”代表“查詢語言”,因為GraphQL提供了一種精確和可控的查詢或請求數據的語言。
示例:書和作者的關系可以用圖來表示,可以很容易地使用GraphQL進行查詢:
深入研究GraphQL,我們發現它是:
- 類型系統:定義數據的外觀以及事物之間的關系。類型系統定義各種數據類型和架構,這是客戶端和服務器之間的合同。
- 查詢語言:查詢數據的語言,它知道從哪里獲取數據并包含驗證或執行查詢的規則。
簡而言之,GraphQL能讓客戶端精確指定它需要從API獲取的數據。
Facebook在2012年開始開發GraphQL,并于2015年將其發布為開源。2018年,GraphQL被移至新成立的GraphQL基金會,由非營利組織Linux基金會托管。
GraphQL支持讀取、寫入(變異)和訂閱數據的更改,讓我們可以實時更新。
2 GraphQL如何工作
GraphQL有兩個部分:請求數據的客戶端和提供數據的服務器,以下是解釋其工作原理的步驟:
i)定義模式:服務器定義GraphQL模式,這類似于描述可用數據和操作的藍圖。例如,如果我們有一個帶有字段(id、name和pageCount)的Book實體,并且有一個查詢是按id查詢書籍,則其模式將如下所示:
type Query {
bookById(id: ID): Book
}
type Book {
id: ID
name: String
pageCount: Int
}
ii)發送查詢:客戶端向服務器發送GraphQL查詢,指定所需數據和所需結構。
query bookDetails {
bookById(id: "book-1") {
id
name
pageCount
}
}
iii)解決查詢:服務器的GraphQL引擎接收查詢并開始解決查詢。它根據查詢確定需要哪些數據,以及應執行哪些解析器函數來獲取該數據。
iv)獲取數據:解析器函數根據查詢要求從各種數據源(例如數據庫、API)檢索數據。
v)組裝響應:GraphQL引擎收集檢索到的數據,并按客戶端請求的格式組裝響應。它僅包括查詢中請求的確切數據字段,減少不必要的數據傳輸。
vi)返回響應:服務器將響應發送回客戶端,提供查詢中精確請求的數據。
3 何時可以使用GraphQL
GraphQL適用于處理復雜或經常變化的數據需求,因為它可以將數據請求的控制權交給客戶端,讓客戶端在任何時間請求任何數據。這讓在每次API變更迭代或從這些API請求的數據發生變化時更容易進行更新。與REST API相比,GraphQL允許客戶端精確指定所需數據的結構和字段,從而避免了獲取過度或獲取不足的問題。因此,GraphQL可以提高數據傳輸的精確性和效率,使應用程序更加靈活和可擴展。
如果應用程序需要從多個來源聚合數據,GraphQL可以幫助把這些來源統一到單個API中。它提供了一個抽象層,可從各種服務中獲取和組合數據,使數據的獲取和整合更加簡單和高效。
當應用程序需要實時更新和訂閱時,GraphQL提供內置功能。這些功能允許客戶端訂閱特定數據的變化,并在數據更改時實時推送通知,從而提高應用程序的實時性和響應性。
總之,如果您需要更好地控制和定制API響應,并希望有效地處理復雜或不斷變化的數據需求,那么GraphQL是一個非常有用的工具。
4 使用Spring實現GraphQL
隨著spring-boot-starter-graphql框架的到來,使用Spring實現GraphQL變得更加容易。
在Spring項目中集成GraphQL的步驟如下:
i)向項目添加gradle/maven graphql starter依賴:
//Gradle
implementation 'org.springframework.boot:spring-boot-starter-graphql'
//Maven
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-graphql</artifactId>
</dependency>
ii)創建一個目錄src/main/resources/graphql,并在該目錄下添加一個名為schema.graphqls的文件,包含以下內容:
type Query {
bookById(id: ID): Book
}
type Book {
id: ID
name: String
pageCount: Int
}
在這里,我們創建了一個Book的schema。每個schema都有一個頂級查詢類型,這里的schema定義了一個名為bookById的查詢,用于返回特定書籍的詳細信息。
iii)GraphQL服務器中的每個復雜類型都由Java bean表示,并且Java bean中的字段將直接映射到GraphQL響應中的字段,其名稱基于字段名稱。
public record Book (String id, String name, int pageCount) {
private static List<Book> books = Arrays.asList(
new Book("book-1", "Effective Java", 416),
new Book("book-2", "Hitchhiker's Guide to the Galaxy", 208),
new Book("book-3", "Down Under", 436)
);
public static Book getById(String id) {
return books.stream()
.filter(book -> book.id().equals(id))
.findFirst()
.orElse(null);
}
}
iv) Spring的GraphQL提供了基于注解的編程模型。通過控制器注釋方法,我們可以聲明如何獲取特定GraphQL字段的數據。現在讓我們添加BookController.java
@Controller
public class BookController {
@QueryMapping
public Book bookById(@Argument String id) {
return Book.getById(id);
}
}
通過定義一個名為bookById的方法并用@QuerMapping注釋,此控制器聲明了如何獲取Query類型下定義的Book。查詢字段從方法名稱確定,但也可以在注釋本身上聲明。
v) Spring的GraphQL還為我們提供了一個用于編寫和執行查詢的可視界面,名為GraphiQL。通過將以下配置添加到application.yaml文件中啟用GraphiQL:
spring
graphql
graphiql
enabled: true
啟動Spring應用程序并導航到http://localhost:8080/graphiql.
vi)在窗口頂部鍵入查詢并單擊播放按鈕。
query bookDetails {
bookById(id: "book-1") {
id
name
pageCount
}
}
您將看到以下響應:
這樣您已經構建了一個GraphQL服務并成功查詢了數據!您的數據之旅從此開始!快動手試試吧~