Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add request binding to functional endpoints

Browse Source 
This commit introduces form binding to ServerRequest in both WebMVC.fn
and WebFlux.fn's, in the form of a bind(Class) method.

Closes gh-25943
This commit is contained in:
Arjen Poutsma
2023-07-04 15:01:32 +02:00
parent a3e37597aa
commit d04d7b2e57
11 changed files with 598 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
spring-webmvc/src/main/java/org/springframework/web/servlet/function/DefaultServerRequest.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@ import java.util.Map;
import java.util.Optional;
import java.util.OptionalLong;
import java.util.Set;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import jakarta.servlet.ServletException;
@@ -47,6 +48,7 @@ import jakarta.servlet.http.HttpSession;
import jakarta.servlet.http.Part;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.ResolvableType;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpRange;
@@ -56,12 +58,17 @@ import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.RequestPath;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MimeTypeUtils;
import org.springframework.util.MultiValueMap;
import org.springframework.util.ObjectUtils;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.bind.ServletRequestDataBinder;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
@@ -218,6 +225,35 @@ class DefaultServerRequest implements ServerRequest {
return result;
}
@Override
@SuppressWarnings("unchecked")
public <T> T bind(Class<T> bindType, Consumer<WebDataBinder> dataBinderCustomizer) throws BindException {
Assert.notNull(bindType, "BindType must not be null");
Assert.notNull(dataBinderCustomizer, "DataBinderCustomizer must not be null");
ServletRequestDataBinder dataBinder = new ServletRequestDataBinder(null);
dataBinder.setTargetType(ResolvableType.forClass(bindType));
dataBinderCustomizer.accept(dataBinder);
HttpServletRequest servletRequest = servletRequest();
dataBinder.construct(servletRequest);
dataBinder.bind(servletRequest);
BindingResult bindingResult = dataBinder.getBindingResult();
if (bindingResult.hasErrors()) {
throw new BindException(bindingResult);
}
else {
T result = (T) bindingResult.getTarget();
if (result != null) {
return result;
}
else {
throw new IllegalStateException("Binding result has neither target nor errors");
}
}
}
@Override
public Optional<Object> attribute(String name) {
return Optional.ofNullable(servletRequest().getAttribute(name));

34
spring-webmvc/src/main/java/org/springframework/web/servlet/function/DefaultServerRequestBuilder.java
View File

@@ -42,6 +42,7 @@ import jakarta.servlet.http.HttpSession;
import jakarta.servlet.http.Part;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.ResolvableType;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpMethod;
@@ -52,7 +53,11 @@ import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.bind.ServletRequestDataBinder;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.util.UriBuilder;
import org.springframework.web.util.UriComponentsBuilder;
@@ -323,6 +328,35 @@ class DefaultServerRequestBuilder implements ServerRequest.Builder {
throw new HttpMediaTypeNotSupportedException(contentType, Collections.emptyList(), method());
}
@Override
@SuppressWarnings("unchecked")
public <T> T bind(Class<T> bindType, Consumer<WebDataBinder> dataBinderCustomizer) throws BindException {
Assert.notNull(bindType, "BindType must not be null");
Assert.notNull(dataBinderCustomizer, "DataBinderCustomizer must not be null");
ServletRequestDataBinder dataBinder = new ServletRequestDataBinder(null);
dataBinder.setTargetType(ResolvableType.forClass(bindType));
dataBinderCustomizer.accept(dataBinder);
HttpServletRequest servletRequest = servletRequest();
dataBinder.construct(servletRequest);
dataBinder.bind(servletRequest);
BindingResult bindingResult = dataBinder.getBindingResult();
if (bindingResult.hasErrors()) {
throw new BindException(bindingResult);
}
else {
T result = (T) bindingResult.getTarget();
if (result != null) {
return result;
}
else {
throw new IllegalStateException("Binding result has neither target nor errors");
}
}
}
@Override
public Map<String, Object> attributes() {
return this.attributes;

15
spring-webmvc/src/main/java/org/springframework/web/servlet/function/RequestPredicates.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -31,6 +31,7 @@ import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
@@ -54,6 +55,8 @@ import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.MimeTypeUtils;
import org.springframework.util.MultiValueMap;
import org.springframework.validation.BindException;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.cors.CorsUtils;
import org.springframework.web.util.UriBuilder;
import org.springframework.web.util.UriUtils;
@@ -1018,6 +1021,16 @@ public abstract class RequestPredicates {
return this.request.body(bodyType);
}
@Override
public <T> T bind(Class<T> bindType) throws BindException {
return this.request.bind(bindType);
}
@Override
public <T> T bind(Class<T> bindType, Consumer<WebDataBinder> dataBinderCustomizer) throws BindException {
return this.request.bind(bindType, dataBinderCustomizer);
}
@Override
public Optional<Object> attribute(String name) {
return this.request.attribute(name);

28
spring-webmvc/src/main/java/org/springframework/web/servlet/function/ServerRequest.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,6 +48,8 @@ import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.util.MultiValueMap;
import org.springframework.validation.BindException;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.util.ServletRequestPathUtils;
import org.springframework.web.util.UriBuilder;
@@ -148,6 +150,30 @@ public interface ServerRequest {
*/
<T> T body(ParameterizedTypeReference<T> bodyType) throws ServletException, IOException;
/**
* Bind to this request and return an instance of the given type.
* @param bindType the type of class to bind this request to
* @param <T> the type to bind to
* @return a constructed and bound instance of {@code bindType}
* @throws BindException in case of binding errors
* @since 6.1
*/
default <T> T bind(Class<T> bindType) throws BindException {
return bind(bindType, dataBinder -> {});
}
/**
* Bind to this request and return an instance of the given type.
* @param bindType the type of class to bind this request to
* @param dataBinderCustomizer used to customize the data binder, e.g. set
* (dis)allowed fields
* @param <T> the type to bind to
* @return a constructed and bound instance of {@code bindType}
* @throws BindException in case of binding errors
* @since 6.1
*/
<T> T bind(Class<T> bindType, Consumer<WebDataBinder> dataBinderCustomizer) throws BindException;
/**
* Get the request attribute value if present.
* @param name the attribute name

145
spring-webmvc/src/test/java/org/springframework/web/servlet/function/DefaultServerRequestTests.java
View File

@@ -49,6 +49,7 @@ import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.validation.BindException;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.servlet.handler.PathPatternsTestUtils;
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
@@ -304,6 +305,71 @@ class DefaultServerRequestTests {
assertThat(request.principal()).contains(principal);
}
@Test
void bindToConstructor() throws BindException {
MockHttpServletRequest servletRequest = PathPatternsTestUtils.initRequest("GET", "/", true);
servletRequest.addParameter("foo", "FOO");
servletRequest.addParameter("bar", "BAR");
DefaultServerRequest request = new DefaultServerRequest(servletRequest, this.messageConverters);
ConstructorInjection result = request.bind(ConstructorInjection.class);
assertThat(result.getFoo()).isEqualTo("FOO");
assertThat(result.getBar()).isEqualTo("BAR");
}
@Test
void bindToProperties() throws BindException {
MockHttpServletRequest servletRequest = PathPatternsTestUtils.initRequest("GET", "/", true);
servletRequest.addParameter("foo", "FOO");
servletRequest.addParameter("bar", "BAR");
DefaultServerRequest request = new DefaultServerRequest(servletRequest, this.messageConverters);
PropertyInjection result = request.bind(PropertyInjection.class);
assertThat(result.getFoo()).isEqualTo("FOO");
assertThat(result.getBar()).isEqualTo("BAR");
}
@Test
void bindToMixed() throws BindException {
MockHttpServletRequest servletRequest = PathPatternsTestUtils.initRequest("GET", "/", true);
servletRequest.addParameter("foo", "FOO");
servletRequest.addParameter("bar", "BAR");
DefaultServerRequest request = new DefaultServerRequest(servletRequest, this.messageConverters);
MixedInjection result = request.bind(MixedInjection.class);
assertThat(result.getFoo()).isEqualTo("FOO");
assertThat(result.getBar()).isEqualTo("BAR");
}
@Test
void bindCustomizer() throws BindException {
MockHttpServletRequest servletRequest = PathPatternsTestUtils.initRequest("GET", "/", true);
servletRequest.addParameter("foo", "FOO");
servletRequest.addParameter("bar", "BAR");
DefaultServerRequest request = new DefaultServerRequest(servletRequest, this.messageConverters);
PropertyInjection result = request.bind(PropertyInjection.class, dataBinder -> dataBinder.setAllowedFields("foo"));
assertThat(result.getFoo()).isEqualTo("FOO");
assertThat(result.getBar()).isNull();
}
@Test
void bindError() throws BindException {
MockHttpServletRequest servletRequest = PathPatternsTestUtils.initRequest("GET", "/", true);
servletRequest.addParameter("foo", "FOO");
DefaultServerRequest request = new DefaultServerRequest(servletRequest, this.messageConverters);
assertThatExceptionOfType(BindException.class).isThrownBy(() ->
request.bind(ErrorInjection.class)
);
}
@ParameterizedHttpMethodTest
void checkNotModifiedTimestamp(String method) throws Exception {
MockHttpServletRequest servletRequest = PathPatternsTestUtils.initRequest(method, "/", true);
@@ -487,4 +553,83 @@ class DefaultServerRequestTests {
@interface ParameterizedHttpMethodTest {
}
private static final class ConstructorInjection {
private final String foo;
private final String bar;
public ConstructorInjection(String foo, String bar) {
this.foo = foo;
this.bar = bar;
}
public String getFoo() {
return this.foo;
}
public String getBar() {
return this.bar;
}
}
private static final class PropertyInjection {
private String foo;
private String bar;
public String getFoo() {
return this.foo;
}
public void setFoo(String foo) {
this.foo = foo;
}
public String getBar() {
return this.bar;
}
public void setBar(String bar) {
this.bar = bar;
}
}
private static final class MixedInjection {
private final String foo;
private String bar;
public MixedInjection(String foo) {
this.foo = foo;
}
public String getFoo() {
return this.foo;
}
public String getBar() {
return this.bar;
}
public void setBar(String bar) {
this.bar = bar;
}
}
private static final class ErrorInjection {
private int foo;
public int getFoo() {
return this.foo;
}
public void setFoo(int foo) {
this.foo = foo;
}
}
}