|
对于最新的稳定版本，请使用 Spring GraphQL 1.4.1！ |
客户端
Spring for GraphQL 包括对通过 HTTP 执行 GraphQL 请求的客户端支持， WebSocket 和 RSocket。
GraphQlClient
GraphQlClient是一个合约，它为 GraphQL 请求声明了一个通用工作流，即
独立于底层传输。这意味着请求使用相同的 API 执行
无论底层传输是什么，以及配置了
构建时间。
要创建GraphQlClient您需要以下扩展之一：
每个定义了一个Builder与运输相关的选项。所有构建器都扩展
从通用的基本 GraphQlClientBuilder带选项
与所有扩展相关。
一旦你有一个GraphQlClient您可以开始提出请求。
HTTP
HttpGraphQlClient使用 WebClient 执行
通过 HTTP 的 GraphQL 请求。
WebClient webClient = ... ;
HttpGraphQlClient graphQlClient = HttpGraphQlClient.create(webClient);一次HttpGraphQlClient创建时，您可以开始使用相同的 API 执行请求，而不受底层
运输。如果您需要更改任何特定于传输的详细信息，请使用mutate()在
现存HttpGraphQlClient要使用自定义设置创建新实例，请执行以下作：
WebClient webClient = ... ;
HttpGraphQlClient graphQlClient = HttpGraphQlClient.builder(webClient)
.headers(headers -> headers.setBasicAuth("joe", "..."))
.build();
// Perform requests with graphQlClient...
HttpGraphQlClient anotherGraphQlClient = graphQlClient.mutate()
.headers(headers -> headers.setBasicAuth("peter", "..."))
.build();
// Perform requests with anotherGraphQlClient...Web套接字
WebSocketGraphQlClient通过共享 WebSocket 连接执行 GraphQL 请求。
它是使用 Spring WebFlux 中的 WebSocketClient 构建的，您可以按如下方式创建它：
String url = "wss://localhost:8080/graphql";
WebSocketClient client = new ReactorNettyWebSocketClient();
WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client).build();与HttpGraphQlClient这WebSocketGraphQlClient以连接为导向，
这意味着它需要在发出任何请求之前建立连接。开始时
为了发出请求，连接是透明地建立的。或者，使用
客户的start()方法在任何请求之前显式建立连接。
除了以连接为导向之外，WebSocketGraphQlClient也是多路复用的。
它为所有请求维护一个单一的共享连接。如果连接丢失，
它在下一个请求时重新建立，或者如果start()再次调用。您还可以
使用客户端的stop()方法，关闭
connection，并拒绝新请求。
使用单个WebSocketGraphQlClient实例，以便拥有
对该服务器的所有请求的单个共享连接。每个客户端实例
建立自己的连接，这通常不是单个服务器的意图。 |
一次WebSocketGraphQlClient创建时，您可以开始使用相同的 API 执行请求，而不受底层
运输。如果您需要更改任何特定于传输的详细信息，请使用mutate()在
现存WebSocketGraphQlClient要使用自定义设置创建新实例，请执行以下作：
URI url = ... ;
WebSocketClient client = ... ;
WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client)
.headers(headers -> headers.setBasicAuth("joe", "..."))
.build();
// Use graphQlClient...
WebSocketGraphQlClient anotherGraphQlClient = graphQlClient.mutate()
.headers(headers -> headers.setBasicAuth("peter", "..."))
.build();
// Use anotherGraphQlClient...拦截 器
GraphQL over WebSocket 协议除了执行之外，还定义了许多面向连接的消息
请求。例如，客户端发送"connection_init"服务器响应"connection_ack"在连接开始时。
对于特定于 WebSocket 传输的拦截，您可以创建WebSocketGraphQlClientInterceptor:
static class MyInterceptor implements WebSocketGraphQlClientInterceptor {
@Override
public Mono<Object> connectionInitPayload() {
// ... the "connection_init" payload to send
}
@Override
public Mono<Void> handleConnectionAck(Map<String, Object> ackPayload) {
// ... the "connection_ack" payload received
}
}将上述拦截器注册为任何其他拦截器GraphQlClientInterceptor并使用它来拦截 GraphQL 请求，但请注意
最多可以是一个类型的拦截器WebSocketGraphQlClientInterceptor.
RS袜子
RSocketGraphQlClient使用 RSocketRequester 通过 RSocket 请求执行 GraphQL 请求。
URI uri = URI.create("wss://localhost:8080/rsocket");
WebsocketClientTransport transport = WebsocketClientTransport.create(url);
RSocketGraphQlClient client = RSocketGraphQlClient.builder()
.clientTransport(transport)
.build();与HttpGraphQlClient这RSocketGraphQlClient以连接为导向，
这意味着它需要在发出任何请求之前建立一个会话。开始时
为了发出请求，会话是透明地建立的。或者，使用
客户的start()方法在任何请求之前显式建立会话。
RSocketGraphQlClient也是多路复用的。它维护一个单独的共享会话
所有请求。如果会话丢失，则在下一个请求时重新建立会话，或者如果start()再次调用。您还可以使用客户端的stop()取消的方法
in-progress 请求，关闭会话，并拒绝新请求。
使用单个RSocketGraphQlClient实例，以便拥有
对该服务器的所有请求的单个共享会话。每个客户端实例
建立自己的连接，这通常不是单个服务器的意图。 |
一次RSocketGraphQlClient创建时，您可以开始使用相同的 API 执行请求，而不受底层
运输。
请求
一旦你有一个GraphQlClient，您可以通过 retrieve（） 或 execute（） 开始执行请求，其中前者只是后者的快捷方式。
取回
以下内容检索并解码查询的数据：
String document = "{" +
" project(slug:\"spring-framework\") {" +
" name" +
" releases {" +
" version" +
" }"+
" }" +
"}";
Mono<Project> projectMono = graphQlClient.document(document) (1)
.retrieve("project") (2)
.toEntity(Project.class); (3)| 1 | 要执行的作。 |
| 2 | 响应映射中“data”键下的路径，要从中解码。 |
| 3 | 在目标类型的路径处解码数据。 |
输入文档是String可以是文字，也可以是通过代码生成的
生成的请求对象。您还可以在文件中定义文档，并使用文档源按文件名重新定位它们。
该路径相对于“data”键，并使用简单的点 （“.”） 分隔表示法
对于具有列表元素可选数组索引的嵌套字段，例如"project.name"或"project.releases[0].version".
解码可能导致FieldAccessException如果给定的路径不存在，或者
字段值为null并且有一个错误。FieldAccessException提供对
response 和字段：
Mono<Project> projectMono = graphQlClient.document(document)
.retrieve("project")
.toEntity(Project.class)
.onErrorResume(FieldAccessException.class, ex -> {
ClientGraphQlResponse response = ex.getResponse();
// ...
ClientResponseField field = ex.getField();
// ...
});执行
检索只是从单个路径解码的快捷方式
响应图。要获得更多控制，请使用execute方法并处理响应：
例如：
Mono<Project> projectMono = graphQlClient.document(document)
.execute()
.map(response -> {
if (!response.isValid()) {
// Request failure... (1)
}
ClientResponseField field = response.field("project");
if (!field.hasValue()) {
if (field.getError() != null) {
// Field failure... (2)
}
else {
// Optional field set to null... (3)
}
}
return field.toEntity(Project.class); (4)
});| 1 | 响应没有数据，只有错误 |
| 2 | 字段是null并存在相关错误 |
| 3 | 设置为null通过其DataFetcher |
| 4 | 在给定路径上解码数据 |
文档来源
请求的文档是String可以在局部变量中定义或
常量，或者它可以通过代码生成的请求对象生成。
您还可以创建带有扩展名的文档文件.graphql或.gql下"graphql-documents/"并按文件名引用它们。
例如，给定一个名为projectReleases.graphql在src/main/resources/graphql-documents，内容：
query projectReleases($slug: ID!) {
project(slug: $slug) {
name
releases {
version
}
}
}然后，您可以：
Mono<Project> projectMono = graphQlClient.documentName("projectReleases") (1)
.variable("slug", "spring-framework") (2)
.retrieve()
.toEntity(Project.class);| 1 | 从“projectReleases.graphql”加载文档 |
| 2 | 提供变量值。 |
IntelliJ 的“JS GraphQL”插件支持具有代码补全功能的 GraphQL 查询文件。
您可以使用GraphQlClient 构建器来自定义DocumentSource用于按名称加载文档。
订阅请求
GraphQlClient可以通过支持它的传输执行订阅。只
WebSocket 和 RSocket 传输支持 GraphQL 订阅，因此您需要
创建 WebSocketGraphQlClient 或 RSocketGraphQlClient。
取回
要启动订阅流，请使用retrieveSubscription这类似于检索单个响应，但返回响应流，每个响应都解码为一些数据：
Flux<String> greetingFlux = client.document("subscription { greetings }")
.retrieveSubscription("greeting")
.toEntity(String.class);这Flux可以以SubscriptionErrorException如果订阅从服务器端显示“错误”消息。该异常提供对 GraphQL 错误的访问从“错误”消息解码。
这Flux可能终止GraphQlTransportException如WebSocketDisconnectedException如果底层连接已关闭或丢失。在那个情况下，您可以使用retry运算符以重新启动订阅。
要从客户端结束订阅，请Flux必须取消，反过来WebSocket 传输会向服务器发送一条“完整”消息。如何取消Flux取决于它的使用方式。一些运算符，例如take或timeout他们自己 取消Flux. 如果您订阅了Flux使用Subscriber，您可以获得一个引用Subscription并通过它取消。 这onSubscribe运算符还提供对Subscription.
执行
检索只是从每个响应映射中的单个路径解码的快捷方式。要获得更多控制，请使用executeSubscription方法并直接处理每个响应：
Flux<String> greetingFlux = client.document("subscription { greetings }")
.executeSubscription()
.map(response -> {
if (!response.isValid()) {
// Request failure...
}
ClientResponseField field = response.field("project");
if (!field.hasValue()) {
if (field.getError() != null) {
// Field failure...
}
else {
// Optional field set to null... (3)
}
}
return field.toEntity(String.class)
});拦截
您创建了一个GraphQlClientInterceptor要拦截通过客户端的所有请求：
static class MyInterceptor implements GraphQlClientInterceptor {
@Override
public Mono<ClientGraphQlResponse> intercept(ClientGraphQlRequest request, Chain chain) {
// ...
return chain.next(request);
}
@Override
public Flux<ClientGraphQlResponse> interceptSubscription(ClientGraphQlRequest request, SubscriptionChain chain) {
// ...
return chain.next(request);
}
}创建拦截器后，通过客户端构建器注册它：
URI url = ... ;
WebSocketClient client = ... ;
WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client)
.interceptor(new MyInterceptor())
.build();