In {@code RestTemplate}, this class is used as parameter in - * {@link org.springframework.web.client.RestTemplate#exchange(RequestEntity, Class) exchange()}: + *
Example use with the {@code RestTemplate}: *
* MyRequest body = ...
* RequestEntity<MyRequest> request = RequestEntity
- * .post(new URI("https://example.com/bar"))
+ * .post("https://example.com/{foo}", "bar")
* .accept(MediaType.APPLICATION_JSON)
* .body(body);
* ResponseEntity<MyResponse> response = template.exchange(request, MyResponse.class);
*
*
- * If you would like to provide a URI template with variables, consider using - * {@link org.springframework.web.util.DefaultUriBuilderFactory DefaultUriBuilderFactory}: - *
- * // Create shared factory
- * UriBuilderFactory factory = new DefaultUriBuilderFactory();
- *
- * // Use factory to create URL from template
- * URI uri = factory.uriString("https://example.com/{foo}").build("bar");
- * RequestEntity<MyRequest> request = RequestEntity.post(uri).accept(MediaType.APPLICATION_JSON).body(body);
- *
- *
- * Can also be used in Spring MVC, as a parameter in a @Controller method: + *
Example use in an {@code @Controller}: *
* @RequestMapping("/handle")
* public void handle(RequestEntity<String> request) {
@@ -66,6 +59,7 @@ import org.springframework.util.ObjectUtils;
*
* @author Arjen Poutsma
* @author Sebastien Deleuze
+ * @author Parviz Rozikov
* @since 4.1
* @param the body type
* @see #getMethod()
@@ -73,10 +67,12 @@ import org.springframework.util.ObjectUtils;
*/
public class RequestEntity extends HttpEntity {
+ private final static UriTemplateHandler DEFAULT_TEMPLATE_HANDLER = new DefaultUriBuilderFactory();
+
@Nullable
private final HttpMethod method;
- private final URI url;
+ private final Function uriFunction;
@Nullable
private final Type type;
@@ -148,9 +144,19 @@ public class RequestEntity extends HttpEntity {
public RequestEntity(@Nullable T body, @Nullable MultiValueMap 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 headers,
+ @Nullable HttpMethod method, Function 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 extends HttpEntity {
/**
* Return the URL of the request.
+ * 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.
+ *
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 extends HttpEntity {
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 extends HttpEntity {
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 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 extends HttpEntity {
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 extends HttpEntity {
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 extends HttpEntity {
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 extends HttpEntity {
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 extends HttpEntity {
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 extends HttpEntity {
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 extends HttpEntity {
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 extends HttpEntity {
private final HttpMethod method;
- private final URI url;
+ private final Function 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 uriVars) {
+ this.method = method;
+ this.uriFunction = handler -> handler.expand(uriTemplate, uriVars);
}
@Override
@@ -520,18 +653,17 @@ public class RequestEntity extends HttpEntity {
@Override
public RequestEntity build() {
- return new RequestEntity<>(this.headers, this.method, this.url);
+ return new RequestEntity<>(null, this.headers, this.method, this.uriFunction, null);
}
@Override
public RequestEntity 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 RequestEntity 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);
}
}
-
}
diff --git a/spring-web/src/main/java/org/springframework/web/client/RestTemplate.java b/spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
index d8bb4f730f0..ba3a912ce3e 100644
--- a/spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
+++ b/spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
@@ -638,7 +638,8 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType);
ResponseExtractor> 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> 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));
}
diff --git a/spring-web/src/test/java/org/springframework/http/RequestEntityTests.java b/spring-web/src/test/java/org/springframework/http/RequestEntityTests.java
index 7d7101cf758..69f1285674e 100644
--- a/spring-web/src/test/java/org/springframework/http/RequestEntityTests.java
+++ b/spring-web/src/test/java/org/springframework/http/RequestEntityTests.java
@@ -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 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 requestEntity = RequestEntity.get(URI.create("https://example.com")).accept(
diff --git a/spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/AbstractRequestMappingIntegrationTests.java b/spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/AbstractRequestMappingIntegrationTests.java
index 68040bb4ccb..c214b4bed17 100644
--- a/spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/AbstractRequestMappingIntegrationTests.java
+++ b/spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/AbstractRequestMappingIntegrationTests.java
@@ -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 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 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);
}