Spring GraphQL 為構建在 GraphQL Java 上的 Spring 應用程序提供支持。兩個團隊之間的聯(lián)合聯(lián)合。我們的共同理念是少固執(zhí)己見，更專注于全面和廣泛的支持。

Spring GraphQL 是 GraphQL Java 團隊的 GraphQL Java Spring 項目的繼承者。它將成為所有 Spring、GraphQL 應用程序的基礎。

網(wǎng)絡傳輸

Spring GraphQL 支持通過 HTTP 和 WebSocket 的 GraphQL 請求。

HTTP

GraphQlHttpHandler通過 HTTP 請求處理 GraphQL，并委托給 Web 攔截執(zhí)行請求。有兩種變體，一種用于 Spring MVC，一種用于 Spring WebFlux。分別依賴周期性和非周期性 I/O 來寫 HTTP 響應。

請求必須使用 HTTP POST 和 GraphQL 請求詳細信息作為 JSON 包含在請求正文中，如提議的 GraphQL over HTTP 規(guī)范中定義。成功解碼 JSON 正文后，HTTP 響應狀態(tài)始終為 200（OK），并且 GraphQL 請求執(zhí)行中任何錯誤都出現(xiàn)在 GraphQL 響應的“錯誤”部分。

GraphQlHttpHandler可以通過聲明一個RouterFunctionbean 并使用RouterFunctions來自 Spring MVC 或 WebFlux 的來創(chuàng)建路由來作為 HTTP 公開公開。啟動啟動器執(zhí)行此操作。

Spring GraphQL 存儲庫包含一個 Spring MVC HTTP 示例應用程序。

網(wǎng)絡結果

GraphQlWebSocketHandler基于graphql的協(xié)議通過WebSocket請求處理Graphws庫。在WebSocket上使用GraphQL的結果是訂閱，它允許發(fā)送GraphQL響應流，但它也可以用于有一次響應的經(jīng)常查詢處理程序。個請求委托給Web攔截鏈以進一步執(zhí)行請求。

有兩種變體GraphQlWebSocketHandler，用于一種Spring MVC，用于Spring WebFlux。 回流處理請求并具有強大的壓處理功能。消息，這很有效，因為在 GraphQL Java 中訂閱響應是 Reactive Streams Publisher。

該graphql-ws項目已經(jīng)全部供客戶使用的配方。

GraphQlWebSocketHandler通過聲明SimpleUrlHandlerMappingbean 并可以使用通信處理程序映射到 URL 路徑來公開為 WebSocket 需求。啟動啟動器具有啟用此功能的選項，詳細信息或檢查或例如配置，請參閱 Web 頁面。GraphQlWebMvcAutoConfigurationGraphQlWebFluxAutoConfiguration

Spring GraphQL 存儲庫包含一個 WebFlux WebSocket 示例應用程序。

網(wǎng)頁攔截

HTTP和WebSocket的傳輸處理程序委托給一個通用的網(wǎng)絡攔截鏈來執(zhí)行請求。鏈該由一系列WebInterceptor組件組成，一個后跟GraphQlService調(diào)用GraphQL的Java引擎的。

WebInterceptor在 Spring MVC 和 WebFlux 應用程序中使用的通用組件。使用它來攔截請求、檢查 HTTP 請求標頭或注冊以下內(nèi)容的轉換graphql.ExecutionInput：

類 MyInterceptor 實現(xiàn)了 WebInterceptor {

@覆蓋

public Mono 攔截(WebInput webInput, WebGraphQlHandler next) {

webInput.configureExecutionInput((executionInput, builder) -> {

Map map = ... ;,>

返回 builder.extensions(map).build();

});

返回 next.handle(webInput);

}

}

使用WebInterceptor也攔截響應，增加HTTP響應頭，或轉換graphql.ExecutionResult：

類 MyInterceptor 實現(xiàn)了 WebInterceptor {

@覆蓋

public Mono 攔截(WebInput webInput, WebGraphQlHandler next) {

返回 next.handle(webInput)

.map(webOutput -> {

對象數(shù)據(jù) = webOutput.getData();

對象更新數(shù)據(jù) = ... ;

返回 webOutput.transform(builder -> builder.data(updatedData));

});

}

}

WebGraphQlHandler提供了一個builder來初始化Web攔截鏈。構建鏈后，您可以使用結果WebGraphQlHandler來初始化HTTP或WebSocket傳輸處理程序。啟動器配置了所有這些，有關詳細信息，請參見Web Endpoints，或檢查GraphQlWebMvcAutoConfiguration或GraphQlWebFluxAutoConfiguration配置。

查詢執(zhí)行

GraphQlService是調(diào)用GraphQL Java 來執(zhí)行請求的主要Spring GraphQL 抽象。通過傳輸，例如Web 傳輸，委托GraphQlService來處理請求。

主要實現(xiàn)ExecutionGraphQlService是圍繞著調(diào)用的薄外觀graphql.GraphQL。它配置了一個GraphQlSource用于訪問graphql.GraphQL實例。

GraphQLSource

GraphQlSource是核心 Spring GraphQL 抽象，用于訪問graphql.GraphQL請求執(zhí)行的實例。它提供了一個構建器 API 來初始化 GraphQL Java 并構建一個GraphQlSource。

GraphQlSource可通過訪問的默認構建器GraphQlSource.builder()支持Reactive DataFetcher、Context Propagation和Exception Resolution。

反應式 DataFetcher

默認GraphQlSource構建器啟用對一個DataFetcher報道查看Mono或的請立即獲取iTunes Flux。報道查看無論類型適合在一個CompletableFuture與Flux聚集，變成了一個列表值，除非請求是GraphQL訂閱請求，這種在情況下報道查看值保持在無流Publisher的流GraphQL響應。

反應式DataFetcher可以依賴對從傳輸層傳播的 Reactor 上下文的訪問，例如來自 WebFlux 請求處理，請參閱 WebFlux 上下文。

大約傳播

Spring GraphQL 支持從Web 傳輸、通過GraphQL 引擎以及DataFetcher它調(diào)用的其他組件透明地傳播上下文。這包括ThreadLocal來自SpringMVC 請求處理線程的上下文和Context來自WebFlux 處理管道的Reactor。

網(wǎng)管

DataFetcherGraphQL Java 調(diào)用的 A 和其他組件可能并不總是在與 Spring MVC 處理程序相同的線程上執(zhí)行，例如如果異步WebInterceptor或DataFetcher切換到不同的線程。

Spring GraphQL 支持將ThreadLocal值從容器線程傳播到線程DataFetcher以及由 GraphQL 引擎調(diào)用的其他組件執(zhí)行。因此，應用程序需要創(chuàng)建一個ThreadLocalAccessor來ThreadLocal提取生物的值：

公共類 RequestAttributesAccessor 實現(xiàn) ThreadLocalAccessor {

private static final String KEY = RequestAttributesAccessor.class.getName();

@覆蓋

公共無效提取值（地圖<字符串，對象>容器）{

container.put(KEY, RequestContextHolder.getRequestAttributes());

}

@覆蓋

public void restoreValues(Map values) {,>

if (values.containsKey(KEY)) {

RequestContextHolder.setRequestAttributes((RequestAttributes) values.get(KEY));

}

}

@覆蓋

public void resetValues(Map values) {,>

RequestContextHolder.resetRequestAttributes();

}

}

一個ThreadLocalAccessor可以在 WebGraphHandler 構建器中注冊。Boot starter 檢測這種類型的 bean 并自動為 Spring MVC 應用程序注冊它們，請參見 Web Endpoints。

網(wǎng)絡流量

一個反應DataFetcher可以從獲取反應背景下，WebFlux 口頭請求處理鏈。這包括由 WebInterceptor 組件添加的 Reactor 上下文。

異常解決

GraphQL Java 應用程序可以注冊一個DataFetcherExceptionHandler來決定如何在 GraphQL 響應的“錯誤”部分中表示來自數(shù)據(jù)層的異常。

Spring GraphQL 有一個內(nèi)置的DataFetcherExceptionHandler，配置為供GraphQLSource構建器使用。它使應用程序注冊一個或多個DataFetcherExceptionResolver順序調(diào)用的 Spring 組件，直到將解析Exception為graphql.GraphQLError對象列表。

DataFetcherExceptionResolver是一個異步契約。對于大多數(shù)實現(xiàn)，這將是悉尼的擴展DataFetcherExceptionResolverAdapter和覆蓋其一個resolveToSingleError或resolveToMultipleErrors方法是解決異常同步。

AGraphQLError可以分配一個graphql.ErrorClassification。Spring GraphQL 定義了一個ErrorType常見錯誤分類類別的枚舉：

• BAD_REQUEST

• UNAUTHORIZED

• FORBIDDEN

• NOT_FOUND

• INTERNAL_ERROR

應用程序可以使用它來分類錯誤。如果它錯誤解決，則默認情況下將標記為INTERNAL_ERROR。

未完待續(xù)……