请求执行

ExecutionGraphQlService是调用 GraphQL Java 执行的主要 Spring 抽象 请求。底层传输（如 HTTP）委托给ExecutionGraphQlService处理请求。spring-doc.cadn.net.cn

主要实现DefaultExecutionGraphQlService配置了GraphQlSource要访问graphql.GraphQL实例。spring-doc.cadn.net.cn

GraphQLSource

GraphQlSource是一个合约，用于公开graphql.GraphQLinstance 来使用该 包含用于构建该实例的构建器 API。默认构建器可通过GraphQlSource.schemaResourceBuilder().spring-doc.cadn.net.cn

Boot Starter 会创建此构建器的实例并进一步初始化它 要从可配置位置加载 Schema 文件， 公开要应用到的属性GraphQlSource.Builder，以检测RuntimeWiringConfigurerbeans、用于 GraphQL 指标的插桩 bean、 和DataFetcherExceptionResolver和SubscriptionExceptionResolverbean 来解决异常。对于进一步的自定义，您还可以 声明一个GraphQlSourceBuilderCustomizerbean，例如：spring-doc.cadn.net.cn

import org.springframework.boot.autoconfigure.graphql.GraphQlSourceBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class GraphQlConfig {

	@Bean
	public GraphQlSourceBuilderCustomizer sourceBuilderCustomizer() {
		return (builder) ->
				builder.configureGraphQl((graphQlBuilder) ->
						graphQlBuilder.executionIdProvider(new CustomExecutionIdProvider()));
	}

}

Schema 资源

GraphQlSource.Builder可以配置一个或多个Resource实例为 解析并合并在一起。这意味着 schema 文件几乎可以从任何 位置。spring-doc.cadn.net.cn

默认情况下，Boot Starters会查找带有扩展名的 schema 文件 位置下的 “.graphqls” 或 “.gqls”classpath:graphql/**，这通常是src/main/resources/graphql.您还可以使用文件系统位置或任何位置 由 Spring 提供支持Resource层次结构，包括自定义实现 从远程位置、存储或内存加载架构文件。spring-doc.cadn.net.cn

用classpath*:graphql/**/在多个 Classpath 中查找 schema 文件 位置，例如跨多个模块。

Schema 创建

默认情况下，GraphQlSource.Builder使用 GraphQL JavaSchemaGenerator要创建graphql.schema.GraphQLSchema.这适用于典型用途，但如果您需要使用 不同的生成器，你可以注册一个schemaFactory回调：spring-doc.cadn.net.cn

GraphQlSource.Builder builder = ...

builder.schemaResources(..)
		.configureRuntimeWiring(..)
		.schemaFactory((typeDefinitionRegistry, runtimeWiring) -> {
			// create GraphQLSchema
		})

有关如何使用 Spring Boot 进行配置的信息，请参见 GraphQlSource 部分。spring-doc.cadn.net.cn

如果对联合感兴趣，请参阅 Federation 部分。spring-doc.cadn.net.cn

RuntimeWiringConfigurer

一个RuntimeWiringConfigurer对于注册以下内容很有用：spring-doc.cadn.net.cn

Spring 应用程序通常不需要直接执行DataFetcher注册。 相反，控制器方法注册为DataFetcherS 通过AnnotatedControllerConfigurer，它是一个RuntimeWiringConfigurer.
GraphQL Java 服务器应用程序仅将 Jackson 用于与数据映射之间的序列化。 客户端输入被解析为 Map。服务器输出将根据字段选择集组装到地图中。 这意味着您不能依赖 Jackson 序列化/反序列化 Comments。 相反，您可以使用自定义标量类型。

Boot Starter 检测 bean 类型的RuntimeWiringConfigurer和 将它们注册到GraphQlSource.Builder.这意味着在大多数情况下，您将拥有 类似于 this 的配置：spring-doc.cadn.net.cn

@Configuration
public class GraphQlConfig {

	@Bean
	public RuntimeWiringConfigurer runtimeWiringConfigurer(BookRepository repository) {
		GraphQLScalarType scalarType = ... ;
		SchemaDirectiveWiring directiveWiring = ... ;
		return wiringBuilder -> wiringBuilder
				.scalar(scalarType)
				.directiveWiring(directiveWiring);
	}
}

如果您需要添加WiringFactory，例如，进行注册时要考虑到 schema definitions 中，实现替代configure方法，该方法同时接受RuntimeWiring.Builder和一个输出List<WiringFactory>.这允许您添加任何 然后按顺序调用的工厂数。spring-doc.cadn.net.cn

TypeResolver

GraphQlSource.Builder寄存 器ClassNameTypeResolver作为默认值TypeResolver用于尚未进行此类注册的 GraphQL 接口和联合 通过RuntimeWiringConfigurer.目的 一个TypeResolver在 GraphQL 中，Java 用于确定值的 GraphQL 对象类型 从DataFetcher对于 GraphQL Interface （图形QL 接口） 或 Union （联合） 字段。spring-doc.cadn.net.cn

ClassNameTypeResolver尝试将值的简单类名与 GraphQL 匹配 Object 类型，如果不成功，它还会导航其超类型，包括 基类和接口，寻找匹配项。ClassNameTypeResolver提供了一个 选项配置名称提取函数以及Class更改为 GraphQL 对象类型 名称映射应该有助于涵盖更多极端情况：spring-doc.cadn.net.cn

GraphQlSource.Builder builder = ...
ClassNameTypeResolver classNameTypeResolver = new ClassNameTypeResolver();
classNameTypeResolver.setClassNameExtractor((klass) -> {
	// Implement Custom ClassName Extractor here
});
builder.defaultTypeResolver(classNameTypeResolver);

有关如何使用 Spring Boot 进行配置的信息，请参见 GraphQlSource 部分。spring-doc.cadn.net.cn

指令

GraphQL 语言支持“描述替代运行时执行和 GraphQL 文档中的类型验证行为”。指令类似于 Java，但在 GraphQL 文档中的类型、字段、片段和作上声明。spring-doc.cadn.net.cn

GraphQL Java 提供了SchemaDirectiveWiringContract 帮助应用程序检测 和 handle 指令。有关更多详细信息，请参阅 GraphQL Java 文档。spring-doc.cadn.net.cn

在 Spring GraphQL 中，你可以注册一个SchemaDirectiveWiring通过RuntimeWiringConfigurer.Boot Starter 检测到 这样的 bean，所以你可能会有这样的东西：spring-doc.cadn.net.cn

@Configuration
public class GraphQlConfig {

	 @Bean
	 public RuntimeWiringConfigurer runtimeWiringConfigurer() {
		  return builder -> builder.directiveWiring(new MySchemaDirectiveWiring());
	 }

}
有关指令支持的示例，请查看 Graphql Java 库的扩展验证。

ExecutionStrategy

一ExecutionStrategy在 GraphQL 中，Java 驱动请求的字段的获取。 要创建ExecutionStrategy，您需要提供DataFetcherExceptionHandler. 默认情况下，Spring for GraphQL 会创建异常处理程序以使用，如 异常 中所述，并将其设置在GraphQL.Builder.然后，GraphQL Java 使用它来创建AsyncExecutionStrategy实例。spring-doc.cadn.net.cn

如果您需要创建自定义ExecutionStrategy中，您可以检测到DataFetcherExceptionResolvers 并以相同的方式创建异常处理程序，并使用 it 创建自定义ExecutionStrategy.例如，在 Spring Boot 应用程序中：spring-doc.cadn.net.cn

@Bean
GraphQlSourceBuilderCustomizer sourceBuilderCustomizer(
		ObjectProvider<DataFetcherExceptionResolver> resolvers) {

	DataFetcherExceptionHandler exceptionHandler =
			DataFetcherExceptionResolver.createExceptionHandler(resolvers.stream().toList());

	AsyncExecutionStrategy strategy = new CustomAsyncExecutionStrategy(exceptionHandler);

	return sourceBuilder -> sourceBuilder.configureGraphQl(builder ->
			builder.queryExecutionStrategy(strategy).mutationExecutionStrategy(strategy));
}

架构转换

您可以注册一个graphql.schema.GraphQLTypeVisitor通过builder.schemaResources(..).typeVisitorsToTransformSchema(..)如果要遍历 并在创建架构后对其进行转换，然后对架构进行更改。注意事项 这通常比 Schema Traversal 更昂贵 首选遍历而不是转换，除非您需要进行架构更改。spring-doc.cadn.net.cn

架构遍历

您可以注册一个graphql.schema.GraphQLTypeVisitor通过builder.schemaResources(..).typeVisitors(..)如果要在 它已创建，并且可能会将更改应用于GraphQLCodeRegistry.请记住， 但是，此类访客无法更改架构。如果需要更改架构，请参阅 架构转换。spring-doc.cadn.net.cn

Schema 映射检查

如果查询、更改或订阅作没有DataFetcher，则不会 返回任何数据，并且不会执行任何有用的作。同样，以下 schema 类型的字段 两者都没有通过DataFetcher注册，也不隐式由 违约PropertyDataFetcher找到匹配项Classproperties 将始终为null.spring-doc.cadn.net.cn

GraphQL Java 不执行检查以确保覆盖每个架构字段，并且作为 较低级别的库，GraphQL Java 根本不知道DataFetcher可以返回 或它所依赖的参数，因此无法执行此类验证。这可以 导致间隙，根据测试覆盖率，这些间隙可能直到运行时才被发现，当 客户可能会体验到“沉默”null值或非 null 字段错误。spring-doc.cadn.net.cn

这SelfDescribingDataFetcherSpring for GraphQL 的接口允许DataFetcher自 公开返回类型和预期参数等信息。全部内置， 弹簧DataFetcher控制器方法的实现，Querydsl 和 Query by Example 是此接口的实现。对于带注解的控制器，返回类型和 预期参数基于控制器方法签名。这使得它可能 在启动时检查架构映射，以确保满足以下条件：spring-doc.cadn.net.cn

要启用 Schema 检查，请自定义GraphQlSource.Builder如下所示。 在这种情况下，报告只是记录下来，但您可以选择执行任何作：spring-doc.cadn.net.cn

GraphQlSource.Builder builder = ...

builder.schemaResources(..)
		.inspectSchemaMappings(report -> {
			logger.debug(report);
		});

示例报表：spring-doc.cadn.net.cn

GraphQL schema inspection:
    Unmapped fields: {Book=[title], Author[firstName, lastName]} (1)
    Unmapped registrations: {Book.reviews=BookController#reviews[1 args]} (2)
    Unmapped arguments: {BookController#bookSearch[1 args]=[myAuthor]} (3)
    Skipped types: [BookOrAuthor] (4)
1 未以任何方式覆盖的架构字段
2 DataFetcher对不存在的字段的注册
3 DataFetcher不存在的预期参数
4 已跳过的架构类型（接下来将解释）

在某些情况下，Classtype 的 schema 类型为 unknown。也许DataFetcher不 实现SelfDescribingDataFetcher，或者声明的返回类型过于通用 （例如Object） 或未知（例如List<?>） 或DataFetcher可能完全缺失。 在这种情况下，架构类型将列为 skipped，因为无法验证。对于每个 skipped 类型，则会显示一条 DEBUG 消息，说明跳过它的原因。spring-doc.cadn.net.cn

联合和接口

对于联合，检查会迭代成员类型并尝试查找相应的 类。对于接口，检查会迭代实现类型和 Look 对于相应的类。spring-doc.cadn.net.cn

默认情况下，在以下情况下，可以立即检测到相应的 Java 类：spring-doc.cadn.net.cn

在上述帮助中没有，并且 GraphQL 类型在架构检查中报告为跳过 报告，您可以进行以下自定义：spring-doc.cadn.net.cn

  • 将 GraphQL 类型名称显式映射到一个或多个 Java 类。spring-doc.cadn.net.cn

  • 配置一个函数，用于自定义 GraphQL 类型名称如何适应简单的Class名字。这有助于满足特定的 Java 类命名约定。spring-doc.cadn.net.cn

  • 提供ClassNameTypeResolver要映射 GraphQL，请键入 Java 类。spring-doc.cadn.net.cn

例如：spring-doc.cadn.net.cn

GraphQlSource.Builder builder = ...

builder.schemaResources(..)
	.inspectSchemaMappings(
		initializer -> initializer.classMapping("Author", Author.class)
		logger::debug);

Operation Caching

GraphQL Java 必须在执行作之前对其进行解析和验证。这可能会影响 性能显着。为避免需要重新分析和验证，应用程序可以 配置PreparsedDocumentProvider缓存和重用 Document 实例。GraphQL Java 文档提供了有关以下内容的更多详细信息 查询缓存PreparsedDocumentProvider.spring-doc.cadn.net.cn

在 Spring GraphQL 中，你可以注册一个PreparsedDocumentProvider通过GraphQlSource.Builder#configureGraphQl: .spring-doc.cadn.net.cn

// Typically, accessed through Spring Boot's GraphQlSourceBuilderCustomizer
GraphQlSource.Builder builder = ...

// Create provider
PreparsedDocumentProvider provider =
        new ApolloPersistedQuerySupport(new InMemoryPersistedQueryCache(Collections.emptyMap()));

builder.schemaResources(..)
		.configureRuntimeWiring(..)
		.configureGraphQl(graphQLBuilder -> graphQLBuilder.preparsedDocumentProvider(provider))

有关如何使用 Spring Boot 进行配置的信息，请参见 GraphQlSource 部分。spring-doc.cadn.net.cn

螺纹模型

大多数 GraphQL 请求都受益于获取嵌套字段的并发执行。这是 为什么当今大多数应用程序都依赖于 GraphQL Java 的AsyncExecutionStrategy，它允许 要返回的数据获取器CompletionStage以及并发执行而不是串行执行。spring-doc.cadn.net.cn

Java 21 和虚拟线程增加了一个重要的功能，可以有效地使用更多线程，但是 仍然需要并发执行，而不是串行执行，以便请求 执行以更快地完成。spring-doc.cadn.net.cn

Spring for GraphQL 支持：spring-doc.cadn.net.cn

Spring for GraphQL 在 Spring MVC 或 WebFlux 上运行作为传输。Spring MVC 使用异步请求执行，除非生成的CompletableFuture已完成 在 GraphQL Java 引擎返回后立即返回，如果 request 足够简单，不需要异步数据获取。spring-doc.cadn.net.cn

反应性的DataFetcher

默认的GraphQlSourcebuilder 启用对DataFetcher返回Mono或Flux这会将它们调整为CompletableFuture哪里Flux值被聚合 并转换为 List，除非请求是 GraphQL 订阅请求， 在这种情况下，返回值仍然是 Reactive StreamsPublisher用于流媒体 GraphQL 响应。spring-doc.cadn.net.cn

反应式DataFetcher可以依赖对从 传输层，例如从 WebFlux 请求处理，请参阅 WebFlux 上下文。spring-doc.cadn.net.cn

对于订阅请求，GraphQL Java 将在项目 可用，并且已获取其请求的所有字段。因为这涉及几个 层异步数据获取，项目可能会通过网络从其 原始订单。如果您希望 GraphQL Java 缓冲项目并保留原始顺序， 您可以通过设置SubscriptionExecutionStrategy.KEEP_SUBSCRIPTION_EVENTS_ORDEREDconfiguration 标志在GraphQLContext.例如，这可以通过自定义Instrumentation:spring-doc.cadn.net.cn

import graphql.ExecutionResult;
import graphql.execution.SubscriptionExecutionStrategy;
import graphql.execution.instrumentation.InstrumentationContext;
import graphql.execution.instrumentation.InstrumentationState;
import graphql.execution.instrumentation.SimpleInstrumentationContext;
import graphql.execution.instrumentation.SimplePerformantInstrumentation;
import graphql.execution.instrumentation.parameters.InstrumentationExecutionParameters;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class GraphQlConfig {

	@Bean
	public SubscriptionOrderInstrumentation subscriptionOrderInstrumentation() {
		return new SubscriptionOrderInstrumentation();
	}

	static class SubscriptionOrderInstrumentation extends SimplePerformantInstrumentation {

		@Override
		public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters,
																InstrumentationState state) {
			// Enable option for keeping subscription results in upstream order
			parameters.getGraphQLContext().put(SubscriptionExecutionStrategy.KEEP_SUBSCRIPTION_EVENTS_ORDERED, true);
			return SimpleInstrumentationContext.noOp();
		}

	}

}

上下文传播

Spring for GraphQL 支持通过 GraphQL Java 透明地从 HTTP 传输传播上下文，并传递到DataFetcher以及它调用的其他组件。这包括ThreadLocal上下文 从 Spring MVC 请求处理线程和 ReactorContext来自 WebFlux 处理管道。spring-doc.cadn.net.cn

WebMvc 网络

一个DataFetcher和 GraphQL Java 调用的其他组件可能并不总是在 与 Spring MVC 处理程序相同的线程，例如，如果WebGraphQlInterceptor或DataFetcher切换到 不同的线程。spring-doc.cadn.net.cn

Spring for GraphQL 支持传播ThreadLocal来自 Servlet 容器的值 thread 设置为线程 aDataFetcher和其他组件，以 执行时间。为此，应用程序需要实现io.micrometer.context.ThreadLocalAccessor对于ThreadLocal感兴趣的值：spring-doc.cadn.net.cn

public class RequestAttributesAccessor implements ThreadLocalAccessor<RequestAttributes> {

    @Override
    public Object key() {
        return RequestAttributesAccessor.class.getName();
    }

    @Override
    public RequestAttributes getValue() {
        return RequestContextHolder.getRequestAttributes();
    }

    @Override
    public void setValue(RequestAttributes attributes) {
        RequestContextHolder.setRequestAttributes(attributes);
    }

    @Override
    public void reset() {
        RequestContextHolder.resetRequestAttributes();
    }

}

您可以注册一个ThreadLocalAccessor在启动时使用全局ContextRegistry实例，可通过io.micrometer.context.ContextRegistry#getInstance().您也可以注册它 自动通过java.util.ServiceLoader机制。spring-doc.cadn.net.cn

WebFlux的

一个反应性的DataFetcher可以依赖对 Reactor 上下文的访问，该 源自 WebFlux 请求处理链。这包括 Reactor 上下文 由 WebGraphQlInterceptor 组件添加。spring-doc.cadn.net.cn

异常

在 GraphQL Java 中，DataFetcherExceptionHandler决定如何表示异常 在响应的 “errors” 部分中获取数据。应用程序可以注册 仅限单个处理程序。spring-doc.cadn.net.cn

Spring for GraphQL 注册了一个DataFetcherExceptionHandler提供默认 处理并启用DataFetcherExceptionResolver合同。应用程序可以 通过以下方式注册任意数量的解析器GraphQLSourcebuilder 中，这些位于 order 中，直到他们解决Exception更改为List<graphql.GraphQLError>. Spring Boot Starters检测这种类型的 bean。spring-doc.cadn.net.cn

DataFetcherExceptionResolverAdapter是具有受保护方法的便捷基类resolveToSingleError和resolveToMultipleErrors.spring-doc.cadn.net.cn

带注释的控制器编程模型允许使用 具有灵活方法签名的带注释的异常处理程序方法，请参阅@GraphQlExceptionHandler了解详情。spring-doc.cadn.net.cn

一个GraphQLError可以根据 GraphQL Java 分配给类别graphql.ErrorClassification或 Spring GraphQLErrorType，其中定义了以下内容：spring-doc.cadn.net.cn

如果异常仍未解决，则默认情况下，它被归类为INTERNAL_ERROR替换为包含类别名称和executionId从DataFetchingEnvironment.该消息故意不透明以避免泄漏 实现细节。应用程序可以使用DataFetcherExceptionResolver自定义 错误详细信息。spring-doc.cadn.net.cn

未解决的异常将记录在 ERROR 级别，并且executionId关联 发送到客户端的错误。已解决的异常记录在 DEBUG 级别。spring-doc.cadn.net.cn

请求例外

GraphQL Java 引擎在解析请求时可能会遇到验证或其他错误 这反过来又会阻止请求执行。在这种情况下，响应包含 “data” 键替换为null以及一个或多个请求级 “错误” 是全局的，即 not 具有字段路径。spring-doc.cadn.net.cn

DataFetcherExceptionResolver无法处理此类全局错误，因为它们是引发的 在执行开始之前和任何DataFetcher被调用。应用程序可以使用 传输级拦截器来检查和转换ExecutionResult. 请参阅下面的示例WebGraphQlInterceptor.spring-doc.cadn.net.cn

包年包月例外

这Publisher，订阅请求可能会完成并显示错误信号，在这种情况下 底层传输（例如 WebSocket）发送带有列表的最终 “error” 类型消息 的 GraphQL 错误。spring-doc.cadn.net.cn

DataFetcherExceptionResolver无法解决订阅中的错误Publisher, 由于数据DataFetcher仅创建Publisher最初。之后， transport 订阅Publisher然后可能会以错误结束。spring-doc.cadn.net.cn

应用程序可以注册SubscriptionExceptionResolver为了解决 订阅中的异常Publisher为了解决 GraphQL 错误 以发送到客户端。spring-doc.cadn.net.cn

分页

GraphQL 游标连接规范定义了一种导航大型结果集的方法，方法是一次返回 每个项目都与一个游标配对，客户端可以使用该游标来请求更多项目 或在引用的项之后。spring-doc.cadn.net.cn

该规范将此模式称为 “Connections”，名称以 跟~Connection是表示分页结果集的连接类型。 所有连接类型都包含一个名为 “edges” 的字段，其中~Edgetype 包含 实际项目、光标和一个名为 “pageInfo” 的字段，该字段指示如果 项存在 forward 和 backward。spring-doc.cadn.net.cn

连接类型

连接类型需要 Spring for GraphQL 的ConnectionTypeDefinitionConfigurer可以在启动时透明地添加（如果未明确添加） 宣布。这意味着您只需要以下内容，连接和边缘类型将 为您添加：spring-doc.cadn.net.cn

Query {
	books(first:Int, after:String, last:Int, before:String): BookConnection
}

type Book {
	id: ID!
	title: String!
}

定义的 specfirst和after前向分页的参数允许客户端 请求给定游标“之后”的“第一个”N 项。同样，last和before向后分页参数的参数允许请求 “last” N items “before” 给定的游标。spring-doc.cadn.net.cn

该规范不鼓励同时包括first和last并说明结果 因为分页变得不清楚。在 Spring for GraphQL 中，如果first或after存在， 然后last和before被忽略。

要生成连接类型，请配置ConnectionTypeDefinitionConfigurer如下：spring-doc.cadn.net.cn

GraphQlSource.schemaResourceBuilder()
		.schemaResources(..)
		.typeDefinitionConfigurer(new ConnectionTypeDefinitionConfigurer)

上面将添加以下类型定义：spring-doc.cadn.net.cn

type BookConnection {
	edges: [BookEdge]!
	pageInfo: PageInfo!
}

type BookEdge {
	node: Book!
	cursor: String!
}

type PageInfo {
	hasPreviousPage: Boolean!
	hasNextPage: Boolean!
	startCursor: String
	endCursor: String
}

Boot Starter 寄存器ConnectionTypeDefinitionConfigurer默认情况下。spring-doc.cadn.net.cn

ConnectionAdapter

除了架构中的连接类型之外， 您还需要等效的 Java 类型。GraphQL Java 提供了这些 API，包括通用的Connection和Edgetypes 和PageInfo.spring-doc.cadn.net.cn

您可以返回Connection从控制器方法，但它需要样板代码 调整底层数据分页机制Connection、创建游标、 加~Edgewrappers 并创建一个PageInfo.spring-doc.cadn.net.cn

Spring for GraphQL 定义了ConnectionAdaptercontract 来调整 items 的容器 自Connection.适配器从DataFetcherdecorator 的 由ConnectionFieldTypeVisitor.您可以按如下方式对其进行配置：spring-doc.cadn.net.cn

ConnectionAdapter adapter = ... ;
GraphQLTypeVisitor visitor = ConnectionFieldTypeVisitor.create(List.of(adapter)) (1)

GraphQlSource.schemaResourceBuilder()
		.schemaResources(..)
		.typeDefinitionConfigurer(..)
		.typeVisitors(List.of(visitor)) (2)
1 创建具有一个或多个ConnectionAdapters.
2 抵制类型的访客。

有内置的 ConnectionAdapters 对于 Spring Data 的Window和Slice.您还可以创建自己的自定义适配器。ConnectionAdapter实现依赖于CursorStrategy自 为返回的项目创建游标。相同的策略也用于支持Subrange控制器方法 参数。spring-doc.cadn.net.cn

CursorStrategy

CursorStrategy是一个合约，用于对引用 项在大型结果集中的位置。游标可以基于索引或 在键集上。spring-doc.cadn.net.cn

一个ConnectionAdapter使用它来对返回项目的游标进行编码。带注释的 Controllers 方法、Querydsl 存储库和 Query by Example 存储库使用它来解码分页请求中的游标，并创建一个Subrange.spring-doc.cadn.net.cn

CursorEncoder是一个相关的合约，它进一步编码和解码 String 游标为 使它们对客户不透明。EncodingCursorStrategy结合CursorStrategy替换为CursorEncoder.您可以使用Base64CursorEncoder,NoOpEncoder或创建自己的。spring-doc.cadn.net.cn

有一个内置的 CursorStrategy对于 Spring DataScrollPosition.Boot Starter 注册一个CursorStrategy<ScrollPosition>跟Base64Encoder当 Spring Data 存在时。spring-doc.cadn.net.cn

排序

在 GraphQL 请求中没有提供排序信息的标准方法。然而 分页取决于稳定的排序顺序。您可以使用默认订单，或者其他方式 公开输入类型并从 GraphQL 参数中提取排序详细信息。spring-doc.cadn.net.cn

内置了对 Spring Data 的Sort作为控制器 method 参数。要使其正常工作，您需要有一个SortStrategy豆。spring-doc.cadn.net.cn

批量加载

给定一个Book及其Author，我们可以创建一个DataFetcher一本书和另一本书 对于它的作者。这允许选择有作者或无作者的书籍，但这意味着书籍 和 authors 不会一起加载，这在查询多个 books 作为每本书的作者是单独加载的。这称为 N+1 选择 问题。spring-doc.cadn.net.cn

DataLoader

GraphQL Java 提供了一个DataLoader用于批量加载相关实体的机制。 您可以在 GraphQL Java 文档中找到完整的详细信息。下面是一个 工作原理摘要：spring-doc.cadn.net.cn

  1. 注册DataLoader在DataLoaderRegistry，它可以加载给定唯一键的实体。spring-doc.cadn.net.cn

  2. DataFetcher的 can accessDataLoader的 ID 值，并使用它们按 ID 加载实体。spring-doc.cadn.net.cn

  3. 一个DataLoader通过返回 future 来延迟加载，以便可以批量完成。spring-doc.cadn.net.cn

  4. DataLoader维护加载实体的每个请求缓存，该缓存可以进一步 提高效率。spring-doc.cadn.net.cn

BatchLoaderRegistry

GraphQL Java 中的完整批处理加载机制需要实现以下之一 几个BatchLoader接口，然后将它们包装并注册为DataLoaders ，名称位于DataLoaderRegistry.spring-doc.cadn.net.cn

Spring GraphQL 中的 API 略有不同。对于注册，只有一个 中央BatchLoaderRegistry公开工厂方法和构建器以创建和 注册任意数量的批量加载函数：spring-doc.cadn.net.cn

@Configuration
public class MyConfig {

	public MyConfig(BatchLoaderRegistry registry) {

		registry.forTypePair(Long.class, Author.class).registerMappedBatchLoader((authorIds, env) -> {
				// return Mono<Map<Long, Author>
		});

		// more registrations ...
	}

}

Boot Starter 声明了一个BatchLoaderRegistry你可以注入的 bean 您的配置，如上所示，或按顺序放入任何组件（如控制器） 注册批量加载函数。反过来，BatchLoaderRegistry被注入DefaultExecutionGraphQlService确保DataLoader每个请求的注册数。spring-doc.cadn.net.cn

默认情况下，DataLoadername 基于目标实体的类名。 这允许@SchemaMapping方法声明具有泛型类型的 DataLoader 参数，以及 无需指定名称。但是，可以通过BatchLoaderRegistrybuilder（如有必要）以及其他DataLoaderOptions.spring-doc.cadn.net.cn

配置默认DataLoaderOptions全局，以用作任何 registration，您可以覆盖 Boot 的BatchLoaderRegistrybean 并使用构造函数 为DefaultBatchLoaderRegistry接受Supplier<DataLoaderOptions>.spring-doc.cadn.net.cn

在许多情况下，在加载相关实体时，您可以使用 @BatchMapping 控制器方法，这是一种快捷方式 for 并替换需要使用BatchLoaderRegistry和DataLoader径直。spring-doc.cadn.net.cn

BatchLoaderRegistry还提供其他重要的好处。它支持访问 一样GraphQLContextfrom batch loading functions 和 from@BatchMapping方法 以及确保对它们的上下文传播。这就是预期应用的原因 以使用它。可以执行你自己的DataLoaderregistrations 直接注册，但 此类注册将放弃上述好处。spring-doc.cadn.net.cn

测试 Batch Loading

首先BatchLoaderRegistry在DataLoaderRegistry:spring-doc.cadn.net.cn

BatchLoaderRegistry batchLoaderRegistry = new DefaultBatchLoaderRegistry();
// perform registrations...

DataLoaderRegistry dataLoaderRegistry = DataLoaderRegistry.newRegistry().build();
batchLoaderRegistry.registerDataLoaders(dataLoaderRegistry, graphQLContext);

现在您可以访问和测试个人DataLoader如下所示：spring-doc.cadn.net.cn

DataLoader<Long, Book> loader = dataLoaderRegistry.getDataLoader(Book.class.getName());
loader.load(1L);
loader.loadMany(Arrays.asList(2L, 3L));
List<Book> books = loader.dispatchAndJoin(); // actual loading

assertThat(books).hasSize(3);
assertThat(books.get(0).getName()).isEqualTo("...");
// ...