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