对于最新的稳定版本,请使用 Spring Integration 6.4.0! |
GraphQL 支持
Spring 集成提供了用于与 GraphQL 协议交互的通道适配器。 该实现基于 Spring for GraphQL。
您需要将此依赖项包含在您的项目中:
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-graphql</artifactId>
<version>6.3.6</version>
</dependency>
compile "org.springframework.integration:spring-integration-graphql:6.3.6"
GraphQL 出站网关
这是一个扩展,表示出站网关合同,用于执行 GraphQL 或操作并生成其结果。
它需要一个 来执行 ,该执行可以静态配置,也可以通过针对请求消息的 SPEL 表达式进行配置。
这是可选的,也可以静态或通过 SpEL 表达式进行配置。
这 也是可选的,用于参数化操作。
该是可选的,用于 GraphQL Java 库中的操作执行上下文。
可以通过 SPEL 表达式进行配置,并默认为请求消息的 header。GraphQlMessageHandler
AbstractReplyProducingMessageHandler
query
mutation
subscription
org.springframework.graphql.ExecutionGraphQlService
operation
operationName
variablesExpression
locale
executionId
id
如果请求消息的有效负载是 的实例,则不会在 中执行任何设置操作,并且此类输入将按原样用于 。
否则,使用上述 SPEL 表达式根据请求消息确定 , , 和 。ExecutionGraphQlRequest
GraphQlMessageHandler
ExecutionGraphQlService.execute()
operation
operationName
variables
executionId
它是一个反应式流组件,并作为 .
这样的 a 由 output 通道中的框架订阅,或者当 output 通道不是 reactive 时在 asynchronous 中订阅的。
有关如何处理 GraphQL 操作结果的文档。GraphQlMessageHandler
Mono<ExecutionGraphQlResponse>
ExecutionGraphQlService.execute(ExecutionGraphQlRequest)
Mono
ReactiveStreamsSubscribableChannel
AbstractMessageProducingHandler
ExecutionGraphQlResponse
@Bean
GraphQlMessageHandlerSpec graphQlMessageHandlerSpec(ExecutionGraphQlService graphQlService) {
return GraphQl.gateway(graphQlService)
.operation("""
query HeroNameAndFriends($episode: Episode) {
hero(episode: $episode) {
name
friends {
name
}
}
}""")
.variablesExpression("{episode:'JEDI'}");
}
@Bean
IntegrationFlow graphqlQueryMessageHandlerFlow(GraphQlMessageHandler handler) {
return IntegrationFlow.from(MessageChannels.flux("inputChannel"))
.handle(handler)
.channel(c -> c.flux("resultChannel"))
.get();
}
@Bean
ExecutionGraphQlService graphQlService(GraphQlSource graphQlSource) {
return new DefaultExecutionGraphQlService(graphQlSource);
}
@Bean
GraphQlSource graphQlSource(AnnotatedControllerConfigurer annotatedDataFetcherConfigurer) {
return GraphQlSource.builder()
.schemaResources(new ClassPathResource("graphql/test-schema.graphqls"))
.configureRuntimeWiring(annotatedDataFetcherConfigurer)
.build();
}
@Bean
AnnotatedControllerConfigurer annotatedDataFetcherConfigurer() {
return new AnnotatedControllerConfigurer();
}
应对订阅操作的结果进行特殊处理。
在这种情况下,返回必须手动订阅和处理的 a。
或者,它可以通过普通服务激活器平面映射到 :ExecutionGraphQlResponse.getData()
SubscriptionPublisher
FluxMessageChannel
@ServiceActivator(inputChannel = "graphQlResultChannel", outputChannel="graphQlSubscriptionChannel")
public SubscriptionPublisher obtainSubscriptionResult(ExecutionGraphQlResponse graphQlResponse) {
return graphQlResponse.getData();
}
此类出站网关不仅可以用于通过 HTTP 的 GraphQL 请求,还可以用于生成或携带 GraphQL 操作或其消息中的参数的任何上游终端节点。
处理结果可以作为对上游请求的回复生成,也可以发送到下游以便在集成流中进一步处理。GraphQlMessageHandler