服务器传输

Spring for GraphQL 支持通过 HTTP、WebSocket 和 RSocket 的spring-doc.cn

HTTP 协议

GraphQlHttpHandler处理 GraphQL over HTTP 请求，并委托给拦截链执行请求。有两种变体，一种用于 Spring MVC 和一个用于 Spring WebFlux 的 Spring WebFlux。两者都异步处理请求，并且具有等效功能，但分别依赖于阻塞和非阻塞 I/O 编写 HTTP 响应。spring-doc.cn

请求必须使用 HTTP POST 作为内容类型和 GraphQL 请求详细信息作为 JSON 包含在请求正文中，如建议的 GraphQL over HTTP 规范中所定义。成功解码 JSON 正文后，HTTP 响应状态始终为 200 （OK）， GraphQL 请求执行中的任何错误都会显示在 GraphQL 响应的“错误”部分中。媒体类型的默认和首选选择是，但也受支持，如规范中所述。"application/json""application/graphql-response+json""application/json"spring-doc.cn

GraphQlHttpHandler可以通过声明 bean 并使用 from Spring MVC 或 WebFlux 创建路由来公开为 HTTP 端点。Boot Starter 执行此操作，请参阅 Web Endpoints 部分 details 或选中 or it contains，以获取实际配置。RouterFunctionRouterFunctionsGraphQlWebMvcAutoConfigurationGraphQlWebFluxAutoConfigurationspring-doc.cn

默认情况下，将使用（Spring MVC）序列化和反序列化 JSON 有效负载以及在 Web 框架中配置的（WebFlux）。在某些情况下，应用程序会以与 GraphQL 负载不兼容的方式为 HTTP 终端节点配置 JSON 编解码器。应用程序可以使用将用于 GraphQL 有效负载的自定义 JSON 编解码器进行实例化。GraphQlHttpHandlerHttpMessageConverterDecoderHttpMessageReader/EncoderHttpMessageWriterGraphQlHttpHandlerspring-doc.cn

此存储库的 1.0.x 分支包含一个 Spring MVC HTTP 示例应用程序。spring-doc.cn

服务器发送的事件

GraphQlSseHandler与上面列出的 HTTP 处理程序非常相似，但这次通过 HTTP 处理 GraphQL 请求使用 Server-Sent Events 协议。通过这种传输方式，客户端必须向终端节点发送 HTTP POST 请求，并在请求正文中包含 JSON 格式和 GraphQL 请求详细信息;唯一的与原版 HTTP 变体的不同之处在于，客户端必须作为请求发送页眉。响应将作为一个或多个 Server-Sent Event（服务器发送事件）发送。"application/json""text/event-stream""Accept"spring-doc.cn

这在提议的 GraphQL over HTTP 规范中也有定义。 Spring for GraphQL 仅实现“Distinct connections mode”，因此应用程序必须考虑可扩展性问题以及采用 HTTP/2 作为底层传输是否有帮助。spring-doc.cn

的主要用例是 WebSocket 传输的替代方案，接收项目流作为对订阅操作。其他类型的操作（如 queries 和 mutation）在此处不受支持，应支持使用纯 JSON over HTTP 传输变体。GraphQlSseHandlerspring-doc.cn

文件上传

作为一种协议，GraphQL 专注于文本数据的交换。这不包括二进制文件数据，但有一个单独的非正式 graphql-multipart-request-spec 允许通过 HTTP 使用 GraphQL 上传文件。spring-doc.cn

Spring for GraphQL 不支持直接。虽然该规范确实提供了统一 GraphQL API 的好处，但实际体验确实导致了许多问题，最佳实践建议已经发展起来，请参阅 Apollo Server 文件上传最佳实践有关更详细的讨论。graphql-multipart-request-specspring-doc.cn

如果您想在应用程序中使用，您可以通过库 multipart-spring-graphql 执行此操作。graphql-multipart-request-specspring-doc.cn

WebSocket 浏览器

GraphQlWebSocketHandler根据 graphql-ws 库中定义的协议处理 WebSocket 上的 GraphQL 请求。使用的主要原因基于 WebSocket 的 GraphQL 是允许发送 GraphQL 流的订阅 responses，但它也可以用于具有单个响应的常规查询。处理程序将每个请求委托给 Interception 链以进一步请求执行。spring-doc.cn

基于 WebSocket 协议的 GraphQL

有两种这样的协议，一种在 subscriptions-transport-ws 库中，另一种在 graphql-ws 库中。前者不活跃且由后者接替。阅读这篇博文了解历史。spring-doc.cn

有两种变体，一种用于 Spring MVC，一种用于 Spring MVC Spring WebFlux 的 Web Flux 中。两者都异步处理请求，并且具有等效的功能。 WebFlux 处理程序还使用非阻塞 I/O 和背压来流式传输消息，这很好用，因为在 GraphQL Java 中，订阅响应是 Reactive Streams 。GraphQlWebSocketHandlerPublisherspring-doc.cn

该项目列出了许多供客户使用的配方。graphql-wsspring-doc.cn

GraphQlWebSocketHandler可以通过声明 Bean 并使用它将处理程序映射到 URL 路径来公开为 WebSocket 端点。默认情况下， Boot Starter 不会公开 WebSocket 端点上的 GraphQL，但是，您可以为 Endpoint path 添加一个属性来启用它。请查看启动参考文档中的 Web 端点以及支持的属性列表。您还可以查看或了解实际的 Boot 自动配置详细信息。SimpleUrlHandlerMappingspring.graphql.websocketGraphQlWebMvcAutoConfigurationGraphQlWebFluxAutoConfigurationspring-doc.cn

此存储库的 1.0.x 分支包含一个 WebFlux WebSocket 示例应用程序。spring-doc.cn

RSocket 系列

GraphQlRSocketHandler处理 GraphQL over RSocket 请求。查询和更改是预期并作为 RSocket 交互处理，而订阅是处理为 .request-responserequest-streamspring-doc.cn

GraphQlRSocketHandler可以使用映射到 GraphQL 请求的路由。例如：@Controllerspring-doc.cn

import java.util.Map;

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

import org.springframework.graphql.server.GraphQlRSocketHandler;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.stereotype.Controller;

@Controller
public class GraphQlRSocketController {

	private final GraphQlRSocketHandler handler;

	GraphQlRSocketController(GraphQlRSocketHandler handler) {
		this.handler = handler;
	}

	@MessageMapping("graphql")
	public Mono<Map<String, Object>> handle(Map<String, Object> payload) {
		return this.handler.handle(payload);
	}

	@MessageMapping("graphql")
	public Flux<Map<String, Object>> handleSubscription(Map<String, Object> payload) {
		return this.handler.handleSubscription(payload);
	}
}

拦截

服务器传输允许在 GraphQL Java 引擎之前和之后拦截请求调用以处理请求。spring-doc.cn

`WebGraphQlInterceptor`

HTTP 和 WebSocket 传输调用 0 或 more 的链，后跟调用 GraphQL Java 引擎的 an。拦截器允许应用程序拦截传入请求，以便：WebGraphQlInterceptorExecutionGraphQlServicespring-doc.cn

检查 HTTP 请求详细信息spring-doc.cn
自定义graphql.ExecutionInputspring-doc.cn
添加 HTTP 响应标头spring-doc.cn
自定义graphql.ExecutionResultspring-doc.cn
以及更多spring-doc.cn

例如，拦截器可以将 HTTP 请求标头传递给：DataFetcherspring-doc.cn

import java.util.Collections;

import reactor.core.publisher.Mono;

import org.springframework.graphql.data.method.annotation.ContextValue;
import org.springframework.graphql.data.method.annotation.QueryMapping;
import org.springframework.graphql.server.WebGraphQlInterceptor;
import org.springframework.graphql.server.WebGraphQlRequest;
import org.springframework.graphql.server.WebGraphQlResponse;
import org.springframework.stereotype.Controller;

class RequestHeaderInterceptor implements WebGraphQlInterceptor { (1)

	@Override
	public Mono<WebGraphQlResponse> intercept(WebGraphQlRequest request, Chain chain) {
		String value = request.getHeaders().getFirst("myHeader");
		request.configureExecutionInput((executionInput, builder) ->
				builder.graphQLContext(Collections.singletonMap("myHeader", value)).build());
		return chain.next(request);
	}
}

@Controller
class MyContextValueController { (2)

	@QueryMapping
	Person person(@ContextValue String myHeader) {
		...
	}
}

1	Interceptor 将 HTTP 请求标头值添加到 GraphQLContext 中
2	数据控制器方法访问值

相反，拦截器可以访问控制器添加到 the 的值：GraphQLContextspring-doc.cn

import graphql.GraphQLContext;
import reactor.core.publisher.Mono;

import org.springframework.graphql.data.method.annotation.QueryMapping;
import org.springframework.graphql.server.WebGraphQlInterceptor;
import org.springframework.graphql.server.WebGraphQlRequest;
import org.springframework.graphql.server.WebGraphQlResponse;
import org.springframework.http.HttpHeaders;
import org.springframework.http.ResponseCookie;
import org.springframework.stereotype.Controller;

// Subsequent access from a WebGraphQlInterceptor

class ResponseHeaderInterceptor implements WebGraphQlInterceptor {

	@Override
	public Mono<WebGraphQlResponse> intercept(WebGraphQlRequest request, Chain chain) { (2)
		return chain.next(request).doOnNext((response) -> {
			String value = response.getExecutionInput().getGraphQLContext().get("cookieName");
			ResponseCookie cookie = ResponseCookie.from("cookieName", value).build();
			response.getResponseHeaders().add(HttpHeaders.SET_COOKIE, cookie.toString());
		});
	}
}

@Controller
class MyCookieController {

	@QueryMapping
	Person person(GraphQLContext context) { (1)
		context.put("cookieName", "123");
		...
	}
}

1	Controller 为`GraphQLContext`
2	Interceptor 使用该值添加 HTTP 响应标头

WebGraphQlHandler可以修改，例如，检查和修改请求验证错误，这些错误在执行开始之前引发，并且不能用：ExecutionResultDataFetcherExceptionResolverspring-doc.cn

import java.util.List;

import graphql.GraphQLError;
import graphql.GraphqlErrorBuilder;
import reactor.core.publisher.Mono;

import org.springframework.graphql.server.WebGraphQlInterceptor;
import org.springframework.graphql.server.WebGraphQlRequest;
import org.springframework.graphql.server.WebGraphQlResponse;

class RequestErrorInterceptor implements WebGraphQlInterceptor {

	@Override
	public Mono<WebGraphQlResponse> intercept(WebGraphQlRequest request, Chain chain) {
		return chain.next(request).map((response) -> {
			if (response.isValid()) {
				return response; (1)
			}

			List<GraphQLError> errors = response.getErrors().stream() (2)
					.map((error) -> {
						GraphqlErrorBuilder<?> builder = GraphqlErrorBuilder.newError();
						// ...
						return builder.build();
					})
					.toList();

			return response.transform((builder) -> builder.errors(errors).build()); (3)
		});
	}
}

1	如果具有非 null 值的 “data” 键，则返回相同的`ExecutionResult`
2	检查并转换 GraphQL 错误
3	使用修改后的错误更新`ExecutionResult`

用于配置链。这是支持的通过 Boot Starter 查看 Web 端点。WebGraphQlHandlerWebGraphQlInterceptorspring-doc.cn

`WebSocketGraphQlInterceptor`

WebSocketGraphQlInterceptor使用其他回调进行扩展处理 WebSocket 连接的开始和结束，以及客户端取消订阅。同样也会拦截 WebSocket 连接。WebGraphQlInterceptorspring-doc.cn

用于配置链。这是支持的通过 Boot Starter 查看 Web 端点。侦听器链中最多只能有一个。WebGraphQlHandlerWebGraphQlInterceptorWebSocketGraphQlInterceptorspring-doc.cn

有两个内置的 WebSocket 拦截器，称为一个用于 WebMVC，一个用于 WebFlux 传输。这些有助于提取身份验证 Details 来自 WebSocket 消息的 GraphQL 负载、authenticate、然后将传播到 WebSocket 连接上的后续请求。AuthenticationWebSocketInterceptor"connection_init"SecurityContextspring-doc.cn

spring-graphql-examples中有一个websocket-authentication示例。

`RSocketQlInterceptor`

与 WebGraphQlInterceptor 类似，它允许拦截 GraphQL over RSocket 请求在 GraphQL Java 引擎执行之前和之后。您可以使用 this 自定义和 .RSocketQlInterceptorgraphql.ExecutionInputgraphql.ExecutionResultspring-doc.cn