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

Improving contribution

Browse Source 
See gh-24406
This commit is contained in:
Rossen Stoyanchev
2020-05-06 08:42:08 +01:00
parent 816466e492
commit f28e08eceb
4 changed files with 101 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

221
spring-web/src/main/java/org/springframework/http/RequestEntity.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2020 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.
@@ -22,58 +22,32 @@ import java.nio.charset.Charset;
import java.time.Instant;
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.MultiValueMap;
import org.springframework.util.ObjectUtils;
import org.springframework.web.util.DefaultUriBuilderFactory;
import org.springframework.web.util.UriTemplateHandler;
/**
* Extension of {@link HttpEntity} that adds a {@linkplain HttpMethod method} and
* {@linkplain URI uri} or String based uri template with placeholder. Uri variables can be provided
* through the builder {@link HeadersBuilder#uriVariables(Object...)}.
* Extension of {@link HttpEntity} that also exposes the HTTP method and the
* target URL. For use in the {@code RestTemplate} to prepare requests with
* and in {@code @Controller} methods to represent request input.
*
* Used in {@code RestTemplate} and {@code @Controller} methods.
*
* <p>In {@code RestTemplate}, this class is used as parameter in
* {@link org.springframework.web.client.RestTemplate#exchange(RequestEntity, Class) exchange()}:
* <p>Example use with the {@code RestTemplate}:
* <pre class="code">
* MyRequest body = ...
* RequestEntity&lt;MyRequest&gt; request = RequestEntity
* .post(new URI(&quot;https://example.com/bar&quot;))
* .post(&quot;https://example.com/{foo}&quot;, &quot;bar&quot;)
* .accept(MediaType.APPLICATION_JSON)
* .body(body);
* ResponseEntity&lt;MyResponse&gt; response = template.exchange(request, MyResponse.class);
* </pre>
*
* <p>If you would like to provide a URI template with variables, consider using
* {@link org.springframework.web.util.DefaultUriBuilderFactory DefaultUriBuilderFactory}:
* <pre class="code">
* // Create shared factory
* UriBuilderFactory factory = new DefaultUriBuilderFactory();
*
* // Use factory to create URL from template
* URI uri = factory.uriString(&quot;https://example.com/{foo}&quot;).build(&quot;bar&quot;);
* RequestEntity&lt;MyRequest&gt; request = RequestEntity.post(uri).accept(MediaType.APPLICATION_JSON).body(body);
* </pre>
*
* <p> if you would like to provide a string base URI template with variable, consider using
* {@link RequestEntity#method(HttpMethod, String)}}, {@link RequestEntity#get(String)},
* {@link RequestEntity#post(String)}, {@link RequestEntity#put(String)}, {@link RequestEntity#delete(String)},
* {@link RequestEntity#patch(String)}, {@link RequestEntity#options(String)}
*
* <pre class="code>
* RequestEntity request = RequestEntity
* .post(&quot;https://example.com/{foo}&quot;)
* .uriVariables(&quot;bar&quot;)
* .accept(MediaType.APPLICATION_JSON)
* .build();
* </pre>
*
* <p>Can also be used in Spring MVC, as a parameter in a @Controller method:
* <p>Example use in an {@code @Controller}:
* <pre class="code">
* &#64;RequestMapping("/handle")
* public void handle(RequestEntity&lt;String&gt; request) {
@@ -93,19 +67,12 @@ import org.springframework.web.util.UriTemplateHandler;
*/
public class RequestEntity<T> extends HttpEntity<T> {
private final static UriTemplateHandler DEFAULT_URI_BUILDER_FACTORY = new DefaultUriBuilderFactory();
private final static UriTemplateHandler DEFAULT_TEMPLATE_HANDLER = new DefaultUriBuilderFactory();
@Nullable
private final HttpMethod method;
@Nullable
private final URI url;
@Nullable
private String uri;
@Nullable
private Object[] uriVariables;
private final Function<UriTemplateHandler, URI> uriFunction;
@Nullable
private final Type type;
@@ -175,30 +142,22 @@ public class RequestEntity<T> extends HttpEntity<T> {
* @since 4.3
*/
public RequestEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers,
@Nullable HttpMethod method, URI url, @Nullable Type type) {
@Nullable HttpMethod method, URI url, @Nullable Type type) {
super(body, headers);
this.method = method;
this.url = url;
this.type = type;
this(body, headers, method, handler -> url, type);
}
/**
* Private Constructor with method, URL, UriTemplate and varargs urivariables but without body nor headers.
* @param method the method
* @param url the URL
* @param uri the UriTemplate
* @param uriVariables the uriVariables
* Private constructor with URI function.
* @since 5.3
*/
private RequestEntity(MultiValueMap<String, String> headers, HttpMethod method, @Nullable URI url,
@Nullable String uri, @Nullable Object... uriVariables) {
super(null, headers);
Assert.isTrue(uri == null || url == null, "Either url or url must be not null");
private RequestEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers,
@Nullable HttpMethod method, Function<UriTemplateHandler, URI> uriFunction, @Nullable Type type) {
super(body, headers);
this.method = method;
this.url = url;
this.type = null;
this.uri = uri;
this.uriVariables = uriVariables;
this.uriFunction = uriFunction;
this.type = type;
}
@@ -213,27 +172,24 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Return the URL of the request.
* Used {@link org.springframework.web.util.DefaultUriBuilderFactory} to expand and
* encode {@link DefaultUriBuilderFactory#setEncodingMode} when provided {@link RequestEntity#uri}
* <p>If the URL was provided as a URI template, the returned URI is expanded
* and encoded with {@link DefaultUriBuilderFactory}.
* @return the URL as a {@code URI}
*/
public URI getUrl() {
if (uri == null) {
return this.url;
}
return DEFAULT_URI_BUILDER_FACTORY.expand(uri, uriVariables);
return this.uriFunction.apply(DEFAULT_TEMPLATE_HANDLER);
}
/**
* Return the URL of the request.
* <p>If the URL was provided as a URI template, the returned URI is expanded
* with the given {@link DefaultUriBuilderFactory}.
* @param templateHandler the handler to use to expand the URI template with
* @return the URL as a {@code URI}
* @since 5.3
*/
public URI getUrl(UriTemplateHandler uriTemplateHandler) {
if (uri == null) {
return this.url;
}
return uriTemplateHandler.expand(uri, uriVariables);
public URI getUrl(UriTemplateHandler templateHandler) {
return this.uriFunction.apply(templateHandler);
}
@@ -271,7 +227,7 @@ public class RequestEntity<T> extends HttpEntity<T> {
public int hashCode() {
int hashCode = super.hashCode();
hashCode = 29 * hashCode + ObjectUtils.nullSafeHashCode(this.method);
hashCode = 29 * hashCode + ObjectUtils.nullSafeHashCode(this.url);
hashCode = 29 * hashCode + ObjectUtils.nullSafeHashCode(getUrl());
return hashCode;
}
@@ -307,15 +263,26 @@ public class RequestEntity<T> extends HttpEntity<T> {
}
/**
* Create a builder with the given method and given string base uri template.
* Create a builder with the given HTTP method, URI template, and variables.
* @param method the HTTP method (GET, POST, etc)
* @param uri the uri
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @see RequestEntity
* @since 5.3
*/
public static BodyBuilder method(HttpMethod method, String uri) {
return new DefaultBodyBuilder(method, uri);
public static BodyBuilder method(HttpMethod method, String uriTemplate, Object... uriVariables) {
return new DefaultBodyBuilder(method, uriTemplate, uriVariables);
}
/**
* Create a builder with the given HTTP method, URI template, and variables.
* @param method the HTTP method (GET, POST, etc)
* @param uriTemplate the uri template to use
* @return the created builder
* @since 5.3
*/
public static BodyBuilder method(HttpMethod method, String uriTemplate, Map<String, ?> uriVariables) {
return new DefaultBodyBuilder(method, uriTemplate, uriVariables);
}
@@ -330,12 +297,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Create an HTTP GET builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> get(String uri) {
return method(HttpMethod.GET, uri);
public static HeadersBuilder<?> get(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.GET, uriTemplate, uriVariables);
}
/**
@@ -349,12 +317,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Create an HTTP HEAD builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> head(String uri) {
return method(HttpMethod.HEAD, uri);
public static HeadersBuilder<?> head(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.HEAD, uriTemplate, uriVariables);
}
/**
@@ -368,12 +337,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Create an HTTP POST builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static BodyBuilder post(String uri) {
return method(HttpMethod.POST, uri);
public static BodyBuilder post(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.POST, uriTemplate, uriVariables);
}
/**
@@ -387,12 +357,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Create an HTTP PUT builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static BodyBuilder put(String uri) {
return method(HttpMethod.PUT, uri);
public static BodyBuilder put(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.PUT, uriTemplate, uriVariables);
}
/**
@@ -406,12 +377,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Create an HTTP PATCH builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static BodyBuilder patch(String uri) {
return method(HttpMethod.PATCH, uri);
public static BodyBuilder patch(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.PATCH, uriTemplate, uriVariables);
}
/**
@@ -425,12 +397,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Create an HTTP DELETE builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> delete(String uri) {
return method(HttpMethod.DELETE, uri);
public static HeadersBuilder<?> delete(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.DELETE, uriTemplate, uriVariables);
}
/**
@@ -444,12 +417,13 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Creates an HTTP OPTIONS builder with the given string base uri template.
* @param uri the uri template
* @param uriTemplate the uri template to use
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> options(String uri) {
return method(HttpMethod.OPTIONS, uri);
public static HeadersBuilder<?> options(String uriTemplate, Object... uriVariables) {
return method(HttpMethod.OPTIONS, uriTemplate, uriVariables);
}
@@ -531,13 +505,6 @@ public class RequestEntity<T> extends HttpEntity<T> {
*/
B ifNoneMatch(String... ifNoneMatches);
/**
* Set the values of the {@code If-None-Match} header.
* @param uriVariables the variables to expand the template
* @since 5.3
*/
B uriVariables(Object... uriVariables);
/**
* Builds the request entity with no body.
* @return the request entity
@@ -594,28 +561,24 @@ public class RequestEntity<T> extends HttpEntity<T> {
private final HttpMethod method;
@Nullable
private final URI url;
@Nullable
private final String uri;
@Nullable
private Object[] uriVariables;
private final Function<UriTemplateHandler, URI> uriFunction;
private final HttpHeaders headers = new HttpHeaders();
public DefaultBodyBuilder(HttpMethod method, URI url) {
this.method = method;
this.url = url;
this.uri = null;
this.uriFunction = handler -> url;
}
public DefaultBodyBuilder(HttpMethod method, String uri) {
public DefaultBodyBuilder(HttpMethod method, String uriTemplate, Object... uriVars) {
this.method = method;
this.uri = uri;
this.url = null;
this.uriFunction = handler -> handler.expand(uriTemplate, uriVars);
}
public DefaultBodyBuilder(HttpMethod method, String uriTemplate, Map<String, ?> uriVars) {
this.method = method;
this.uriFunction = handler -> handler.expand(uriTemplate, uriVars);
}
@Override
@@ -688,29 +651,19 @@ public class RequestEntity<T> extends HttpEntity<T> {
return this;
}
@Override
public BodyBuilder uriVariables(Object... uriVariables) {
this.uriVariables = uriVariables;
return this;
}
@Override
public RequestEntity<Void> build() {
if (this.url != null){
new RequestEntity<>(this.headers, this.method, this.url);
}
return new RequestEntity<>(this.headers, this.method, this.url, uri, uriVariables);
return new RequestEntity<>(null, this.headers, this.method, this.uriFunction, null);
}
@Override
public <T> RequestEntity<T> body(T body) {
return new RequestEntity<>(body, this.headers, this.method, this.url);
return new RequestEntity<>(body, this.headers, this.method, this.uriFunction, null);
}
@Override
public <T> RequestEntity<T> body(T body, Type type) {
return new RequestEntity<>(body, this.headers, this.method, this.url, type);
return new RequestEntity<>(body, this.headers, this.method, this.uriFunction, type);
}
}
}

6
spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
View File

@@ -638,7 +638,8 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType);
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
return nonNull(doExecute(requestEntity.getUrl(this.uriTemplateHandler), requestEntity.getMethod(), requestCallback, responseExtractor));
URI url = requestEntity.getUrl(this.uriTemplateHandler);
return nonNull(doExecute(url, requestEntity.getMethod(), requestCallback, responseExtractor));
}
@Override
@@ -648,7 +649,8 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
Type type = responseType.getType();
RequestCallback requestCallback = httpEntityCallback(requestEntity, type);
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(type);
return nonNull(doExecute(requestEntity.getUrl(this.uriTemplateHandler), requestEntity.getMethod(), requestCallback, responseExtractor));
URI url = requestEntity.getUrl(this.uriTemplateHandler);
return nonNull(doExecute(url, requestEntity.getMethod(), requestCallback, responseExtractor));
}

28
spring-web/src/test/java/org/springframework/http/RequestEntityTests.java
View File

@@ -29,8 +29,6 @@ import org.junit.jupiter.api.Test;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.web.util.DefaultUriBuilderFactory;
import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.web.util.UriTemplate;
import org.springframework.web.util.UriTemplateHandler;
import static org.assertj.core.api.Assertions.assertThat;
@@ -85,29 +83,15 @@ public class RequestEntityTests {
@Test
public void uriExpansion() throws URISyntaxException{
String template = "/foo?bar={bar}";
String bar = "foo";
URI expected = new URI("/foo?bar=foo");
RequestEntity<Void> entity = RequestEntity.get(template).uriVariables(bar).build();
RequestEntity<Void> entity =
RequestEntity.get("https://www.{host}.com/{path}", "example", "foo/bar").build();
assertThat(entity.getUrl()).isEqualTo(expected);
DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
assertThat(entity.getUrl(factory)).isEqualTo(new URI("https://www.example.com/foo%2Fbar"));
String url = "https://www.{host}.com/{path}";
String host = "example";
String path = "foo/bar";
expected = new URI("https://www.example.com/foo/bar");
entity = RequestEntity.get(url).uriVariables(host, path).build();
DefaultUriBuilderFactory uriTemplateHandler = new DefaultUriBuilderFactory();
uriTemplateHandler.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.NONE);
assertThat(entity.getUrl(uriTemplateHandler)).isEqualTo(expected);
expected = new URI("https://www.example.com/foo%2Fbar");
uriTemplateHandler.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.TEMPLATE_AND_VALUES);
assertThat(entity.getUrl(uriTemplateHandler)).isEqualTo(expected);
factory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.NONE);
assertThat(entity.getUrl(factory)).isEqualTo(new URI("https://www.example.com/foo/bar"));
}

12
spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/AbstractRequestMappingIntegrationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2020 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.
@@ -32,10 +32,6 @@ import org.springframework.web.client.RestTemplate;
import org.springframework.web.server.adapter.WebHttpHandlerBuilder;
import org.springframework.web.testfixture.http.server.reactive.bootstrap.AbstractHttpHandlerIntegrationTests;
import static org.springframework.http.RequestEntity.get;
import static org.springframework.http.RequestEntity.options;
import static org.springframework.http.RequestEntity.post;
/**
* Base class for integration tests with {@code @RequestMapping methods}.
*
@@ -124,14 +120,14 @@ public abstract class AbstractRequestMappingIntegrationTests extends AbstractHtt
private RequestEntity<Void> prepareGet(String url, HttpHeaders headers) throws Exception {
URI uri = new URI("http://localhost:" + this.port + url);
RequestEntity.HeadersBuilder<?> builder = get(uri);
RequestEntity.HeadersBuilder<?> builder = RequestEntity.get(uri);
addHeaders(builder, headers);
return builder.build();
}
private RequestEntity<Void> prepareOptions(String url, HttpHeaders headers) throws Exception {
URI uri = new URI("http://localhost:" + this.port + url);
RequestEntity.HeadersBuilder<?> builder = options(uri);
RequestEntity.HeadersBuilder<?> builder = RequestEntity.options(uri);
addHeaders(builder, headers);
return builder.build();
}
@@ -146,7 +142,7 @@ public abstract class AbstractRequestMappingIntegrationTests extends AbstractHtt
private RequestEntity<?> preparePost(String url, HttpHeaders headers, Object body) throws Exception {
URI uri = new URI("http://localhost:" + this.port + url);
RequestEntity.BodyBuilder builder = post(uri);
RequestEntity.BodyBuilder builder = RequestEntity.post(uri);
addHeaders(builder, headers);
return builder.body(body);
}