Package com.graphql_java_generator.gradleplugin

Class GenerateServerCodeTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.graphql_java_generator.gradleplugin.CommonTask
com.graphql_java_generator.gradleplugin.GenerateCodeCommonTask
com.graphql_java_generator.gradleplugin.GenerateServerCodeTask
All Implemented Interfaces:
com.graphql_java_generator.plugin.conf.CommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration, Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
Direct Known Subclasses:
GraphQLGenerateCodeTask
public class GenerateServerCodeTask extends GenerateCodeCommonTask implements com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

The generateServerCode Maven goal (and Gradle task) generates the java code for an almost ready to start GraphQL server. The developer has only to develop request to the data.

The java code is generated from one or more GraphQL schemas. It allows to work in Java with graphQL, in a schema first approach. These items are generated:

  • the main method (in a jar project) or the main servlet (in a war project)
  • All the GraphQL wiring, based on graphql-java-spring, itself being build on top of graphql-java
  • All the POJOs, that contain the incoming request contents. The request response is written by the user code into these POJO, and the plugin take care of mapping them into the server response.
  • An option allows to annotate the POJOs with the standard JPA annotations, to make it easy to link with a database. Please note that a
  • All the interfaces for the DataFetchersDelegate (named providers in the graphql.org presentation) that the server needs to implement

The specific code that needs to be implemented is the access to the Data: your database, other APIs or web services, or any kind of storage you may have. This is done by implementing the interfaces for the DataFetchersDelegate into a Spring component, that is:

  • Create a class for each generated DataFetchersDelegate interface
  • Make it implement the relevant DataFetchersDelegate interface
  • Mark it with the Component annotation

And you're done! :)

You'll find more info in the tutorials: take a look at the Maven server tutorial or the Gradle server tutorial

Note: The attribute have no default values: their default values is read from the GenerateCodeCommonExtension, whose attributes can be either the default value, or a value set in the build script.

  • Field Details

    • generateBatchMappingDataFetchers

      public Boolean generateBatchMappingDataFetchers

      If this parameter is set to true, the spring GraphQL controller methods will be annotated with the @BatchMapping (instead of the @SchemaMapping). This allows to manage the of the N+1 select problem: so this allows much better performances, by highly diminishing the number of executed requests (avoid to execute several times the same "sub-query")

      When setting this parameter to true, the main changes are:

      • The @BatchMapping annotation may be applied to all data fetchers without argument(s) that return either a List, a Type, an Interface or an Union.
      • The return type must be defined in the controller: it may not be `Object`, as spring-graphql builds the proper BatchLoader while loading the controllers, when the server starts. The return type for this method is managed by the batchMappingMethodReturnType plugin parameter
      • DataLoader is managed transparently by spring (instead of having to declare it in the generated controller, and having it as a parameter in the generated data fetchers)
      • The batch mapping is generalized on all data fetchers
      • The DataFetchersDelegate method's signature changes
      • The generateBatchLoaderEnvironment, generateDataFetcherForEveryFieldsWithArguments and generateDataLoaderForLists plugin parameters are ignored

      A typical method signature for a data fetcher would be as below, where the return type is controller by the batchMappingMethodReturnType plugin parameter : 

       public Flux topics(//
                BatchLoaderEnvironment batchLoaderEnvironment, //
                GraphQLContext graphQLContext, //
                List boards);

      Please note that the @BatchMapping annotation is a shortcut to avoid boilerplate code, for the most common cases. See this discussion for more information on this. For most complex cases, the use of a DataLoader is recommended by the spring-graphql case. And in these cases, the plugin will generate a method with the @SchemaMapping annotation

    • ignoredSpringMappings

      public String ignoredSpringMappings

      This parameter marks a list of GraphQL mappings as ignored, so that they are not generated by the plugin. These ignored mappings can then be defined by the specific implementation.

      The other way to it is to create a spring GraphQL Controller, that overrides the controller generated by the plugin. But this may lead to this error: Ambiguous mapping. Cannot map 'xxxController' method [...] to 'Type.field': there is already 'yyy' bean method [...] mapped.

      The parameter may contain:

      • The '*' character: this would mark all controllers and DataFetchersDeleagate to be ignored. That is: none would be generated, and it's up to the specific implementation to manage them. In this mode, you still benefit of the POJO generation, the type wiring, the custom scalars mapping...
      • A list of:
        • GraphQL type name: The full controller class for this type is ignored, and won't be generated
        • GraphQL type's field name: The method in the controller of this type, for this field, is ignored, and won't be generated. The field must be written like this: {type name}.{field name}

      The accepted separators for the values are: comma, space, carriage return, end of line, space, tabulation. At least one separator must exist between two values in the list. Here is a sample: 

                Type1, Type2.field1
                Type3
                Type4.field2

      For field mapping, there must be no separator other than '.' between the type name and the field name. For instance, the following type declaration are invalid: 'type .field', 'type. field'

      To implement the ignored mappings, you'll have to follow the [spring-graphql documentation](https://docs.spring.io/spring-graphql/reference/controllers.html).

  • Constructor Details

    • GenerateServerCodeTask

      @Inject public GenerateServerCodeTask(org.gradle.api.file.ProjectLayout projectLayout)
      Parameters:
      projectLayout - This Gradle service is automatically injected by gradle. It allows to retrieve the project directory, as accessing the Gradle Project is forbidden from a task.

    • GenerateServerCodeTask

      public GenerateServerCodeTask(GenerateServerCodeExtension extension, org.gradle.api.file.ProjectLayout projectLayout)

  • Method Details

    • execute

      public void execute() throws IOException
      Throws:
      IOException

    • getBatchMappingDataFetcherReturnType

      @Input public com.graphql_java_generator.plugin.conf.BatchMappingDataFetcherReturnType getBatchMappingDataFetcherReturnType()
      Specified by:
      getBatchMappingDataFetcherReturnType in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setBatchMappingDataFetcherReturnType

      public void setBatchMappingDataFetcherReturnType(com.graphql_java_generator.plugin.conf.BatchMappingDataFetcherReturnType batchMappingDataFetcherReturnType)

    • getIgnoredSpringMappings

      @Input public String getIgnoredSpringMappings()
      Specified by:
      getIgnoredSpringMappings in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setIgnoredSpringMappings

      public final void setIgnoredSpringMappings(String ignoredSpringMappings)

    • getJavaTypeForIDType

      @Input public final String getJavaTypeForIDType()
      Specified by:
      getJavaTypeForIDType in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setJavaTypeForIDType

      public final void setJavaTypeForIDType(String javaTypeForIDType)

    • getMode

      @Input public com.graphql_java_generator.plugin.conf.PluginMode getMode()
      Specified by:
      getMode in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration
      Overrides:
      getMode in class GenerateCodeCommonTask

    • getPackaging

      @Input @Optional public com.graphql_java_generator.plugin.conf.Packaging getPackaging()
      Specified by:
      getPackaging in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setPackaging

      public void setPackaging(com.graphql_java_generator.plugin.conf.Packaging packaging)

    • getQuotedScanBasePackages

      @Internal public String getQuotedScanBasePackages()
      Specified by:
      getQuotedScanBasePackages in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • getScanBasePackages

      @Input public final String getScanBasePackages()
      Specified by:
      getScanBasePackages in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setScanBasePackages

      public final void setScanBasePackages(String scanBasePackages)

    • isGenerateBatchLoaderEnvironment

      @Input public final boolean isGenerateBatchLoaderEnvironment()
      Specified by:
      isGenerateBatchLoaderEnvironment in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setGenerateBatchLoaderEnvironment

      public final void setGenerateBatchLoaderEnvironment(boolean generateBatchLoaderEnvironment)

    • isGenerateBatchMappingDataFetchers

      @Input public boolean isGenerateBatchMappingDataFetchers()
      Specified by:
      isGenerateBatchMappingDataFetchers in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setGenerateBatchMappingDataFetchers

      public void setGenerateBatchMappingDataFetchers(boolean generateBatchMappingDataFetchers)

    • isGenerateDataFetcherForEveryFieldsWithArguments

      @Input public final boolean isGenerateDataFetcherForEveryFieldsWithArguments()
      Specified by:
      isGenerateDataFetcherForEveryFieldsWithArguments in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setGenerateDataFetcherForEveryFieldsWithArguments

      public final void setGenerateDataFetcherForEveryFieldsWithArguments(boolean generateDataFetcherForEveryFieldsWithArguments)

    • isGenerateJacksonAnnotations

      @Internal public boolean isGenerateJacksonAnnotations()
      Specified by:
      isGenerateJacksonAnnotations in interface com.graphql_java_generator.plugin.conf.CommonConfiguration
      Specified by:
      isGenerateJacksonAnnotations in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration
      Overrides:
      isGenerateJacksonAnnotations in class GenerateCodeCommonTask

    • isGenerateJPAAnnotation

      @Input public final boolean isGenerateJPAAnnotation()
      Specified by:
      isGenerateJPAAnnotation in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setGenerateJPAAnnotation

      public final void setGenerateJPAAnnotation(boolean generateJPAAnnotation)

    • isGenerateDataLoaderForLists

      @Input public boolean isGenerateDataLoaderForLists()
      Specified by:
      isGenerateDataLoaderForLists in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

    • setGenerateDataLoaderForLists

      public final void setGenerateDataLoaderForLists(boolean generateDataLoaderForLists)

    • getExtension

      protected GenerateServerCodeExtension getExtension()
      Overrides:
      getExtension in class GenerateCodeCommonTask