New config to generate models with public fields #864 (#1049)

generateModelsWithPublicFields

Author: kobylynskyi

docs/codegen-options.md

@@ -43,6 +43,7 @@
 |          `useOptionalForNullableReturnTypes`          |                                Boolean                                |                             False                              | Specifies whether nullable return types of api methods should be wrapped into [`java.util.Optional<>`](https://docs.oracle.com/javase/8/docs/api/index.html?java/util/Optional.html). Lists will not be wrapped.                                                                                                                                                               |
 |           `generateApisWithThrowsException`           |                                Boolean                                |                              True                              | Specifies whether api interface methods should have `throws Exception` in signature.                                                                                                                                                                                                                                                                                           |
 |            `generateNoArgsConstructorOnly`            |                                Boolean                                |                             False                              | Specifies whether model classes should only have a no-args constructor. All-args constructor will not be generated in case value is <b>true</b>                                                                                                                                                                                                                                |
+|           `generateModelsWithPublicFields`            |                                Boolean                                |                             False                              | Specifies whether model classes should have public fields and NO getters/setters. By default, fields are private and there are getters/setters for each field.                                                                                                                                                                                                                 |
 |                    `apiReturnType`                    |                                String                                 |                             Empty                              | Return type for api methods (query/mutation). For example: `reactor.core.publisher.Mono`, etc.                                                                                                                                                                                                                                                                                 |
 |                  `apiReturnListType`                  |                                String                                 |                             Empty                              | Return type for api methods (query/mutation) having list type. For example: `reactor.core.publisher.Flux`, etc. By default is empty, so `apiReturnType` will be used.                                                                                                                                                                                                          |
 |               `subscriptionReturnType`                |                                String                                 |                             Empty                              | Return type for subscription methods. For example: `org.reactivestreams.Publisher`, `io.reactivex.Observable`, etc.                                                                                                                                                                                                                                                            |

plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java

@@ -85,6 +85,7 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private Boolean generateJacksonTypeIdResolver = MappingConfigConstants.DEFAULT_GENERATE_JACKSON_TYPE_ID_RESOLVER;
     private Boolean addGeneratedAnnotation = MappingConfigConstants.DEFAULT_ADD_GENERATED_ANNOTATION;
     private Boolean generateNoArgsConstructorOnly = MappingConfigConstants.DEFAULT_GENERATE_NOARGS_CONSTRUCTOR_ONLY;
+    private Boolean generateModelsWithPublicFields = MappingConfigConstants.DEFAULT_GENERATE_MODELS_WITH_PUBLIC_FIELDS;
     private String generatedAnnotation;
     private Set<String> fieldsWithResolvers = new HashSet<>();
     private Set<String> fieldsWithoutResolvers = new HashSet<>();
@@ -157,6 +158,7 @@ public void generate() throws Exception {
         mappingConfig.setGenerateApisWithThrowsException(generateApisWithThrowsException);
         mappingConfig.setGenerateJacksonTypeIdResolver(generateJacksonTypeIdResolver);
         mappingConfig.setGenerateNoArgsConstructorOnly(generateNoArgsConstructorOnly);
+        mappingConfig.setGenerateModelsWithPublicFields(generateModelsWithPublicFields);
         mappingConfig.setAddGeneratedAnnotation(addGeneratedAnnotation);
         mappingConfig.setGeneratedAnnotation(generatedAnnotation);
         mappingConfig.setApiReturnType(apiReturnType);
@@ -695,6 +697,17 @@ public void setGenerateNoArgsConstructorOnly(Boolean generateNoArgsConstructorOn
         this.generateNoArgsConstructorOnly = generateNoArgsConstructorOnly;
     }
 
+    @Input
+    @Optional
+    @Override
+    public Boolean isGenerateModelsWithPublicFields() {
+        return generateModelsWithPublicFields;
+    }
+
+    public void setGenerateModelsWithPublicFields(Boolean generateModelsWithPublicFields) {
+        this.generateModelsWithPublicFields = generateModelsWithPublicFields;
+    }
+
     @Input
     @Optional
     @Override

plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java

@@ -158,6 +158,9 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_NOARGS_CONSTRUCTOR_ONLY_STRING)
     private boolean generateNoArgsConstructorOnly;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_MODELS_WITH_PUBLIC_FIELDS_STRING)
+    private boolean generateModelsWithPublicFields;
+
     @Parameter
     private String generatedAnnotation;
 
@@ -275,6 +278,7 @@ public void execute() throws MojoExecutionException {
         mappingConfig.setAddGeneratedAnnotation(addGeneratedAnnotation);
         mappingConfig.setGeneratedAnnotation(generatedAnnotation);
         mappingConfig.setGenerateNoArgsConstructorOnly(generateNoArgsConstructorOnly);
+        mappingConfig.setGenerateModelsWithPublicFields(generateModelsWithPublicFields);
         mappingConfig.setFieldsWithResolvers(mapToHashSet(fieldsWithResolvers));
         mappingConfig.setFieldsWithoutResolvers(mapToHashSet(fieldsWithoutResolvers));
         mappingConfig.setRelayConfig(relayConfig);
@@ -684,6 +688,11 @@ public Boolean isGenerateNoArgsConstructorOnly() {
         return generateNoArgsConstructorOnly;
     }
 
+    @Override
+    public Boolean isGenerateModelsWithPublicFields() {
+        return generateModelsWithPublicFields;
+    }
+
     public ParentInterfacesConfig getParentInterfaces() {
         return parentInterfaces;
     }

plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenKeys.scala

@@ -151,11 +151,16 @@ trait GraphQLCodegenKeys {
     "Specifies whether generated union interfaces should be annotated with a custom Jackson type id resolver generated in model package."
   )
 
-  // not support in scala
+  // not supported in scala
   val generateNoArgsConstructorOnly = settingKey[Boolean](
     "Specifies whether model classes should only have a no-args constructor. All-args constructor will not be generated in case value is .true."
   )
 
+  // not supported in scala
+  val generateModelsWithPublicFields = settingKey[Boolean](
+    "Specifies whether model classes should have public fields and NO getters/setters. By default, fields are private and there are getters/setters for each field."
+  )
+
   // for version
   val javaxValidationApiVersion = settingKey[Option[String]]("javax-validation-api version")
   val graphqlJavaCodegenVersion = settingKey[Option[String]]("graphql-java-codegen version")

plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenPlugin.scala

@@ -118,16 +118,17 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     generateBuilder                               := MappingConfigConstants.DEFAULT_BUILDER,
     generateApis                                  := MappingConfigConstants.DEFAULT_GENERATE_APIS,
     generateEqualsAndHashCode                     := MappingConfigConstants.DEFAULT_EQUALS_AND_HASHCODE,
-    generateImmutableModels := MappingConfigConstants.DEFAULT_GENERATE_IMMUTABLE_MODELS, // TODO change default value
-    generateToString        := MappingConfigConstants.DEFAULT_TO_STRING,
+    generateImmutableModels                       := MappingConfigConstants.DEFAULT_GENERATE_IMMUTABLE_MODELS, // TODO change default value
+    generateToString                              := MappingConfigConstants.DEFAULT_TO_STRING,
     // parent interfaces configs:
-    parentInterfaces              := parentInterfacesConfig,
-    generateAllMethodInProjection := MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD,
-    responseProjectionMaxDepth    := MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH,
-    supportUnknownFields          := MappingConfigConstants.DEFAULT_SUPPORT_UNKNOWN_FIELDS,
-    unknownFieldsPropertyName     := MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME,
-    generateNoArgsConstructorOnly := MappingConfigConstants.DEFAULT_GENERATE_NOARGS_CONSTRUCTOR_ONLY,
-    skip                          := false
+    parentInterfaces                              := parentInterfacesConfig,
+    generateAllMethodInProjection                 := MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD,
+    responseProjectionMaxDepth                    := MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH,
+    supportUnknownFields                          := MappingConfigConstants.DEFAULT_SUPPORT_UNKNOWN_FIELDS,
+    unknownFieldsPropertyName                     := MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME,
+    generateNoArgsConstructorOnly                 := MappingConfigConstants.DEFAULT_GENERATE_NOARGS_CONSTRUCTOR_ONLY,
+    generateModelsWithPublicFields                := MappingConfigConstants.DEFAULT_GENERATE_MODELS_WITH_PUBLIC_FIELDS,
+    skip                                          := false
   )
 
   private def getMappingConfig(): Def.Initialize[MappingConfig] = Def.setting {
@@ -192,6 +193,7 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     mappingConfig.setGenerateModelOpenClasses((GraphQLCodegenConfig / generateModelOpenClasses).value)
     mappingConfig.setGenerateJacksonTypeIdResolver((GraphQLCodegenConfig / generateJacksonTypeIdResolver).value);
     mappingConfig.setGenerateNoArgsConstructorOnly((GraphQLCodegenConfig / generateNoArgsConstructorOnly).value);
+    mappingConfig.setGenerateModelsWithPublicFields((GraphQLCodegenConfig / generateModelsWithPublicFields).value);
 
     mappingConfig.setSupportUnknownFields((GraphQLCodegenConfig / supportUnknownFields).value)
     mappingConfig.setUnknownFieldsPropertyName((GraphQLCodegenConfig / unknownFieldsPropertyName).value)

src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionToParameterMapper.java

@@ -139,6 +139,7 @@ private ParameterDefinition mapField(MappingContext mappingContext,
                 mappingContext, fieldDef.getType(), fieldDef, parentDefinition.getName(), false));
         parameter.setJavaDoc(fieldDef.getJavaDoc());
         parameter.setDeprecated(DeprecatedDefinitionBuilder.build(mappingContext, fieldDef));
+        parameter.setVisibility(Utils.getFieldVisibility(mappingContext));
         parameter.setMandatory(namedDefinition.isMandatory());
         parameter.setSerializeUsingObjectMapper(namedDefinition.isSerializeUsingObjectMapper());
         parameter.setGetterMethodName(dataModelMapper.capitalizeMethodNameIfRestricted(mappingContext,

src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputValueDefinitionToParameterMapper.java

@@ -66,6 +66,7 @@ private ParameterDefinition map(MappingContext mappingContext, InputValueDefinit
                 namedDefinition.getJavaName()));
         parameter.setDefaultValue(valueMapper.map(
                 mappingContext, inputValueDefinition.getDefaultValue(), inputValueDefinition.getType()));
+        parameter.setVisibility(Utils.getFieldVisibility(mappingContext));
         parameter.setAnnotations(annotationsMapper.getAnnotations(mappingContext, inputValueDefinition.getType(),
                 inputValueDefinition, parentTypeName, false));
         parameter.setDeprecated(DeprecatedDefinitionBuilder.build(mappingContext, inputValueDefinition));

src/main/java/com/kobylynskyi/graphql/codegen/mapper/UnknownFieldsSupport.java

@@ -30,6 +30,7 @@ default Optional<ParameterDefinition> createUnknownFields(MappingContext mapping
             unknownFields.setName(mappingContext.getUnknownFieldsPropertyName());
             unknownFields.setGetterMethodName("get" + Utils.capitalize(mappingContext.getUnknownFieldsPropertyName()));
             unknownFields.setOriginalName(mappingContext.getUnknownFieldsPropertyName());
+            unknownFields.setVisibility(Utils.getFieldVisibility(mappingContext));
             unknownFields.setType("java.util.Map<String, Object>");
             unknownFields.setAnnotations(Arrays.asList(
                     "com.fasterxml.jackson.annotation.JsonAnyGetter",

src/main/java/com/kobylynskyi/graphql/codegen/model/GraphQLCodegenConfiguration.java

@@ -522,5 +522,13 @@ public interface GraphQLCodegenConfiguration {
      */
     Boolean isGenerateNoArgsConstructorOnly();
 
+    /**
+     * Specifies whether model classes should have public or private fields.
+     *
+     * @return <b>true</b> if model classes should have public fields and no getters/setters.
+     * <b>false</b> if model classes should have private fields and getters/setters.
+     */
+    Boolean isGenerateModelsWithPublicFields();
+
 
 }

src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfig.java

@@ -56,6 +56,7 @@ public class MappingConfig implements GraphQLCodegenConfiguration, Combinable<Ma
     private Boolean generateJacksonTypeIdResolver;
     private Boolean supportUnknownFields;
     private Boolean generateNoArgsConstructorOnly;
+    private Boolean generateModelsWithPublicFields;
 
     // field resolvers configs:
     private Set<String> fieldsWithResolvers = new HashSet<>();
@@ -212,6 +213,8 @@ public void combine(MappingConfig source) {
                 GraphQLCodegenConfiguration::getGeneratedAnnotation);
         generateNoArgsConstructorOnly = getValueOrDefaultToThis(source,
                 GraphQLCodegenConfiguration::isGenerateNoArgsConstructorOnly);
+        generateModelsWithPublicFields = getValueOrDefaultToThis(source,
+                GraphQLCodegenConfiguration::isGenerateNoArgsConstructorOnly);
     }
 
     private <T> T getValueOrDefaultToThis(MappingConfig source, Function<MappingConfig, T> getValueFunction) {
@@ -754,4 +757,13 @@ public Boolean isGenerateNoArgsConstructorOnly() {
     public void setGenerateNoArgsConstructorOnly(Boolean generateNoArgsConstructorOnly) {
         this.generateNoArgsConstructorOnly = generateNoArgsConstructorOnly;
     }
+
+    @Override
+    public Boolean isGenerateModelsWithPublicFields() {
+        return generateModelsWithPublicFields;
+    }
+
+    public void setGenerateModelsWithPublicFields(Boolean generateModelsWithPublicFields) {
+        this.generateModelsWithPublicFields = generateModelsWithPublicFields;
+    }
 }