Skip to content

Support URI templates in RequestEntity #24406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Support URI templates in RequestEntity #24406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 183 additions & 4 deletions spring-web/src/main/java/org/springframework/http/RequestEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,18 @@
import java.util.function.Consumer;

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}. Used in {@code RestTemplate} and {@code @Controller} methods.
* {@linkplain URI uri} or String based uri template with placeholder. Uri variables can be provided
* through the builder {@link HeadersBuilder#uriVariables(Object...)}.
*
* 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()}:
Expand All @@ -54,6 +60,19 @@
* 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:
* <pre class="code">
* &#64;RequestMapping("/handle")
Expand All @@ -66,18 +85,28 @@
*
* @author Arjen Poutsma
* @author Sebastien Deleuze
* @author Parviz Rozikov
* @since 4.1
* @param <T> the body type
* @see #getMethod()
* @see #getUrl()
*/
public class RequestEntity<T> extends HttpEntity<T> {

private final static UriTemplateHandler DEFAULT_URI_BUILDER_FACTORY = new DefaultUriBuilderFactory();

@Nullable
private final HttpMethod method;

@Nullable
private final URI url;

@Nullable
private String uri;

@Nullable
private Object[] uriVariables;

@Nullable
private final Type type;

Expand Down Expand Up @@ -146,14 +175,32 @@ public RequestEntity(@Nullable T body, @Nullable MultiValueMap<String, String> h
* @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;
}

/**
* 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 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");
this.method = method;
this.url = url;
this.type = null;
this.uri = uri;
this.uriVariables = uriVariables;
}


/**
* Return the HTTP method of the request.
Expand All @@ -166,12 +213,30 @@ public HttpMethod getMethod() {

/**
* 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}
* @return the URL as a {@code URI}
*/
public URI getUrl() {
return this.url;
if (uri == null) {
return this.url;
}
return DEFAULT_URI_BUILDER_FACTORY.expand(uri, uriVariables);
}

/**
* Return the URL of the request.
* @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);
}


/**
* Return the type of the request's body.
* @return the request's body type, or {@code null} if not known
Expand Down Expand Up @@ -241,6 +306,19 @@ public static BodyBuilder method(HttpMethod method, URI url) {
return new DefaultBodyBuilder(method, url);
}

/**
* Create a builder with the given method and given string base uri template.
* @param method the HTTP method (GET, POST, etc)
* @param uri the uri
* @return the created builder
* @see RequestEntity
* @since 5.3
*/
public static BodyBuilder method(HttpMethod method, String uri) {
return new DefaultBodyBuilder(method, uri);
}


/**
* Create an HTTP GET builder with the given url.
* @param url the URL
Expand All @@ -250,6 +328,16 @@ public static HeadersBuilder<?> get(URI url) {
return method(HttpMethod.GET, url);
}

/**
* Create an HTTP GET builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> get(String uri) {
return method(HttpMethod.GET, uri);
}

/**
* Create an HTTP HEAD builder with the given url.
* @param url the URL
Expand All @@ -259,6 +347,16 @@ public static HeadersBuilder<?> head(URI url) {
return method(HttpMethod.HEAD, url);
}

/**
* Create an HTTP HEAD builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> head(String uri) {
return method(HttpMethod.HEAD, uri);
}

/**
* Create an HTTP POST builder with the given url.
* @param url the URL
Expand All @@ -268,6 +366,16 @@ public static BodyBuilder post(URI url) {
return method(HttpMethod.POST, url);
}

/**
* Create an HTTP POST builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static BodyBuilder post(String uri) {
return method(HttpMethod.POST, uri);
}

/**
* Create an HTTP PUT builder with the given url.
* @param url the URL
Expand All @@ -277,6 +385,16 @@ public static BodyBuilder put(URI url) {
return method(HttpMethod.PUT, url);
}

/**
* Create an HTTP PUT builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static BodyBuilder put(String uri) {
return method(HttpMethod.PUT, uri);
}

/**
* Create an HTTP PATCH builder with the given url.
* @param url the URL
Expand All @@ -286,6 +404,16 @@ public static BodyBuilder patch(URI url) {
return method(HttpMethod.PATCH, url);
}

/**
* Create an HTTP PATCH builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static BodyBuilder patch(String uri) {
return method(HttpMethod.PATCH, uri);
}

/**
* Create an HTTP DELETE builder with the given url.
* @param url the URL
Expand All @@ -295,6 +423,16 @@ public static HeadersBuilder<?> delete(URI url) {
return method(HttpMethod.DELETE, url);
}

/**
* Create an HTTP DELETE builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> delete(String uri) {
return method(HttpMethod.DELETE, uri);
}

/**
* Creates an HTTP OPTIONS builder with the given url.
* @param url the URL
Expand All @@ -304,6 +442,16 @@ public static HeadersBuilder<?> options(URI url) {
return method(HttpMethod.OPTIONS, url);
}

/**
* Creates an HTTP OPTIONS builder with the given string base uri template.
* @param uri the uri template
* @return the created builder
* @since 5.3
*/
public static HeadersBuilder<?> options(String uri) {
return method(HttpMethod.OPTIONS, uri);
}


/**
* Defines a builder that adds headers to the request entity.
Expand Down Expand Up @@ -383,6 +531,13 @@ public interface HeadersBuilder<B extends HeadersBuilder<B>> {
*/
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
Expand Down Expand Up @@ -439,13 +594,28 @@ private static class DefaultBodyBuilder implements BodyBuilder {

private final HttpMethod method;

@Nullable
private final URI url;

@Nullable
private final String uri;

@Nullable
private Object[] uriVariables;


private final HttpHeaders headers = new HttpHeaders();

public DefaultBodyBuilder(HttpMethod method, URI url) {
this.method = method;
this.url = url;
this.uri = null;
}

public DefaultBodyBuilder(HttpMethod method, String uri) {
this.method = method;
this.uri = uri;
this.url = null;
}

@Override
Expand Down Expand Up @@ -518,9 +688,18 @@ public BodyBuilder ifNoneMatch(String... ifNoneMatches) {
return this;
}

@Override
public BodyBuilder uriVariables(Object... uriVariables) {
this.uriVariables = uriVariables;
return this;
}

@Override
public RequestEntity<Void> build() {
return new RequestEntity<>(this.headers, this.method, this.url);
if (this.url != null){
new RequestEntity<>(this.headers, this.method, this.url);
}
return new RequestEntity<>(this.headers, this.method, this.url, uri, uriVariables);
}

@Override
Expand Down
4 changes: 2 additions & 2 deletions spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Class<T> r

RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType);
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
return nonNull(doExecute(requestEntity.getUrl(), requestEntity.getMethod(), requestCallback, responseExtractor));
return nonNull(doExecute(requestEntity.getUrl(this.uriTemplateHandler), requestEntity.getMethod(), requestCallback, responseExtractor));
}

@Override
Expand All @@ -651,7 +651,7 @@ public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Parameteri
Type type = responseType.getType();
RequestCallback requestCallback = httpEntityCallback(requestEntity, type);
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(type);
return nonNull(doExecute(requestEntity.getUrl(), requestEntity.getMethod(), requestCallback, responseExtractor));
return nonNull(doExecute(requestEntity.getUrl(this.uriTemplateHandler), requestEntity.getMethod(), requestCallback, responseExtractor));
}


Expand Down
Loading