此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring GraphQL 1.3.3！spring-doc.cadn.net.cn

请求执行

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

@Configuration(proxyBeanMethods = false)
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
		})

GraphQlSource 部分解释了如何使用 Spring Boot 进行配置。spring-doc.cadn.net.cn

有关 Apollo Federation 的示例，请参见 federation-jvm-spring-example。spring-doc.cadn.net.cn

`RuntimeWiringConfigurer`

您可以使用RuntimeWiringConfigurer要注册：spring-doc.cadn.net.cn

自定义标量类型。spring-doc.cadn.net.cn
处理代码的指令。spring-doc.cadn.net.cn
违约TypeResolver用于接口和联合类型。spring-doc.cadn.net.cn
DataFetcher对于字段，尽管应用程序通常会使用带注释的控制器，并且这些被检测并注册为DataFetchers byAnnotatedControllerConfigurer, 这是一个RuntimeWiringConfigurer.Boot Starter 会自动注册AnnotatedControllerConfigurer.spring-doc.cadn.net.cn

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 = ... ;
		DataFetcher dataFetcher = QuerydslDataFetcher.builder(repository).single();

		return wiringBuilder -> wiringBuilder
				.scalar(scalarType)
				.directiveWiring(directiveWiring)
				.type("Query", builder -> builder.dataFetcher("book", dataFetcher));
	}
}

如果您需要添加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);

GraphQlSource 部分解释了如何使用 Spring Boot 进行配置。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，则不会返回任何数据，并且不会执行任何有用的作。同样，返回的架构类型的字段通过一个作，该作既未通过DataFetcherregistration，也不是默认的PropertyDataFetcher，它会查找匹配的 Java 对象属性，将始终为null.spring-doc.cadn.net.cn

GraphQL Java 不执行检查以确保覆盖每个架构字段，并且可能会导致可能无法发现的差距，具体取决于测试覆盖率。在运行时你可能会得到一个 “静音”null，或者如果字段不可为空，则为 error。作为较低级别库，GraphQL Java 根本不了解DataFetcherimplementations 和它们的返回类型，因此无法将架构类型结构与 Java 对象进行比较结构。spring-doc.cadn.net.cn

Spring for GraphQL 定义了SelfDescribingDataFetcher接口以允许DataFetcher以公开返回类型信息。全部 SpringDataFetcher实现实现此接口。这包括用于 Annotated Controllers 的那些，以及用于 Querydsl 和 Query by Example Spring Data 存储库的那些。对于带注释的 controllers 的 Controllers 中，返回类型派生自@SchemaMapping方法。spring-doc.cadn.net.cn

在启动时，Spring for GraphQL 可以检查架构字段、DataFetcher注册以及从DataFetcher要检查的 implementations 如果所有 schema 字段都被显式注册的DataFetcher或匹配的 Java 对象属性。检查还会执行反向检查，寻找DataFetcher针对不存在的架构字段的注册。spring-doc.cadn.net.cn

要启用架构映射检查，请执行以下作：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)
    Skipped types: [BookOrAuthor] (3)

1	未映射的架构字段及其源类型的列表
2	列表`DataFetcher`在不存在的字段上注册
3	跳过的架构类型列表，如下所述

架构字段检查可以执行的作是有限的，尤其是当存在 Java 类型信息不足。如果带注释的控制器方法是声明返回java.lang.Object，或者如果返回类型具有未指定的泛型参数，例如List<?>，或者如果DataFetcher不实现SelfDescribingDataFetcher返回类型甚至未知。在这种情况下， Java 对象类型结构仍然未知，并且架构类型在生成的报告。对于每个跳过的类型，都会记录一条 DEBUG 消息以说明原因它被跳过了。spring-doc.cadn.net.cn

架构联合类型总是被跳过，因为控制器方法无法在 Java 中声明这样的返回类型，Java 类型结构是未知的。spring-doc.cadn.net.cn

架构接口类型仅支持直接声明的字段，这些字段是与由SelfDescribingDataFetcher. 不检查具体实现上的其他字段。这有待改进在将来的版本中，还要检查 schemainterfaceimplementation types 和 try 在声明的 Java 返回类型的子类型之间查找匹配项。spring-doc.cadn.net.cn

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))

GraphQlSource 部分解释了如何使用 Spring Boot 进行配置。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

响应式数据获取器，它们是适应于CompletionStage如预期AsyncExecutionStrategy.spring-doc.cadn.net.cn
CompletionStage作为返回值。spring-doc.cadn.net.cn
Controller 方法，即 Kotlin 协程方法。spring-doc.cadn.net.cn
@SchemaMapping 和 @BatchMapping 方法可以返回Callable提交到Executor例如 Spring FrameworkVirtualThreadTaskExecutor.要启用此功能，您必须配置Executor上AnnotatedControllerConfigurer.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

上下文传播

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

该规范将模式称为 “连接”。名称以 on Connection 是表示分页结果集的 Connection Type。都~Connection类型包含一个 “edges” 字段，其中~Edgetype 将实际项与游标配对，因为以及带有布尔标志的 “pageInfo” 字段，用于指示是否有更多项目转发和向后。spring-doc.cadn.net.cn

连接类型

Connection必须为每个需要分页的类型创建类型定义，添加样板和干扰添加到架构中。Spring for GraphQL 提供ConnectionTypeDefinitionConfigurer在启动时添加这些类型（如果尚未添加）存在于解析的架构文件中。这意味着在 schema 中，您只需要：spring-doc.cadn.net.cn

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

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

请注意 spec 定义的前向分页参数first和after客户端可以使用请求给定游标之后的前 N 项，而last和before是落后的 pagination 参数来请求给定游标之前的最后 N 项。spring-doc.cadn.net.cn

接下来，配置ConnectionTypeDefinitionConfigurer如下：spring-doc.cadn.net.cn

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

以下类型定义将透明地添加到 schema 中：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`

一旦 Connection Types 在 schema 中可用，您还需要等效的 Java 类型。GraphQL Java 提供了这些 API，包括通用的Connection和Edge以及PageInfo.spring-doc.cadn.net.cn

一种选择是填充Connection并从控制器方法返回它，或者DataFetcher.但是，这需要样板代码来创建Connection, 创建游标，将每个项目包装为Edge，并创建PageInfo. 此外，您可能已经有一个底层的分页机制，例如在使用 Spring Data 存储库。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	创建具有一个或多个`ConnectionAdapter`s.
2	抵制类型的访客。

有内置的 ConnectionAdapters 代表 Spring Data 的Window和Slice.您还可以创建自己的自定义适配器。ConnectionAdapter实现依赖于CursorStrategy自为返回的项目创建游标。相同的策略也用于支持Subrangecontroller 方法参数，其中包含 pagination input 的 API 中。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

注册DataLoader在DataLoaderRegistry，它可以加载给定唯一键的实体。spring-doc.cadn.net.cn
DataFetcher的 can accessDataLoader的 ID 值，并使用它们按 ID 加载实体。spring-doc.cadn.net.cn
一个DataLoader通过返回 future 来延迟加载，以便可以批量完成。spring-doc.cadn.net.cn
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("...");
// ...

请求执行

GraphQLSource

Schema 资源

Schema 创建

RuntimeWiringConfigurer

TypeResolver

指令

ExecutionStrategy

架构转换

架构遍历

Schema 映射检查

Operation Caching

螺纹模型

反应性的DataFetcher

上下文传播

WebMvc 网络

WebFlux的

异常

请求例外

包年包月例外

分页

连接类型

ConnectionAdapter

CursorStrategy

排序

批量加载

DataLoader

BatchLoaderRegistry

测试 Batch Loading

`GraphQLSource`

`RuntimeWiringConfigurer`

`TypeResolver`

`ExecutionStrategy`

反应性的`DataFetcher`

`ConnectionAdapter`

`CursorStrategy`

`DataLoader`

`BatchLoaderRegistry`