Introduce GraphQlArgumentBinder.Options

Container for the growing list of configuration options to avoid
having to declare and pass them individually from
AnnotatedControllerConfigurer and FederationSchemaFactory.

See gh-1146

Author: rstoyanchev

spring-graphql/src/main/java/org/springframework/graphql/data/GraphQlArgumentBinder.java

@@ -82,31 +82,51 @@ public class GraphQlArgumentBinder {
 	private final boolean fallBackOnDirectFieldAccess;
 
 
+	/**
+	 * Default constructor.
+	 */
 	public GraphQlArgumentBinder() {
-		this(null);
+		this((Options) null);
 	}
 
+	/**
+	 * Constructor with additional flag for direct field access support.
+	 * @param conversionService the service to use
+	 * @deprecated in favor of {@link #GraphQlArgumentBinder(Options)}
+	 */
+	@Deprecated(since = "2.0", forRemoval = true)
 	public GraphQlArgumentBinder(@Nullable ConversionService conversionService) {
 		this(conversionService, false);
 	}
 
-	public GraphQlArgumentBinder(@Nullable ConversionService conversionService, boolean fallBackOnDirectFieldAccess) {
-		this.typeConverter = initTypeConverter(conversionService);
+	/**
+	 * Constructor with additional flag for direct field access support.
+	 * @param service the service to use
+	 * @param fallBackOnDirectFieldAccess whether to fall back on direct field access
+	 * @deprecated in favor of {@link #GraphQlArgumentBinder(Options)}
+	 */
+	@Deprecated(since = "2.0", forRemoval = true)
+	public GraphQlArgumentBinder(@Nullable ConversionService service, boolean fallBackOnDirectFieldAccess) {
+		this.typeConverter = initTypeConverter(service);
 		this.fallBackOnDirectFieldAccess = fallBackOnDirectFieldAccess;
 	}
 
-	private static @Nullable SimpleTypeConverter initTypeConverter(@Nullable ConversionService conversionService) {
-		if (conversionService == null) {
+	public GraphQlArgumentBinder(@Nullable Options options) {
+		this.typeConverter = ((options != null) ? initTypeConverter(options.conversionService()) : null);
+		this.fallBackOnDirectFieldAccess = (options != null && options.fallBackOnDirectFieldAccess());
+	}
+
+	private static @Nullable SimpleTypeConverter initTypeConverter(@Nullable ConversionService service) {
+		if (service == null) {
 			//  Not thread-safe when using PropertyEditors
 			return null;
 		}
 		SimpleTypeConverter typeConverter = new SimpleTypeConverter();
-		typeConverter.setConversionService(conversionService);
+		typeConverter.setConversionService(service);
 		return typeConverter;
 	}
 
 
-
 	/**
 	 * Create and populate an Object of the given target type, from a single
 	 * GraphQL argument, or from the full GraphQL arguments map.
@@ -375,6 +395,58 @@ private void bindViaSetters(Object target,
 	}
 
 
+	/**
+	 * Container of configuration settings for {@link GraphQlArgumentBinder}.
+	 * @since 2.0.0
+	 */
+	public static final class Options {
+
+		private final @Nullable ConversionService conversionService;
+
+		private final boolean fallBackOnDirectFieldAccess;
+
+		private Options(@Nullable ConversionService conversionService, boolean fallBackOnDirectFieldAccess) {
+			this.conversionService = conversionService;
+			this.fallBackOnDirectFieldAccess = fallBackOnDirectFieldAccess;
+		}
+
+		/**
+		 * Add a {@link ConversionService} to apply type conversion to argument
+		 * values where needed.
+		 * @param service the service to use
+		 */
+		public Options conversionService(@Nullable ConversionService service) {
+			return new Options(service, this.fallBackOnDirectFieldAccess);
+		}
+
+		/**
+		 * Whether binding GraphQL arguments onto
+		 * {@link org.springframework.graphql.data.method.annotation.Argument @Argument}
+		 * should falls back to direct field access in case the target object does
+		 * not use accessor methods.
+		 * @param fallBackOnDirectFieldAccess whether to fall back on direct field access
+		 */
+		public Options fallBackOnDirectFieldAccess(boolean fallBackOnDirectFieldAccess) {
+			return new Options(this.conversionService, fallBackOnDirectFieldAccess);
+		}
+
+		public @Nullable ConversionService conversionService() {
+			return this.conversionService;
+		}
+
+		public boolean fallBackOnDirectFieldAccess() {
+			return this.fallBackOnDirectFieldAccess;
+		}
+
+		/**
+		 * Create an instance without any options set.
+		 */
+		public static Options create() {
+			return new Options(null, false);
+		}
+	}
+
+
 	/**
 	 * Subclass of {@link AbstractBindingResult} that doesn't have a target Object,
 	 * and takes the raw value as input when recording errors.

spring-graphql/src/main/java/org/springframework/graphql/data/federation/FederationSchemaFactory.java

@@ -117,8 +117,7 @@ protected HandlerMethodArgumentResolverComposite initArgumentResolvers() {
 
 		HandlerMethodArgumentResolverComposite resolvers = new HandlerMethodArgumentResolverComposite();
 
-		GraphQlArgumentBinder argumentBinder =
-				new GraphQlArgumentBinder(getConversionService(), isFallBackOnDirectFieldAccess());
+		GraphQlArgumentBinder argumentBinder = new GraphQlArgumentBinder(getBinderOptions());
 
 		// Annotation based
 		resolvers.addResolver(new ContextValueMethodArgumentResolver());

spring-graphql/src/main/java/org/springframework/graphql/data/method/annotation/support/AnnotatedControllerConfigurer.java

@@ -169,8 +169,7 @@ protected HandlerMethodArgumentResolverComposite initArgumentResolvers() {
 			resolvers.addResolver(new ProjectedPayloadMethodArgumentResolver(obtainApplicationContext()));
 		}
 
-		GraphQlArgumentBinder argumentBinder =
-				new GraphQlArgumentBinder(getConversionService(), isFallBackOnDirectFieldAccess());
+		GraphQlArgumentBinder argumentBinder = new GraphQlArgumentBinder(getBinderOptions());
 
 		resolvers.addResolver(new ArgumentMethodArgumentResolver(argumentBinder));
 		resolvers.addResolver(new ArgumentsMethodArgumentResolver(argumentBinder));

spring-graphql/src/main/java/org/springframework/graphql/data/method/annotation/support/AnnotatedControllerDetectionSupport.java

@@ -25,6 +25,7 @@
 import java.util.Set;
 import java.util.concurrent.Callable;
 import java.util.concurrent.Executor;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
 
 import graphql.schema.DataFetcher;
@@ -44,6 +45,7 @@
 import org.springframework.format.FormatterRegistrar;
 import org.springframework.format.support.DefaultFormattingConversionService;
 import org.springframework.format.support.FormattingConversionService;
+import org.springframework.graphql.data.GraphQlArgumentBinder;
 import org.springframework.graphql.data.method.HandlerMethod;
 import org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite;
 import org.springframework.graphql.execution.DataFetcherExceptionResolver;
@@ -86,9 +88,8 @@ public abstract class AnnotatedControllerDetectionSupport<M> implements Applicat
 	protected final Log logger = LogFactory.getLog(getClass());
 
 
-	private final FormattingConversionService conversionService = new DefaultFormattingConversionService();
-
-	private boolean fallBackOnDirectFieldAccess;
+	private GraphQlArgumentBinder.Options binderOptions = GraphQlArgumentBinder.Options.create()
+			.conversionService(new DefaultFormattingConversionService());
 
 	private @Nullable AnnotatedControllerExceptionResolver exceptionResolver;
 
@@ -102,19 +103,51 @@ public abstract class AnnotatedControllerDetectionSupport<M> implements Applicat
 	private @Nullable ApplicationContext applicationContext;
 
 
+	/**
+	 * Callback to configure options for binding GraphQL arguments to target objects.
+	 * @param binderOptionsConsumer consumer to customize options with
+	 * @since 2.0.0
+	 */
+	public void configureBinder(Consumer<GraphQlArgumentBinder.Options> binderOptionsConsumer) {
+		binderOptionsConsumer.accept(this.binderOptions);
+	}
+
+	/**
+	 * Set the options to use for binding GraphQL arguments to target objects.
+	 * @param binderOptions the options to use
+	 * @since 2.0.0
+	 */
+	public void setBinderOptions(GraphQlArgumentBinder.Options binderOptions) {
+		this.binderOptions = binderOptions;
+	}
+
+	protected GraphQlArgumentBinder.Options getBinderOptions() {
+		return this.binderOptions;
+	}
+
 	/**
 	 * Add a {@code FormatterRegistrar} to customize the {@link ConversionService}
 	 * that assists in binding GraphQL arguments onto
 	 * {@link org.springframework.graphql.data.method.annotation.Argument @Argument}
 	 * annotated method parameters.
 	 * @param registrar the formatter registrar
+	 * @deprecated in favor of {@link #configureBinder(Consumer)}
 	 */
+	@Deprecated(since = "2.0", forRemoval = true)
 	public void addFormatterRegistrar(FormatterRegistrar registrar) {
-		registrar.registerFormatters(this.conversionService);
+		if (this.binderOptions.conversionService() instanceof FormattingConversionService fcs) {
+			registrar.registerFormatters(fcs);
+			return;
+		}
+		throw new IllegalStateException("Expected FormattingConversionService");
 	}
 
+	@Deprecated(since = "2.0", forRemoval = true)
 	protected FormattingConversionService getConversionService() {
-		return this.conversionService;
+		if (this.binderOptions.conversionService() instanceof FormattingConversionService fcs) {
+			return fcs;
+		}
+		throw new IllegalStateException("Expected FormattingConversionService");
 	}
 
 	/**
@@ -123,14 +156,16 @@ protected FormattingConversionService getConversionService() {
 	 * should falls back to direct field access in case the target object does
 	 * not use accessor methods.
 	 * @param fallBackOnDirectFieldAccess whether binding should fall back on direct field access
-	 * @since 1.2.0
+	 * @deprecated in favor of {@link #configureBinder(Consumer)}
 	 */
+	@Deprecated(since = "2.0", forRemoval = true)
 	public void setFallBackOnDirectFieldAccess(boolean fallBackOnDirectFieldAccess) {
-		this.fallBackOnDirectFieldAccess = fallBackOnDirectFieldAccess;
+		this.binderOptions = this.binderOptions.fallBackOnDirectFieldAccess(fallBackOnDirectFieldAccess);
 	}
 
+	@Deprecated(since = "2.0", forRemoval = true)
 	protected boolean isFallBackOnDirectFieldAccess() {
-		return this.fallBackOnDirectFieldAccess;
+		return this.binderOptions.fallBackOnDirectFieldAccess();
 	}
 
 	/**

spring-graphql/src/test/java/org/springframework/graphql/data/GraphQlArgumentBinderTests.java

@@ -57,7 +57,8 @@ class GraphQlArgumentBinderTests {
 
 	private final ObjectMapper mapper = new ObjectMapper();
 
-	private final GraphQlArgumentBinder binder = new GraphQlArgumentBinder(new DefaultFormattingConversionService());
+	private final GraphQlArgumentBinder binder = new GraphQlArgumentBinder(
+			GraphQlArgumentBinder.Options.create().conversionService(new DefaultFormattingConversionService()));
 
 
 	@Test

spring-graphql/src/test/java/org/springframework/graphql/data/method/annotation/support/ArgumentMethodArgumentResolverTests.java

@@ -42,7 +42,8 @@
 class ArgumentMethodArgumentResolverTests extends ArgumentResolverTestSupport {
 
 	private final HandlerMethodArgumentResolver resolver = new ArgumentMethodArgumentResolver(
-			new GraphQlArgumentBinder(new DefaultFormattingConversionService()));
+			new GraphQlArgumentBinder(GraphQlArgumentBinder.Options.create()
+					.conversionService(new DefaultFormattingConversionService())));
 
 
 	@Test

spring-graphql/src/test/java/org/springframework/graphql/data/method/annotation/support/ArgumentsMethodArgumentResolverTests.java

@@ -42,7 +42,8 @@
 class ArgumentsMethodArgumentResolverTests extends ArgumentResolverTestSupport {
 
 	private final HandlerMethodArgumentResolver resolver = new ArgumentsMethodArgumentResolver(
-			new GraphQlArgumentBinder(new DefaultFormattingConversionService()));
+			new GraphQlArgumentBinder(GraphQlArgumentBinder.Options.create()
+					.conversionService(new DefaultFormattingConversionService())));
 
 
 	@Test