@RequestBody Annotation Support (#1)

* Refactor BinderConfiguration to create default resolvers inside post processor.

This will allow me to leverage the message converters in the request body resolver. This means the DefaultPropertyResolverRegistry is no longer needed.

* Refactor BinderConfiguration to create default resolvers inside post processor.

This will allow me to leverage the message converters in the request body resolver. This means the DefaultPropertyResolverRegistry is no longer needed.

* Introduce BindingProperty class.

This class represents an abstraction of two different introspection types that represent a java beans property. This class will replace the direct TypeDescriptor usages throughout the library.

* Ignore warning.

* Add equals/hashCode to BindingProperty.

* Add BindingProperty to the ResolvedPropertyData class.

The BindingProperty is not yet in use but I've added it where it will be leveraged.

* Cut over the introspector to use the BindingProperty object.

* Add BindingProperty to AbstractPropertyResolverRegistry.

Class is not yet in use.

* Remove usages of TypeDescriptor from supports method.

* Remove TypeDescriptor from supports method.

* Add BindingProperty to the resolve method of the resolver interface.

* Remove usages of TypeDescriptor from resolves method.

* Remove TypeDescriptor from resolves method signature.

* Remove TypeDescriptor from ResolvedPropertyData class.

* Cleanup the resolver test warnings.

* Add support for the @RequestBody annotation.

* Switch to composition for the RequestBodyRequestPropertyResolver.

* Fix a couple of code smells.

* Add missing headers

* Fix code smells.

* Fix more code smells.

* Fix more code smells.

* Add javadoc to annotation.

* Add additional integration tests.

* Fix the reactive binding get values method so it no longer needs a block() method call.

Many thanks to Martin Tarjányi on StackOverflow for helping me figure this out and learn about some reactive programming.

* Add assertions.

* Add nullability annotations.

* Add nullability annotations.

* Create release notes file.

* Fix typo

* Formatting.

* Add header.

Author: mattbertolini

README.md

@@ -42,6 +42,10 @@ public class CustomRequestBean {
     @RequestContext    
     private ZoneId timeZone;
 
+    // Request body parsed by Spring HTTP MessageReaders
+    @RequestBody
+    private JsonBody requestBody;
+
     // A nested Java bean with additional annotated properties
     @BeanParameter
     private NestedBean nestedBean;

RELEASE_NOTES.md

@@ -0,0 +1,12 @@
+# Release Notes
+
+## 0.2.0
+In progress
+
+- Add support for binding request payloads using the `@RequestBody` annotation.
+
+## 0.1.0
+Released 2020-04-29
+
+- Initial release
+- Minimum supported Spring version: 5.2.6

integration-tests/build.gradle

@@ -9,6 +9,7 @@ dependencies {
     implementation 'javax.servlet:javax.servlet-api'
     implementation 'org.hibernate.validator:hibernate-validator:6.0.19.Final'
     implementation 'org.glassfish:javax.el:3.0.1-b09'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.11.2'
 
     testImplementation 'org.junit.jupiter:junit-jupiter-api'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'

integration-tests/src/test/java/com/mattbertolini/spring/test/web/bind/DirectFieldAccessBean.java

@@ -20,6 +20,7 @@
 import com.mattbertolini.spring.web.bind.annotation.FormParameter;
 import com.mattbertolini.spring.web.bind.annotation.HeaderParameter;
 import com.mattbertolini.spring.web.bind.annotation.PathParameter;
+import com.mattbertolini.spring.web.bind.annotation.RequestBody;
 import com.mattbertolini.spring.web.bind.annotation.RequestParameter;
 import com.mattbertolini.spring.web.bind.annotation.SessionParameter;
 
@@ -66,4 +67,13 @@ public String getRequestParameter() {
     public String getSessionParameter() {
         return sessionParameter;
     }
+
+    public static class RequestBodyBean {
+        @RequestBody
+        private JsonBody requestBody;
+
+        public JsonBody getRequestBody() {
+            return requestBody;
+        }
+    }
 }

integration-tests/src/test/java/com/mattbertolini/spring/test/web/bind/DirectFieldAccessController.java

@@ -54,4 +54,9 @@ public String requestParameter(@BeanParameter DirectFieldAccessBean directFieldA
     public String sessionParameter(@BeanParameter DirectFieldAccessBean directFieldAccessBean) {
         return directFieldAccessBean.getSessionParameter();
     }
+
+    @PostMapping(value = "/requestBody", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.TEXT_PLAIN_VALUE)
+    public String requestBody(@BeanParameter DirectFieldAccessBean.RequestBodyBean directFieldAccessBean) {
+        return directFieldAccessBean.getRequestBody().getProperty();
+    }
 }

integration-tests/src/test/java/com/mattbertolini/spring/test/web/bind/JsonBody.java

@@ -0,0 +1,20 @@
+package com.mattbertolini.spring.test.web.bind;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class JsonBody {
+    @JsonProperty("json_property")
+    private String property;
+
+    public String getProperty() {
+        return property;
+    }
+
+    public void setProperty(String property) {
+        this.property = property;
+    }
+}

integration-tests/src/test/java/com/mattbertolini/spring/test/web/bind/NestedBean.java

@@ -4,6 +4,7 @@
 import com.mattbertolini.spring.web.bind.annotation.FormParameter;
 import com.mattbertolini.spring.web.bind.annotation.HeaderParameter;
 import com.mattbertolini.spring.web.bind.annotation.PathParameter;
+import com.mattbertolini.spring.web.bind.annotation.RequestBody;
 import com.mattbertolini.spring.web.bind.annotation.RequestParameter;
 import com.mattbertolini.spring.web.bind.annotation.SessionParameter;
 
@@ -74,4 +75,17 @@ public String getSessionAttribute() {
     public void setSessionAttribute(String sessionAttribute) {
         this.sessionAttribute = sessionAttribute;
     }
+
+    public static class RequestBodyBean {
+        @RequestBody
+        private JsonBody requestBody;
+
+        public JsonBody getRequestBody() {
+            return requestBody;
+        }
+
+        public void setRequestBody(JsonBody requestBody) {
+            this.requestBody = requestBody;
+        }
+    }
 }

integration-tests/src/test/java/com/mattbertolini/spring/test/web/bind/RequestBodyBean.java

@@ -0,0 +1,94 @@
+package com.mattbertolini.spring.test.web.bind;
+
+import com.mattbertolini.spring.web.bind.annotation.BeanParameter;
+import com.mattbertolini.spring.web.bind.annotation.RequestBody;
+
+import javax.validation.constraints.NotNull;
+
+public class RequestBodyBean {
+
+    @SuppressWarnings("unused")
+    public static class AnnotatedField {
+        @RequestBody
+        private JsonBody jsonBody;
+
+        public JsonBody getJsonBody() {
+            return jsonBody;
+        }
+
+        public void setJsonBody(JsonBody jsonBody) {
+            this.jsonBody = jsonBody;
+        }
+    }
+
+    @SuppressWarnings("unused")
+    public static class AnnotatedSetter {
+        private JsonBody jsonBody;
+
+        public JsonBody getJsonBody() {
+            return jsonBody;
+        }
+
+        @RequestBody
+        public void setJsonBody(JsonBody jsonBody) {
+            this.jsonBody = jsonBody;
+        }
+    }
+
+    @SuppressWarnings("unused")
+    public static class AnnotatedGetter {
+        private JsonBody jsonBody;
+
+        @RequestBody
+        public JsonBody getJsonBody() {
+            return jsonBody;
+        }
+
+        public void setJsonBody(JsonBody jsonBody) {
+            this.jsonBody = jsonBody;
+        }
+    }
+
+    @SuppressWarnings("unused")
+    public static class BindingResult {
+        @RequestBody
+        private JsonBody jsonBody;
+
+        public JsonBody getJsonBody() {
+            return jsonBody;
+        }
+
+        public void setJsonBody(JsonBody jsonBody) {
+            this.jsonBody = jsonBody;
+        }
+    }
+
+    @SuppressWarnings("unused")
+    public static class Validation {
+        @NotNull
+        @RequestBody
+        private JsonBody jsonBody;
+        
+        public JsonBody getJsonBody() {
+            return jsonBody;
+        }
+
+        public void setJsonBody(JsonBody jsonBody) {
+            this.jsonBody = jsonBody;
+        }
+    }
+
+    @SuppressWarnings("unused")
+    public static class Nested {
+        @BeanParameter
+        private NestedBean.RequestBodyBean nestedBean;
+
+        public NestedBean.RequestBodyBean getNestedBean() {
+            return nestedBean;
+        }
+
+        public void setNestedBean(NestedBean.RequestBodyBean nestedBean) {
+            this.nestedBean = nestedBean;
+        }
+    }
+}

integration-tests/src/test/java/com/mattbertolini/spring/test/web/bind/RequestBodyController.java

@@ -0,0 +1,53 @@
+package com.mattbertolini.spring.test.web.bind;
+
+import com.mattbertolini.spring.web.bind.annotation.BeanParameter;
+import org.springframework.http.MediaType;
+import org.springframework.validation.BindingResult;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import javax.validation.Valid;
+
+@RestController
+public class RequestBodyController {
+    @PostMapping(value = "/annotatedField", produces = MediaType.TEXT_PLAIN_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
+    public String annotatedField(@BeanParameter RequestBodyBean.AnnotatedField requestBodyBean) {
+        JsonBody jsonBody = requestBodyBean.getJsonBody();
+        return jsonBody.getProperty();
+    }
+
+    @PostMapping(value = "/annotatedSetter", produces = MediaType.TEXT_PLAIN_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
+    public String annotatedSetter(@BeanParameter RequestBodyBean.AnnotatedSetter requestBodyBean) {
+        JsonBody jsonBody = requestBodyBean.getJsonBody();
+        return jsonBody.getProperty();
+    }
+
+    @PostMapping(value = "/annotatedGetter", produces = MediaType.TEXT_PLAIN_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
+    public String annotatedGetter(@BeanParameter RequestBodyBean.AnnotatedGetter requestBodyBean) {
+        JsonBody jsonBody = requestBodyBean.getJsonBody();
+        return jsonBody.getProperty();
+    }
+
+    @PostMapping(value = "/bindingResult", produces = MediaType.TEXT_PLAIN_VALUE)
+    public String bindingResult(@BeanParameter RequestBodyBean.BindingResult requestBodyBean, BindingResult bindingResult) {
+        return Integer.toString(bindingResult.getErrorCount());
+    }
+
+    @PostMapping(value = "/validated", produces = MediaType.TEXT_PLAIN_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
+    public String validated(@Valid @BeanParameter RequestBodyBean.Validation requestBodyBean) {
+        return requestBodyBean.getJsonBody().getProperty();
+    }
+
+    @PostMapping(value = "/validatedWithBindingResult", produces = MediaType.TEXT_PLAIN_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
+    public String validatedWithBindingResult(@Valid @BeanParameter RequestBodyBean.Validation requestBodyBean, BindingResult bindingResult) {
+        if (bindingResult.hasErrors()) {
+            return "notValid";
+        }
+        return "valid";
+    }
+
+    @PostMapping(value = "/nested", produces = MediaType.TEXT_PLAIN_VALUE)
+    public String nestedBeanParameter(@BeanParameter RequestBodyBean.Nested requestBodyBean) {
+        return requestBodyBean.getNestedBean().getRequestBody().getProperty();
+    }
+}

integration-tests/src/test/java/com/mattbertolini/spring/web/reactive/test/DirectFieldAccessIntegrationTest.java

@@ -34,6 +34,7 @@
 import org.springframework.web.reactive.config.WebFluxConfigurationSupport;
 
 import static org.springframework.web.reactive.function.BodyInserters.fromFormData;
+import static org.springframework.web.reactive.function.BodyInserters.fromValue;
 
 @SpringJUnitWebConfig(classes = {DirectFieldAccessIntegrationTest.Context.class})
 class DirectFieldAccessIntegrationTest {
@@ -110,6 +111,18 @@ void sessionParameter() {
             .expectBody(String.class).isEqualTo("expectedValue");
     }
 
+    @Test
+    void requestBody() {
+        webTestClient.post()
+            .uri("/requestBody")
+            .contentType(MediaType.APPLICATION_JSON)
+            .body(fromValue("{\"json_property\":  \"expectedValue\"}"))
+            .accept(MediaType.TEXT_PLAIN)
+            .exchange()
+            .expectStatus().isOk()
+            .expectBody(String.class).isEqualTo("expectedValue");
+    }
+
     @Configuration
     static class Context extends WebFluxConfigurationSupport {