org.springframework.web.client.reactive

Class WebClient

java.lang.Object

org.springframework.web.client.reactive.WebClient

public final class WebClient
extends Object

Reactive Web client supporting the HTTP/1.1 protocol

Here is a simple example of a GET request:

 static imports: ClientWebRequestBuilder.*, ResponseExtractors.*

 // should be shared between HTTP calls
 WebClient client = new WebClient(new ReactorClientHttpConnector());

 Mono<String> result = client
                .perform(get("http://example.org/resource").accept(MediaType.TEXT_PLAIN))
                .extract(body(String.class));
 

This Web client relies on the following:

• ClientHttpConnector implementation to drive the underlying library (e.g. Reactor-Netty)
• ClientWebRequestBuilder to create a Web request with a builder API (see ClientWebRequestBuilders)
• ResponseExtractor to extract the relevant part of the server response with the composition API of choice (see ResponseExtractors

Since:

5.0

Author:

Brian Clozel

See Also:

ClientWebRequestBuilders, ResponseExtractors

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WebClient.DefaultClientHttpRequestInterceptionChain
protected class	WebClient.DefaultRequestCallback
protected class	WebClient.DefaultWebClientConfig

Constructor Summary

Constructors

Constructor and Description
WebClient(ClientHttpConnector clientHttpConnector) Create a WebClient instance, using the ClientHttpConnector implementation given as an argument to drive the underlying implementation.

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultHttpMessageReaders(List<HttpMessageReader<?>> messageReaders) Add default HTTP message readers.
protected void	addDefaultHttpMessageWriters(List<HttpMessageWriter<?>> messageWriters) Add default HTTP message writers.
WebResponseActions	perform(ClientWebRequestBuilder builder) Perform the actual HTTP request/response exchange
void	setInterceptors(List<ClientHttpRequestInterceptor> interceptors) Set the list of ClientHttpRequestInterceptor to use for intercepting client HTTP requests
void	setMessageReaders(List<HttpMessageReader<?>> messageReaders) Set the list of HttpMessageReaders to use for decoding the HTTP response body.
void	setMessageWriters(List<HttpMessageWriter<?>> messageWrters) Set the list of HttpMessageWriters to use for encoding the HTTP request body.
void	setResponseErrorHandler(ResponseErrorHandler responseErrorHandler) Set the ResponseErrorHandler to use for handling HTTP response errors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebClient

public WebClient(ClientHttpConnector clientHttpConnector)

Create a WebClient instance, using the ClientHttpConnector implementation given as an argument to drive the underlying implementation. Register by default the following Encoders and Decoders:

• ByteBufferEncoder / ByteBufferDecoder
• CharSequenceEncoder / StringDecoder
• Jaxb2XmlEncoder / Jaxb2XmlDecoder
• Jackson2JsonEncoder / Jackson2JsonDecoder

Parameters:

clientHttpConnector - the ClientHttpRequestFactory to use

Method Detail

addDefaultHttpMessageReaders

protected final void addDefaultHttpMessageReaders(List<HttpMessageReader<?>> messageReaders)

Add default HTTP message readers.

addDefaultHttpMessageWriters

protected final void addDefaultHttpMessageWriters(List<HttpMessageWriter<?>> messageWriters)

Add default HTTP message writers.

setMessageReaders

public void setMessageReaders(List<HttpMessageReader<?>> messageReaders)

Set the list of HttpMessageReaders to use for decoding the HTTP response body.

setMessageWriters

public void setMessageWriters(List<HttpMessageWriter<?>> messageWrters)

Set the list of HttpMessageWriters to use for encoding the HTTP request body.

setResponseErrorHandler

public void setResponseErrorHandler(ResponseErrorHandler responseErrorHandler)

Set the ResponseErrorHandler to use for handling HTTP response errors

setInterceptors

public void setInterceptors(List<ClientHttpRequestInterceptor> interceptors)

Set the list of ClientHttpRequestInterceptor to use for intercepting client HTTP requests

perform

public WebResponseActions perform(ClientWebRequestBuilder builder)

Perform the actual HTTP request/response exchange

Requesting from the exposed Flux will result in:

• building the actual HTTP request using the provided ClientWebRequestBuilder
• encoding the HTTP request body with the configured HttpMessageWriters
• returning the response with a publisher of the body