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

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

Spring for GraphQL 为 federation-jvm 库提供了一个集成，该库使用 GraphQL Java，用于初始化联合服务图中子图的架构。 有关详细信息，请参阅 Apollo Federation 和 Subgraph 规范。spring-doc.cn

配置

要启用集成，请在配置中声明一个 Bean，然后将 它变成 。例如，使用 Spring Boot：FederationSchemaFactoryGraphQlSource.Builderspring-doc.cn

@Configuration
public class FederationConfig {

	@Bean
	public GraphQlSourceBuilderCustomizer customizer(FederationSchemaFactory factory) {
		return builder -> builder.schemaFactory(factory::createGraphQLSchema);
	}

	@Bean
	public FederationSchemaFactory schemaFactory() {
		return new FederationSchemaFactory();
	}
}

现在，子图服务的架构可以扩展联合类型：spring-doc.cn

type Book @key(fields: "id") @extends {
    id: ID! @external
    author: Author
}

type Author {
    id: ID
    firstName: String
    lastName: String
}

@EntityMapping

方法可以加载联合类型实例以响应来自 Federation Gateway 的 _entities 查询。例如：@EntityMappingspring-doc.cn

例如：spring-doc.cn

@Controller
private static class BookController {

	@EntityMapping
	public Book book(@Argument int id) { (1)
		// ...
	}

	@SchemaMapping
	public Author author(Book book) { (2)
		// ...
	}

}
1 method 参数是从 实体。也可以解析完整的 “representation” 输入。请参阅支持的方法签名 method 参数和返回值类型。@ArgumentMap
2 @SchemaMapping方法可用于图形的其余部分。

方法可以批量加载给定类型的联合实体。为此， 将 method 参数声明为 List，并返回相应的实体 实例作为列表。@EntityMapping@Argumentspring-doc.cn

例如：spring-doc.cn

@Controller
private static class BookController {

	@EntityMapping
	public List<Book> book(@Argument List<Integer> idList) { (1)
		// ... return books in the same order
	}

	@BatchMapping
	public Map<Book, Author> author(List<Book> books) { (2)
		// ...
	}
}
1 命名约定有助于将参数名称去复数化，以便 在 “representation” input map 中查找正确的值。您还可以设置 argument name 的 Bean S 的 Intent S 的idList
2 @BatchMapping方法可用于图形的其余部分。

方法签名

实体映射方法支持以下参数：spring-doc.cn

方法参数 描述

@Argumentspring-doc.cn

用于从 “representation” 输入映射访问命名值，也转换为类型化 Object。spring-doc.cn

Map<String, Object>spring-doc.cn

实体的完整 “representation” 输入映射。spring-doc.cn

List<Map<String, Object>>spring-doc.cn

使用单个控制器方法加载时的 “representation” input maps 列表 给定类型的所有实体。spring-doc.cn

@ContextValuespring-doc.cn

要从 中的主 访问属性。GraphQLContextDataFetchingEnvironmentspring-doc.cn

@LocalContextValuespring-doc.cn

要从 中的本地访问属性。GraphQLContextDataFetchingEnvironmentspring-doc.cn

GraphQLContextspring-doc.cn

要从 .DataFetchingEnvironmentspring-doc.cn

java.security.Principalspring-doc.cn

从 Spring Security 上下文获取（如果可用）。spring-doc.cn

@AuthenticationPrincipalspring-doc.cn

用于从 Spring Security 上下文访问。Authentication#getPrincipal()spring-doc.cn

DataFetchingFieldSelectionSetspring-doc.cn

要通过 .DataFetchingEnvironmentspring-doc.cn

Locale,Optional<Locale>spring-doc.cn

要从 访问 。LocaleDataFetchingEnvironmentspring-doc.cn

DataFetchingEnvironmentspring-doc.cn

要直接访问底层 .DataFetchingEnvironmentspring-doc.cn

@EntityMapping方法可以返回 、 、 或 实际实体。MonoCompletableFutureCallablespring-doc.cn

异常处理

您可以使用 methods 将异常从 methods 映射到 's。这些错误将包含在 “_entities” 查询。异常处理程序方法可以位于同一控制器或类中。@GraphQlExceptionHandler@EntityMappingGraphQLError@ControllerAdvicespring-doc.cn

1 method 参数是从 实体。也可以解析完整的 “representation” 输入。请参阅支持的方法签名 method 参数和返回值类型。@ArgumentMap
2 @SchemaMapping方法可用于图形的其余部分。
1 命名约定有助于将参数名称去复数化，以便 在 “representation” input map 中查找正确的值。您还可以设置 argument name 的 Bean S 的 Intent S 的idList
2 @BatchMapping方法可用于图形的其余部分。
方法参数 描述

@Argumentspring-doc.cn

用于从 “representation” 输入映射访问命名值，也转换为类型化 Object。spring-doc.cn

Map<String, Object>spring-doc.cn

实体的完整 “representation” 输入映射。spring-doc.cn

List<Map<String, Object>>spring-doc.cn

使用单个控制器方法加载时的 “representation” input maps 列表 给定类型的所有实体。spring-doc.cn

@ContextValuespring-doc.cn

要从 中的主 访问属性。GraphQLContextDataFetchingEnvironmentspring-doc.cn

@LocalContextValuespring-doc.cn

要从 中的本地访问属性。GraphQLContextDataFetchingEnvironmentspring-doc.cn

GraphQLContextspring-doc.cn

要从 .DataFetchingEnvironmentspring-doc.cn

java.security.Principalspring-doc.cn

从 Spring Security 上下文获取（如果可用）。spring-doc.cn

@AuthenticationPrincipalspring-doc.cn

用于从 Spring Security 上下文访问。Authentication#getPrincipal()spring-doc.cn

DataFetchingFieldSelectionSetspring-doc.cn

要通过 .DataFetchingEnvironmentspring-doc.cn

Locale,Optional<Locale>spring-doc.cn

要从 访问 。LocaleDataFetchingEnvironmentspring-doc.cn

DataFetchingEnvironmentspring-doc.cn

要直接访问底层 .DataFetchingEnvironmentspring-doc.cn