聯合

Spring for GraphQL 提供了與 federation-jvm 庫的整合，該庫使用 GraphQL Java 初始化聯合服務圖中的子圖模式。詳情請參閱 Apollo Federation 和 子圖規範。

配置

要啟用此整合，請在配置中宣告一個 FederationSchemaFactory bean，並將其接入 GraphQlSource.Builder。例如，使用 Spring Boot 時

@Configuration
public class FederationConfig {

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

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

現在子圖服務的模式可以擴充套件聯合型別

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

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

@EntityMapping

一個 @EntityMapping 方法可以響應聯合閘道器傳送的 _entities query 查詢來載入聯合型別例項。例如

@Controller
private static class BookController {

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

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

}
1 @Argument 方法引數從實體的 "representation" 輸入對映中解析。完整的 "representation" 輸入 Map 也可以被解析。請參閱 方法簽名 瞭解支援的方法引數和返回值型別。
2 @SchemaMapping 方法可用於圖的其他部分。

一個 @EntityMapping 方法可以批次載入給定型別的聯合實體。為此，請將 @Argument 方法引數宣告為列表，並按相同順序返回相應的實體例項列表。

例如

@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 idList 命名約定有助於去除引數名稱的複數形式，以便在 "representation" 輸入對映中查詢正確的值。您也可以透過註解設定引數名稱。
2 @BatchMapping 方法可用於圖的其他部分。

方法簽名

實體對映方法支援以下引數

方法引數 描述

@Argument

用於訪問 "representation" 輸入對映中的命名值，也可轉換為型別化的 Object。

Map<String, Object>

實體的完整 "representation" 輸入對映。

List<Map<String, Object>>

當使用單個控制器方法載入給定型別的所有實體時，"representation" 輸入對映列表。

@ContextValue

用於訪問 DataFetchingEnvironment 中主 GraphQLContext 的屬性。

@LocalContextValue

用於訪問 DataFetchingEnvironment 中本地 GraphQLContext 的屬性。

GraphQLContext

用於從 DataFetchingEnvironment 訪問上下文。

java.security.Principal

如果可用，從 Spring Security 上下文中獲取。

@AuthenticationPrincipal

用於從 Spring Security 上下文訪問 Authentication#getPrincipal()。

DataFetchingFieldSelectionSet

用於透過 DataFetchingEnvironment 訪問查詢的選擇集。

Locale, Optional<Locale>

用於從 DataFetchingEnvironment 訪問 Locale。

DataFetchingEnvironment

用於直接訪問底層的 DataFetchingEnvironment。

@EntityMapping 方法可以返回 Mono、CompletableFuture、Callable 或實際實體。

異常處理

您可以使用 @GraphQlExceptionHandler 方法將 @EntityMapping 方法中的異常對映到 GraphQLError。這些錯誤將包含在 "_entities" 查詢的響應中。異常處理方法可以位於同一控制器中或 @ControllerAdvice 類中。