root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #24406 from parviz/93-22083-uri-template 

Closes gh-24406
This commit is contained in:
Rossen Stoyanchev 2020-05-06 10:51:28 +01:00
parent d1708460e7 f28e08eceb
commit 04bbc2ac2b
4 changed files with 184 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

188
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,39 +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.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}. Used in {@code RestTemplate} and {@code @Controller} methods.
* 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.
*
* <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>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) {
@ -66,6 +59,7 @@ import org.springframework.util.ObjectUtils;
*
* @author Arjen Poutsma
* @author Sebastien Deleuze
* @author Parviz Rozikov
* @since 4.1
* @param <T> the body type
* @see #getMethod()
@ -73,10 +67,12 @@ import org.springframework.util.ObjectUtils;
*/
public class RequestEntity<T> extends HttpEntity<T> {
private final static UriTemplateHandler DEFAULT_TEMPLATE_HANDLER = new DefaultUriBuilderFactory();
@Nullable
private final HttpMethod method;
private final URI url;
private final Function<UriTemplateHandler, URI> uriFunction;
@Nullable
private final Type type;
@ -148,9 +144,19 @@ public class RequestEntity<T> extends HttpEntity<T> {
public RequestEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers,
@Nullable HttpMethod method, URI url, @Nullable Type type) {
this(body, headers, method, handler -> url, type);
}
/**
* Private constructor with URI function.
* @since 5.3
*/
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.uriFunction = uriFunction;
this.type = type;
}
@ -166,12 +172,27 @@ public class RequestEntity<T> extends HttpEntity<T> {
/**
* Return the URL of the request.
* <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() {
return this.url;
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 templateHandler) {
return this.uriFunction.apply(templateHandler);
}
/**
* Return the type of the request's body.
* @return the request's body type, or {@code null} if not known
@ -206,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;
}
@ -241,6 +262,30 @@ public class RequestEntity<T> extends HttpEntity<T> {
return new DefaultBodyBuilder(method, url);
}
/**
* 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
* @param uriVariables variables to expand the URI template with
* @return the created builder
* @since 5.3
*/
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);
}
/**
* Create an HTTP GET builder with the given url.
* @param url the URL
@ -250,6 +295,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.GET, url);
}
/**
* Create an HTTP GET builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.GET, uriTemplate, uriVariables);
}
/**
* Create an HTTP HEAD builder with the given url.
* @param url the URL
@ -259,6 +315,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.HEAD, url);
}
/**
* Create an HTTP HEAD builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.HEAD, uriTemplate, uriVariables);
}
/**
* Create an HTTP POST builder with the given url.
* @param url the URL
@ -268,6 +335,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.POST, url);
}
/**
* Create an HTTP POST builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.POST, uriTemplate, uriVariables);
}
/**
* Create an HTTP PUT builder with the given url.
* @param url the URL
@ -277,6 +355,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.PUT, url);
}
/**
* Create an HTTP PUT builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.PUT, uriTemplate, uriVariables);
}
/**
* Create an HTTP PATCH builder with the given url.
* @param url the URL
@ -286,6 +375,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.PATCH, url);
}
/**
* Create an HTTP PATCH builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.PATCH, uriTemplate, uriVariables);
}
/**
* Create an HTTP DELETE builder with the given url.
* @param url the URL
@ -295,6 +395,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.DELETE, url);
}
/**
* Create an HTTP DELETE builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.DELETE, uriTemplate, uriVariables);
}
/**
* Creates an HTTP OPTIONS builder with the given url.
* @param url the URL
@ -304,6 +415,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
return method(HttpMethod.OPTIONS, url);
}
/**
* Creates an HTTP OPTIONS builder with the given string base 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 uriTemplate, Object... uriVariables) {
return method(HttpMethod.OPTIONS, uriTemplate, uriVariables);
}
/**
* Defines a builder that adds headers to the request entity.
@ -439,13 +561,24 @@ public class RequestEntity<T> extends HttpEntity<T> {
private final HttpMethod method;
private final URI url;
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.uriFunction = handler -> url;
}
public DefaultBodyBuilder(HttpMethod method, String uriTemplate, Object... uriVars) {
this.method = method;
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
@ -520,18 +653,17 @@ public class RequestEntity<T> extends HttpEntity<T> {
@Override
public RequestEntity<Void> build() {
return new RequestEntity<>(this.headers, this.method, this.url);
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(), 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(), requestEntity.getMethod(), requestCallback, responseExtractor));
URI url = requestEntity.getUrl(this.uriTemplateHandler);
return nonNull(doExecute(url, requestEntity.getMethod(), requestCallback, responseExtractor));
}

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

@ -27,6 +27,7 @@ import java.util.Map;
import org.junit.jupiter.api.Test;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.web.util.DefaultUriBuilderFactory;
import org.springframework.web.util.UriComponentsBuilder;
import static org.assertj.core.api.Assertions.assertThat;
@ -35,6 +36,7 @@ import static org.assertj.core.api.Assertions.assertThat;
* Unit tests for {@link org.springframework.http.RequestEntity}.
*
* @author Arjen Poutsma
* @author Parviz Rozikov
*/
public class RequestEntityTests {
@ -79,6 +81,20 @@ public class RequestEntityTests {
assertThat(entity.getUrl()).isEqualTo(expected);
}
@Test
public void uriExpansion() throws URISyntaxException{
RequestEntity<Void> entity =
RequestEntity.get("https://www.{host}.com/{path}", "example", "foo/bar").build();
DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
assertThat(entity.getUrl(factory)).isEqualTo(new URI("https://www.example.com/foo%2Fbar"));
factory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.NONE);
assertThat(entity.getUrl(factory)).isEqualTo(new URI("https://www.example.com/foo/bar"));
}
@Test
public void get() {
RequestEntity<Void> requestEntity = RequestEntity.get(URI.create("https://example.com")).accept(

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);
}