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

Polish RestClient, etc.

Browse Source
This commit is contained in:
Sam Brannen
2023-07-05 15:18:16 +02:00
parent a6c5692586
commit 368a917466
4 changed files with 77 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
spring-web/src/main/java/org/springframework/web/client/DefaultRestClient.java
View File

@@ -149,7 +149,7 @@ final class DefaultRestClient implements RestClient {
@Override
public RequestBodyUriSpec method(HttpMethod method) {
Assert.notNull(method, "Method must not be null");
Assert.notNull(method, "HttpMethod must not be null");
return methodInternal(method);
}
@@ -450,7 +450,6 @@ final class DefaultRestClient implements RestClient {
}
@FunctionalInterface
private interface InternalBody {
@@ -487,7 +486,7 @@ final class DefaultRestClient implements RestClient {
@Override
public ResponseSpec onStatus(ResponseErrorHandler errorHandler) {
Assert.notNull(errorHandler, "ErrorHandler must not be null");
Assert.notNull(errorHandler, "ResponseErrorHandler must not be null");
return onStatusInternal(StatusHandler.fromErrorHandler(errorHandler));
}
@@ -613,6 +612,6 @@ final class DefaultRestClient implements RestClient {
}
}
}
}

33
spring-web/src/main/java/org/springframework/web/client/RestClient.java
View File

@@ -61,11 +61,12 @@ import org.springframework.web.util.UriBuilderFactory;
* <li>{@link RequestHeadersSpec#retrieve() retrieve()}
* <li>{@link RequestHeadersSpec#exchange(RequestHeadersSpec.ExchangeFunction) exchange(Function&lt;ClientHttpRequest, T&gt;)}
* </ul>
*
* <p>For examples with a request body see:
* <ul>
* <li>{@link RequestBodySpec#body(Object) body(Object)}
* <li>{@link RequestBodySpec#body(Object, ParameterizedTypeReference) body(Object, ParameterizedTypeReference)}
* <li>{@link RequestBodySpec#body(StreamingHttpOutputMessage.Body) body(Consumer&lt;OutputStream&gt;}
* <li>{@link RequestBodySpec#body(StreamingHttpOutputMessage.Body) body(Consumer&lt;OutputStream&gt;)}
* </ul>
*
* @author Arjen Poutsma
@@ -218,7 +219,8 @@ public interface RestClient {
* for a given URL is absolute in which case the base URL is ignored.
* <p><strong>Note:</strong> this method is mutually exclusive with
* {@link #uriBuilderFactory(UriBuilderFactory)}. If both are used, the
* baseUrl value provided here will be ignored.
* {@code baseUrl} value provided here will be ignored.
* @return this builder
* @see DefaultUriBuilderFactory#DefaultUriBuilderFactory(String)
* @see #uriBuilderFactory(UriBuilderFactory)
*/
@@ -236,7 +238,8 @@ public interface RestClient {
* </pre>
* <p><strong>Note:</strong> this method is mutually exclusive with
* {@link #uriBuilderFactory(UriBuilderFactory)}. If both are used, the
* defaultUriVariables value provided here will be ignored.
* {@code defaultUriVariables} value provided here will be ignored.
* @return this builder
* @see DefaultUriBuilderFactory#setDefaultUriVariables(Map)
* @see #uriBuilderFactory(UriBuilderFactory)
*/
@@ -251,6 +254,7 @@ public interface RestClient {
* <li>{@link #defaultUriVariables(Map)}.
* </ul>
* @param uriBuilderFactory the URI builder factory to use
* @return this builder
* @see #baseUrl(String)
* @see #defaultUriVariables(Map)
*/
@@ -261,19 +265,22 @@ public interface RestClient {
* if the request does not already contain such a header.
* @param header the header name
* @param values the header values
* @return this builder
*/
Builder defaultHeader(String header, String... values);
/**
* Provides access to every {@link #defaultHeader(String, String...)}
* declared so far with the possibility to add, replace, or remove.
* Provide a consumer to access to every {@linkplain #defaultHeader(String, String...)
* default header} declared so far, with the possibility to add, replace, or remove.
* @param headersConsumer the consumer
* @return this builder
*/
Builder defaultHeaders(Consumer<HttpHeaders> headersConsumer);
/**
* Provide a consumer to customize every request being built.
* @param defaultRequest the consumer to use for modifying requests
* @return this builder
*/
Builder defaultRequest(Consumer<RequestHeadersSpec<?>> defaultRequest);
@@ -306,6 +313,7 @@ public interface RestClient {
/**
* Add the given request interceptor to the end of the interceptor chain.
* @param interceptor the interceptor to be added to the chain
* @return this builder
*/
Builder requestInterceptor(ClientHttpRequestInterceptor interceptor);
@@ -321,6 +329,7 @@ public interface RestClient {
/**
* Add the given request initializer to the end of the initializer chain.
* @param initializer the initializer to be added to the chain
* @return this builder
*/
Builder requestInitializer(ClientHttpRequestInitializer initializer);
@@ -338,12 +347,14 @@ public interface RestClient {
* for plugging in and/or customizing options of the underlying HTTP
* client library (e.g. SSL).
* @param requestFactory the request factory to use
* @return this builder
*/
Builder requestFactory(ClientHttpRequestFactory requestFactory);
/**
* Configure the message converters for the {@code RestClient} to use.
* @param configurer the configurer to apply
* @return this builder
*/
Builder messageConverters(Consumer<List<HttpMessageConverter<?>>> configurer);
@@ -351,6 +362,7 @@ public interface RestClient {
* Apply the given {@code Consumer} to this builder instance.
* <p>This can be useful for applying pre-packaged customizations.
* @param builderConsumer the consumer to apply
* @return this builder
*/
Builder apply(Consumer<Builder> builderConsumer);
@@ -379,14 +391,14 @@ public interface RestClient {
/**
* Specify the URI for the request using a URI template and URI variables.
* If a {@link UriBuilderFactory} was configured for the client (e.g.
* <p>If a {@link UriBuilderFactory} was configured for the client (e.g.
* with a base URI) it will be used to expand the URI template.
*/
S uri(String uri, Object... uriVariables);
/**
* Specify the URI for the request using a URI template and URI variables.
* If a {@link UriBuilderFactory} was configured for the client (e.g.
* <p>If a {@link UriBuilderFactory} was configured for the client (e.g.
* with a base URI) it will be used to expand the URI template.
*/
S uri(String uri, Map<String, ?> uriVariables);
@@ -478,11 +490,11 @@ public interface RestClient {
/**
* Callback for access to the {@link ClientHttpRequest} that in turn
* provides access to the native request of the underlying HTTP library.
* This could be useful for setting advanced, per-request options that
* exposed by the underlying library.
* <p>This could be useful for setting advanced, per-request options that
* are exposed by the underlying library.
* @param requestConsumer a consumer to access the
* {@code ClientHttpRequest} with
* @return {@code ResponseSpec} to specify how to decode the body
* @return this builder
*/
S httpRequest(Consumer<ClientHttpRequest> requestConsumer);
@@ -508,6 +520,7 @@ public interface RestClient {
* {@link HttpClientErrorException} and 5xx response codes in a
* {@link HttpServerErrorException}. To customize error handling, use
* {@link ResponseSpec#onStatus(Predicate, ResponseSpec.ErrorHandler) onStatus} handlers.
* @return {@code ResponseSpec} to specify how to decode the body
*/
ResponseSpec retrieve();

46
spring-web/src/main/java/org/springframework/web/client/StatusHandler.java
View File

@@ -65,7 +65,7 @@ final class StatusHandler {
}
public static StatusHandler fromErrorHandler(ResponseErrorHandler errorHandler) {
Assert.notNull(errorHandler, "ErrorHandler must not be null");
Assert.notNull(errorHandler, "ResponseErrorHandler must not be null");
return new StatusHandler(errorHandler::hasError, (request, response) ->
errorHandler.handleError(request.getURI(), request.getMethod(), response));
@@ -73,29 +73,29 @@ final class StatusHandler {
public static StatusHandler defaultHandler(List<HttpMessageConverter<?>> messageConverters) {
return new StatusHandler(response -> response.getStatusCode().isError(),
(request, response) -> {
HttpStatusCode statusCode = response.getStatusCode();
String statusText = response.getStatusText();
HttpHeaders headers = response.getHeaders();
byte[] body = RestClientUtils.getBody(response);
Charset charset = RestClientUtils.getCharset(response);
String message = getErrorMessage(statusCode.value(), statusText, body, charset);
RestClientResponseException ex;
(request, response) -> {
HttpStatusCode statusCode = response.getStatusCode();
String statusText = response.getStatusText();
HttpHeaders headers = response.getHeaders();
byte[] body = RestClientUtils.getBody(response);
Charset charset = RestClientUtils.getCharset(response);
String message = getErrorMessage(statusCode.value(), statusText, body, charset);
RestClientResponseException ex;
if (statusCode.is4xxClientError()) {
ex = HttpClientErrorException.create(message, statusCode, statusText, headers, body, charset);
}
else if (statusCode.is5xxServerError()) {
ex = HttpServerErrorException.create(message, statusCode, statusText, headers, body, charset);
}
else {
ex = new UnknownHttpStatusCodeException(message, statusCode.value(), statusText, headers, body, charset);
}
if (!CollectionUtils.isEmpty(messageConverters)) {
ex.setBodyConvertFunction(initBodyConvertFunction(response, body, messageConverters));
}
throw ex;
});
if (statusCode.is4xxClientError()) {
ex = HttpClientErrorException.create(message, statusCode, statusText, headers, body, charset);
}
else if (statusCode.is5xxServerError()) {
ex = HttpServerErrorException.create(message, statusCode, statusText, headers, body, charset);
}
else {
ex = new UnknownHttpStatusCodeException(message, statusCode.value(), statusText, headers, body, charset);
}
if (!CollectionUtils.isEmpty(messageConverters)) {
ex.setBodyConvertFunction(initBodyConvertFunction(response, body, messageConverters));
}
throw ex;
});
}
private static Function<ResolvableType, ?> initBodyConvertFunction(ClientHttpResponse response, byte[] body, List<HttpMessageConverter<?>> messageConverters) {