Package org.allGraphQLCases.server.impl
Class DataFetchersDelegateIFoo1Impl
java.lang.Object
org.allGraphQLCases.server.impl.DataFetchersDelegateIFoo1Impl
- All Implemented Interfaces:
DataFetchersDelegateIFoo1
@Component
public class DataFetchersDelegateIFoo1Impl
extends Object
implements DataFetchersDelegateIFoo1
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbar
(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, org.dataloader.DataLoader<UUID, SIP_IBar1_SIS> dataLoader, SIP_IFoo1_SIS origin) This method loads the data for IFoo1.bar.batchLoader
(List<UUID> keys, org.dataloader.BatchLoaderEnvironment environment) This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.allGraphQLCases.server.DataFetchersDelegateIFoo1
unorderedReturnBatchLoader
-
Constructor Details
-
DataFetchersDelegateIFoo1Impl
public DataFetchersDelegateIFoo1Impl()
-
-
Method Details
-
bar
public CompletableFuture<SIP_IBar1_SIS> bar(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, org.dataloader.DataLoader<UUID, SIP_IBar1_SIS> dataLoader, SIP_IFoo1_SIS origin) Description copied from interface:DataFetchersDelegateIFoo1
This method loads the data for IFoo1.bar. It may return whatever is accepted by the Spring Controller, that is:- A resolved value of any type (typically, a org.allGraphQLCases.server.SIP_IBar1_SIS)
- Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<org.allGraphQLCases.server.SIP_IBar1_SIS> or a Flux<org.allGraphQLCases.server.SIP_IBar1_SIS>
- Kotlin coroutine and Flow are adapted to Mono and Flux
- java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<org.allGraphQLCases.server.SIP_IBar1_SIS>
- A CompletableFuture<?>, for instance CompletableFuture<org.allGraphQLCases.server.SIP_IBar1_SIS>. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server. The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
- A Publisher (instead of a Flux), for Subscription for instance
- Specified by:
bar
in interfaceDataFetchersDelegateIFoo1
- Parameters:
dataFetchingEnvironment
- The GraphQLDataFetchingEnvironment
. It gives you access to the full GraphQL context for this DataFetcherdataLoader
- TheDataLoader
allows to load several data in one query. It allows to solve the (n+1) queries issues, and greatly optimizes the response time.
You'll find more informations here: https://github.com/graphql-java/java-dataloaderorigin
- The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the bar attribute of the origin, which is an instance of {InterfaceType {name:IFoo1, fields:{Field{name:id, type:ID, params:[]},Field{name:bar, type:IBar1, params:[]}}, comments ""}. It depends on your data modle, but it typically contains the id to use in the query.
-
batchLoader
public List<SIP_IFoo1_SIS> batchLoader(List<UUID> keys, org.dataloader.BatchLoaderEnvironment environment) Description copied from interface:DataFetchersDelegateIFoo1
This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched. This method is used by graphql-java java-dataloader to highly optimize the number of requests to the server, when recursing down through the object associations.
You can find more information on this page: graphql-java batching
Important notes:- The list returned by this method must be sorted in the exact same order as the given keys list. If values are missing (no value for a given key), then the returned list must contain a null value at this key's position.
- One of
batchLoader
orunorderedReturnBatchLoader
must be overriden in the data fetcher implementation. If not, then a NullPointerException will be thrown at runtime, with a proper error message. - If your data storage implementation makes it complex to return values in the same order as the keys list, then it's
easier to override
unorderedReturnBatchLoader
, and let the default implementation ofbatchLoader
order the values
- Specified by:
batchLoader
in interfaceDataFetchersDelegateIFoo1
- Parameters:
keys
- A list of ID's id, for which the matching objects must be returnedenvironment
- The Data Loader environment- Returns:
- A list of IDs
-