Merge pull request #2 from infobip/SingleArgumentPropertiesCreatorMod…

…eAnnotationIntrospector added SingleArgumentPropertiesCreatorModeAnnotationIntrospector
infobip · Apr 16, 2021 · 158495a · 158495a
2 parents 5de61b9 + 4aba117
commit 158495a
Show file tree

Hide file tree

Showing 16 changed files with 298 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,7 @@
 ![](https://github.com/infobip/infobip-jackson-extension/workflows/maven/badge.svg)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.infobip/infobip-jackson-extension-spring-boot-starter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.infobip/infobip-jackson-extension-spring-boot-starter)
 [![Coverage Status](https://coveralls.io/repos/github/infobip/infobip-jackson-extension/badge.svg?branch=master)](https://coveralls.io/github/infobip/infobip-jackson-extension?branch=master)
+[![Known Vulnerabilities](https://snyk.io/test/github/infobip/infobip-jackson-extension/badge.svg)](https://snyk.io/test/github/infobip/infobip-jackson-extension)
 
 Library which provides new features for (de)serialization on top of [Jackson library](https://github.com/FasterXML/jackson).
 
@@ -16,6 +17,7 @@ Library which provides new features for (de)serialization on top of [Jackson lib
     * [Multi level hierarchies](#MultiLevelHierarchies)
     * [Parallel hierarchies](#ParallelHierarchies)
     * [Typeless (present property)](#Typeless)
+    * [Single Argument Property Creator annotationless support](#SingleArgumentPropertyCreatorAnnotationlessSupport)
 
 <a name="Setup"></a>
 ## Setup
@@ -245,6 +247,24 @@ Notice standard jackson `@JsonNaming` annotation in `Bike` interface.
 
 [Showcase](infobip-jackson-extension-module/src/test/java/com/infobip/jackson/PresentPropertyCaseFormatDeserializerTest.java).
 
+<a name="SingleArgumentPropertyCreatorAnnotationlessSupport"></a>
+### Single Argument Property Creator annotationless support
+
+This module also adds support for deserializing single property value objects when using parameter names module:
+
+```java
+class Foo {
+    private final Bar bar;
+
+    Foo(Bar bar) {
+        this.bar = bar;
+    }
+}
+```
+
+without any additional configuration or annotations.
+Related issues: https://github.com/FasterXML/jackson-databind/issues/1498, https://github.com/spring-projects/spring-boot/issues/26023.
+
 ## <a name="Requirements"></a> Requirements:
 
 - Java 8

diff --git a/infobip-jackson-extension-api/pom.xml b/infobip-jackson-extension-api/pom.xml
@@ -13,8 +13,8 @@
 		<dependency>
 			<groupId>com.google.guava</groupId>
 			<artifactId>guava</artifactId>
-			<version>29.0-jre</version>
+			<version>30.1.1-jre</version>
 		</dependency>
 	</dependencies>
 	<artifactId>infobip-jackson-extension-api</artifactId>
-</project>
+</project>
diff --git a/infobip-jackson-extension-module/src/main/java/com/infobip/jackson/InfobipJacksonModule.java b/infobip-jackson-extension-module/src/main/java/com/infobip/jackson/InfobipJacksonModule.java
@@ -8,5 +8,6 @@ public class InfobipJacksonModule extends SimpleModule {
     public void setupModule(SetupContext context) {
         super.setupModule(context);
         context.insertAnnotationIntrospector(new InfobipJacksonAnnotationIntrospector());
+        context.insertAnnotationIntrospector(new SingleArgumentPropertiesCreatorModeAnnotationIntrospector());
     }
-}
+}
diff --git a/...n/java/com/infobip/jackson/SingleArgumentPropertiesCreatorModeAnnotationIntrospector.java b/...n/java/com/infobip/jackson/SingleArgumentPropertiesCreatorModeAnnotationIntrospector.java
@@ -0,0 +1,62 @@
+package com.infobip.jackson;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.cfg.MapperConfig;
+import com.fasterxml.jackson.databind.introspect.*;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Parameter;
+import java.util.Objects;
+import java.util.stream.Stream;
+
+public class SingleArgumentPropertiesCreatorModeAnnotationIntrospector extends NopAnnotationIntrospector {
+
+    @Override
+    public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated a) {
+        if (!(a instanceof AnnotatedConstructor)) {
+            return null;
+        }
+
+        AnnotatedConstructor annotatedConstructor = (AnnotatedConstructor) a;
+
+        if (annotatedConstructor.getParameterCount() != 1) {
+            return null;
+        }
+
+        Class<?> declaringClass = annotatedConstructor.getDeclaringClass();
+
+        if (declaringClass.getDeclaredConstructors().length > 1) {
+            return null;
+        }
+
+        if (doesntHaveMatchingFieldAndParameter(annotatedConstructor, declaringClass)) {
+            return null;
+        }
+
+        return JsonCreator.Mode.PROPERTIES;
+    }
+
+    private boolean doesntHaveMatchingFieldAndParameter(AnnotatedConstructor annotatedConstructor,
+                                                        Class<?> declaringClass) {
+        Parameter parameter = annotatedConstructor.getAnnotated().getParameters()[0];
+        return Stream.of(declaringClass.getDeclaredFields())
+                     .noneMatch(field -> doesFieldMatchParameter(field, parameter));
+    }
+
+    private boolean doesFieldMatchParameter(Field field, Parameter parameter) {
+
+        if(!field.getType().equals(parameter.getType())) {
+            return false;
+        }
+
+        String parameterName = parameter.getName();
+        JsonProperty annotation = field.getAnnotation(JsonProperty.class);
+
+        if (Objects.nonNull(annotation) && annotation.value().equals(parameterName)) {
+            return true;
+        }
+
+        return field.getName().equals(parameterName);
+    }
+}
diff --git a/...sion-module/src/test/java/com/infobip/jackson/CustomTypeFieldSimpleJsonHierarchyTest.java b/...sion-module/src/test/java/com/infobip/jackson/CustomTypeFieldSimpleJsonHierarchyTest.java
@@ -110,14 +110,12 @@ interface FooBar extends SimpleJsonHierarchy<FooBarType> {
         FooBarType getType();
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Foo implements FooBar {
         private final String foo;
         private final FooBarType type = FooBarType.FOO;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Bar implements FooBar {
         private final String bar;
@@ -132,4 +130,4 @@ enum FooBarType implements TypeProvider {
 
         private final Class<? extends FooBar> type;
     }
-}
+}
diff --git a/...sion-module/src/test/java/com/infobip/jackson/JsonTypedAbstractClassDeserializerTest.java b/...sion-module/src/test/java/com/infobip/jackson/JsonTypedAbstractClassDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import lombok.*;
 import org.junit.jupiter.api.Test;
@@ -48,14 +47,12 @@ public Class<?> resolve(Map<String, Object> json) {
         }
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Foo extends FooBar {
         private final String foo;
         private final FooBarType type = FooBarType.FOO;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Bar extends FooBar {
         private final String bar;
@@ -70,4 +67,4 @@ enum FooBarType {
 
         private final Class<? extends FooBar> type;
     }
-}
+}
diff --git a/...jackson-extension-module/src/test/java/com/infobip/jackson/JsonTypedDeserializerTest.java b/...jackson-extension-module/src/test/java/com/infobip/jackson/JsonTypedDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.*;
@@ -113,14 +112,12 @@ public Class<?> resolve(Map<String, Object> json) {
         }
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Foo implements FooBar {
         private final String foo;
         private final FooBarType type = FooBarType.FOO;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Bar implements FooBar {
         private final String bar;
@@ -135,4 +132,4 @@ enum FooBarType {
 
         private final Class<? extends FooBar> type;
     }
-}
+}
diff --git a/...ension-module/src/test/java/com/infobip/jackson/LowerCaseTypeSimpleJsonHierarchyTest.java b/...ension-module/src/test/java/com/infobip/jackson/LowerCaseTypeSimpleJsonHierarchyTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -108,14 +107,12 @@ interface FooBar extends SimpleJsonHierarchy<FooBarType> {
         FooBarType getType();
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Foo implements FooBar {
         private final String foo;
         private final FooBarType type = FooBarType.FOO;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Bar implements FooBar {
         private final String bar;
@@ -135,4 +132,4 @@ String getValue() {
             return toString().toLowerCase();
         }
     }
-}
+}
diff --git a/...ion-module/src/test/java/com/infobip/jackson/MultiHierarchyJsonTypedDeserializerTest.java b/...ion-module/src/test/java/com/infobip/jackson/MultiHierarchyJsonTypedDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.*;
@@ -123,7 +122,6 @@ public MammalJsonTypeResolver() {
         }
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Human implements Mammal {
         private final String name;
@@ -146,4 +144,4 @@ enum MammalType implements TypeProvider {
 
         private final Class<? extends Mammal> type;
     }
-}
+}
diff --git a/...est/java/com/infobip/jackson/MultiHierarchyWithOneTypeFieldJsonTypedDeserializerTest.java b/...est/java/com/infobip/jackson/MultiHierarchyWithOneTypeFieldJsonTypedDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.*;
@@ -106,7 +105,6 @@ interface Animal extends SimpleJsonHierarchy<AnimalType> {
     interface Mammal extends Animal {
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Human implements Mammal {
         private final String name;
@@ -124,4 +122,4 @@ enum AnimalType implements TypeProvider {
 
         private final Class<? extends Animal> type;
     }
-}
+}
diff --git a/...n-module/src/test/java/com/infobip/jackson/PresentPropertyCaseFormatDeserializerTest.java b/...n-module/src/test/java/com/infobip/jackson/PresentPropertyCaseFormatDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.PropertyNamingStrategy;
@@ -117,14 +116,12 @@ public LowerUnderscorePresentPropertyJsonTypeResolver(Class<E> type) {
         }
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class RoadBike implements Bike {
 
         private final String roadBike;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class MountainBike implements Bike {
 

diff --git a/...n-extension-module/src/test/java/com/infobip/jackson/PresentPropertyDeserializerTest.java b/...n-extension-module/src/test/java/com/infobip/jackson/PresentPropertyDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.*;
@@ -103,14 +102,12 @@ interface Bike extends PresentPropertyJsonHierarchy<BikeType> {
 
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class RoadBike implements Bike {
 
         private final String roadBike;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Bmx implements Bike {
 

diff --git a/.../src/test/java/com/infobip/jackson/PresentPropertyResolverWithDefaultConstructorTest.java b/.../src/test/java/com/infobip/jackson/PresentPropertyResolverWithDefaultConstructorTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.google.common.base.CaseFormat;
 import lombok.*;
@@ -43,14 +42,12 @@ public BikeTypeResolver() {
         }
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class RoadBike implements Bike {
 
         private final String roadBike;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class MountainBike implements Bike {
 

diff --git a/...tension-module/src/test/java/com/infobip/jackson/SimpleJsonHierarchyDeserializerTest.java b/...tension-module/src/test/java/com/infobip/jackson/SimpleJsonHierarchyDeserializerTest.java
@@ -1,6 +1,5 @@
 package com.infobip.jackson;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.*;
@@ -105,14 +104,12 @@ void shouldDeserializeFooAsFooFromJson() throws JsonProcessingException {
     interface FooBar extends SimpleJsonHierarchy<FooBarType> {
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Foo implements FooBar {
         private final String foo;
         private final FooBarType type = FooBarType.FOO;
     }
 
-    @AllArgsConstructor(onConstructor_ = @JsonCreator)
     @Value
     static class Bar implements FooBar {
         private final String bar;
@@ -127,4 +124,4 @@ enum FooBarType implements TypeProvider {
 
         private final Class<? extends FooBar> type;
     }
-}
+}